community.aws.autoscaling_launch_config_info (5.1.0) — module

Gather information about AWS Autoscaling Launch Configurations

| "added in version" 1.0.0 of community.aws"

Authors: Loïc Latreille (@psykotox)

Install collection

Install with ansible-galaxy collection install community.aws:==5.1.0


Add to requirements.yml

  collections:
    - name: community.aws
      version: 5.1.0

Description

Gather information about AWS Autoscaling Launch Configurations.

Prior to release 5.0.0 this module was called C(community.aws.ec2_lc_info). The usage did not change.


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.

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

Inputs

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

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.
    type: str

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - The AWS region to use.
    - For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
    - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
    - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
    - The C(ec2_region) alias has been deprecated and will be removed in a release after
      2024-12-01
    - Support for the C(EC2_REGION) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - A named AWS profile to use for authentication.
    - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
    - The C(AWS_PROFILE) environment variable may also be used.
    - 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.
    type: int

access_key:
    aliases:
    - aws_access_key_id
    - aws_access_key
    - ec2_access_key
    description:
    - AWS access key ID.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
      may also be used in decreasing order of preference.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
      AWS botocore SDK.
    - The I(ec2_access_key) alias has been deprecated and will be removed in a release
      after 2024-12-01.
    - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
    type: dict

secret_key:
    aliases:
    - aws_secret_access_key
    - aws_secret_key
    - ec2_secret_key
    description:
    - AWS secret access key.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
      variables may also be used in decreasing order of preference.
    - The I(secret_key) and I(profile) options are mutually exclusive.
    - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
      the AWS botocore SDK.
    - The I(ec2_secret_key) alias has been deprecated and will be removed in a release
      after 2024-12-01.
    - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
      be removed in a release after 2024-12-01.
    type: str

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

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

endpoint_url:
    aliases:
    - ec2_url
    - aws_endpoint_url
    - s3_url
    description:
    - 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  C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
      order of preference.
    - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
      a release after 2024-12-01.
    - Support for the C(EC2_URL) environment variable has been deprecated and will be
      removed in a release after 2024-12-01.
    type: str

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - The C(AWS_CA_BUNDLE) environment variable may also be used.
    type: path

session_token:
    aliases:
    - aws_session_token
    - security_token
    - aws_security_token
    - access_token
    description:
    - AWS STS session token for use with temporary credentials.
    - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
    - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
      variables may also be used in decreasing order of preference.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
      the parameter being renamed from I(security_token) to I(session_token) in release
      6.0.0.
    - The I(security_token), I(aws_security_token), and I(access_token) aliases have been
      deprecated and will be removed in a release after 2024-12-01.
    - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
      has been deprecated and will be removed in a release after 2024-12-01.
    type: str

validate_certs:
    default: true
    description:
    - When set to C(false), SSL certificates will not be validated for communication with
      the AWS APIs.
    - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
      setting I(aws_ca_bundle) instead.
    type: bool

debug_botocore_endpoint_logs:
    default: false
    description:
    - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
      API calls made during a task, outputing the set to the resource_actions key in the
      task results. Use the C(aws_resource_action) callback to output to total list made
      during a playbook.
    - The C(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: str
created_time:
  description: The creation date and time for the launch configuration.
  returned: always
  sample: '2016-05-27T13:47:44.216000+00:00'
  type: str
ebs_optimized:
  description: EBS I/O optimized C(true) or not C(false).
  returned: always
  sample: true,
  type: bool
image_id:
  description: ID of the Amazon Machine Image (AMI).
  returned: always
  sample: ami-12345678
  type: str
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: str
kernel_id:
  description: ID of the kernel associated with the AMI.
  returned: always
  sample: null
  type: str
key_name:
  description: Name of the key pair.
  returned: always
  sample: user_app
  type: str
launch_configuration_arn:
  description: Amazon Resource Name (ARN) of the launch configuration.
  returned: always
  sample: arn:aws:autoscaling:us-east-1:123456798012:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app
  type: str
launch_configuration_name:
  description: Name of the launch configuration.
  returned: always
  sample: lc-app
  type: str
ramdisk_id:
  description: ID of the RAM disk associated with the AMI.
  returned: always
  sample: null
  type: str
security_groups:
  description: Security groups to associated.
  returned: always
  sample: '[ ''web'' ]'
  type: list
user_data:
  description: User data available.
  returned: always
  type: str