community.aws.autoscaling_launch_config module – Create or delete AWS Autoscaling Launch Configurations
Note
This module is part of the community.aws collection (version 5.5.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.
New in community.aws 1.0.0
Synopsis
Can create or delete AWS Autoscaling Configurations.
Works with the community.aws.autoscaling_group module to manage Autoscaling Groups.
Prior to release 5.0.0 this module was called
community.aws.ec2_lc. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.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 |
|
Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud. Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. Choices:
|
|
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. |
|
Id of ClassicLink enabled VPC |
|
A list of security group IDs with which to associate the ClassicLink VPC instances. |
|
Use a The Choices:
|
|
Specifies whether the instance is optimized for EBS I/O (true) or not (false). 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 |
|
The AMI unique identifier to be used for the group. |
|
The Id of a running instance to use as a basis for a launch configuration. Can be used in place of image_id and instance_type. |
|
Specifies whether instances are launched with detailed monitoring. Choices:
|
|
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instances. |
|
Instance type to use for the instance. Required when creating a new Launch Configuration. |
|
Kernel id for the EC2 instance. |
|
The SSH key name to be used for access to managed instances. |
|
Unique name for configuration. |
|
Determines whether the instance runs on single-tenant hardware or not. When not set AWS will default to Choices:
|
|
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. |
|
A RAM disk id for the instances. |
|
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 |
|
A list of security groups to apply to the instances. You can specify either security group names or IDs or a mix. Default: |
|
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 |
|
The spot price you are bidding. Only applies for an autoscaling group with spot instances. |
|
Register or deregister the instance. Choices:
|
|
Opaque blob of data which is made available to the ec2 instance. Mutually exclusive with user_data_path. |
|
Path to the file that contains userdata for the ec2 instances. Mutually exclusive with user_data. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
A list dictionaries defining the volumes to create. For any volume, a volume size less than |
|
Whether the volume should be automatically deleted when the instance is terminated. Choices:
|
|
The name for the volume (For example |
|
Whether the volume should be encrypted using the ‘aws/ebs’ KMS CMK. Choices:
|
|
Whether the volume should be ephemeral. Data on ephemeral volumes is lost when the instance is stopped. Mutually exclusive with the snapshot parameter. |
|
The number of IOPS per second to provision for the volume. Required when volume_type=io1. |
|
When no_device=true the device will not be created. Choices:
|
|
The ID of an EBS snapshot to copy when creating the volume. Mutually exclusive with the ephemeral parameter. |
|
The throughput to provision for a gp3 volume. Valid Range is a minimum value of 125 and a maximum value of 1000. |
|
The size of the volume (in GiB). Required unless one of ephemeral, snapshot or no_device is set. |
|
The type of volume to create. See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html for more information on the available volume types. |
|
VPC ID, used when resolving security group names to IDs. |
Notes
Note
Amazon ASG Autoscaling Launch Configurations are immutable once created, so modifying the configuration after it is changed will not modify the launch configuration on AWS. You must create a new config and assign it to the ASG instead.
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
- name: create a launch configuration with an encrypted volume
community.aws.autoscaling_launch_config:
name: special
image_id: ami-XXX
key_name: default
security_groups: ['group', 'group2' ]
instance_type: t1.micro
volumes:
- device_name: /dev/sda1
volume_size: 100
volume_type: io1
iops: 3000
delete_on_termination: true
encrypted: true
- device_name: /dev/sdb
ephemeral: ephemeral0
- name: create a launch configuration using a running instance id as a basis
community.aws.autoscaling_launch_config:
name: special
instance_id: i-00a48b207ec59e948
key_name: default
security_groups: ['launch-wizard-2' ]
volumes:
- device_name: /dev/sda1
volume_size: 120
volume_type: io1
iops: 3000
delete_on_termination: true
- name: create a launch configuration to omit the /dev/sdf EBS device that is included in the AMI image
community.aws.autoscaling_launch_config:
name: special
image_id: ami-XXX
key_name: default
security_groups: ['group', 'group2' ]
instance_type: t1.micro
volumes:
- device_name: /dev/sdf
no_device: true
- name: Use EBS snapshot ID for volume
block:
- name: Set Volume Facts
ansible.builtin.set_fact:
volumes:
- device_name: /dev/sda1
volume_size: 20
ebs:
snapshot: snap-XXXX
volume_type: gp2
delete_on_termination: true
encrypted: false
- name: Create launch configuration
community.aws.autoscaling_launch_config:
name: lc1
image_id: ami-xxxx
assign_public_ip: true
instance_type: t2.medium
key_name: my-key
security_groups: "['sg-xxxx']"
volumes: "{{ volumes }}"
register: lc_info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The Amazon Resource Name of the launch configuration. Returned: when state=present Sample: |
|
Whether the state of the launch configuration has changed. Returned: always Sample: |
|
The creation date and time for the launch configuration. Returned: when state=present Sample: |
|
The ID of the Amazon Machine Image used by the launch configuration. Returned: when state=present Sample: |
|
The instance type for the instances. Returned: when state=present Sample: |
|
The name of the launch configuration. Returned: when state=present Sample: |
|
The specification details for the launch configuration. Returned: when state=present |
|
(EC2-VPC) Indicates whether to assign a public IP address to each instance. Returned: when state=present Sample: |
|
A block device mapping, which specifies the block devices. Returned: when state=present |
|
The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). Returned: when state=present Sample: |
|
The information about the Amazon EBS volume. Returned: when state=present |
|
The ID of the snapshot. Returned: when state=present |
|
The volume size, in GiB. Returned: when state=present Sample: |
|
The name of the virtual device (for example, ephemeral0). Returned: when state=present Sample: |
|
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. Returned: when state=present |
|
The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. Returned: when state=present Sample: |
|
The creation date and time for the launch configuration. Returned: when state=present Sample: |
|
Indicates whether the volume is deleted on instance termination. Returned: when state=present Sample: |
|
Indicates whether the instance is optimized for EBS I/O Returned: when state=present Sample: |
|
The ID of the Amazon Machine Image used by the launch configuration. Returned: when state=present Sample: |
|
Indicates whether instances in this group are launched with detailed Returned: when state=present Sample: |
|
The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. Returned: when state=present |
|
The instance type for the instances. Returned: when state=present Sample: |
|
The number of I/O operations per second (IOPS) to provision for the volume. Returned: when state=present |
|
The ID of the kernel associated with the AMI. Returned: when state=present Sample: |
|
The name of the key pair. Returned: when state=present Sample: |
|
The Amazon Resource Name (ARN) of the launch configuration. Returned: when state=present Sample: |
|
Returned: when state=present Sample: |
|
The name of the launch configuration. Returned: when state=present Sample: |
|
The tenancy of the instances, either default or dedicated. Returned: when state=present Sample: |
|
The ID of the RAM disk associated with the AMI. Returned: when state=present Sample: |
|
The security groups to associate with the instances. Returned: when state=present Sample: |
|
The price to bid when launching Spot Instances. Returned: when state=present |
|
Indicates whether to suppress a device mapping. Returned: when state=present Sample: |
|
The user data available to the instances. Returned: when state=present Sample: |
|
The volume type (one of standard, io1, gp2). Returned: when state=present Sample: |
|
The security groups to associate with the instances. Returned: when state=present Sample: |