community.aws.ec2_lc – Create or delete AWS Autoscaling Launch Configurations

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.ec2_lc.

New in version 1.0.0: of community.aws

Synopsis

  • Can create or delete AWS Autoscaling Configurations.

  • Works with the ec2_asg module to manage Autoscaling Groups.

Requirements

The below requirements are needed on the host that executes this module.

  • boto

  • boto3 >= 1.4.4

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
assign_public_ip
boolean
    Choices:
  • no
  • yes
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.
associate_public_ip_address
boolean
    Choices:
  • no
  • yes
The associate_public_ip_address option does nothing and will be removed after 2022-06-01
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
classic_link_vpc_id
string
Id of ClassicLink enabled VPC
classic_link_vpc_security_groups
list / elements=string
A list of security group IDs with which to associate the ClassicLink VPC instances.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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.
ebs_optimized
boolean
    Choices:
  • no ←
  • yes
Specifies whether the instance is optimized for EBS I/O (true) or not (false).
ec2_url
string
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.

aliases: aws_endpoint_url, endpoint_url
image_id
string
The AMI unique identifier to be used for the group.
instance_id
string
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.
instance_monitoring
boolean
    Choices:
  • no ←
  • yes
Specifies whether instances are launched with detailed monitoring.
instance_profile_name
string
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instances.
instance_type
string
Instance type to use for the instance.
Required when creating a new Launch Configuration.
kernel_id
string
Kernel id for the EC2 instance.
key_name
string
The SSH key name to be used for access to managed instances.
name
string / required
Unique name for configuration.
placement_tenancy
string
    Choices:
  • default
  • dedicated
Determines whether the instance runs on single-tenant hardware or not.
When not set AWS will default to default.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
ramdisk_id
string
A RAM disk id for the instances.
region
string
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_groups
list / elements=string
A list of security groups to apply to the instances. Since version 2.4 you can specify either security group names or IDs or a mix. Previous to 2.4, for VPC instances, specify security group IDs and for EC2-Classic, specify either security group names or IDs.
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
spot_price
float
The spot price you are bidding. Only applies for an autoscaling group with spot instances.
state
string
    Choices:
  • present ←
  • absent
Register or deregister the instance.
user_data
string
Opaque blob of data which is made available to the ec2 instance. Mutually exclusive with user_data_path.
user_data_path
path
Path to the file that contains userdata for the ec2 instances. Mutually exclusive with user_data.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
volumes
list / elements=dictionary
A list dictionaries defining the volumes to create.
For any volume, a volume size less than 1 will be interpreted as a request not to create the volume.
delete_on_termination
boolean
    Choices:
  • no ←
  • yes
Whether the volume should be automatically deleted when the instance is terminated.
device_name
string / required
The name for the volume (For example /dev/sda).
encrypted
boolean
    Choices:
  • no ←
  • yes
Whether the volume should be encrypted using the 'aws/ebs' KMS CMK.
ephemeral
string
Whether the volume should be ephemeral.
Data on ephemeral volumes is lost when the instance is stopped.
Mutually exclusive with the snapshot parameter.
iops
integer
The number of IOPS per second to provision for the volume.
Required when volume_type=io1.
no_device
boolean
    Choices:
  • no
  • yes
When no_device=true the device will not be created.
snapshot
string
The ID of an EBS snapshot to copy when creating the volume.
Mutually exclusive with the ephemeral parameter.
volume_size
integer
The size of the volume (in GiB).
Required unless one of ephemeral, snapshot or no_device is set.
volume_type
string
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
string
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.

  • encrypted volumes are supported on versions >= 2.4

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# create a launch configuration using an AMI image and instance type as a basis

- name: note that encrypted volumes are only supported in >= Ansible 2.4
  community.aws.ec2_lc:
    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.ec2_lc:
    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.ec2_lc:
    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: no

  - name: Create launch configuration
    community.aws.ec2_lc:
      name: lc1
      image_id: ami-xxxx
      assign_public_ip: yes
      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 Returned Description
arn
string
when state=present
The Amazon Resource Name of the launch configuration.

Sample:
arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name
changed
boolean
always
Whether the state of the launch configuration has changed.

created_time
string
when state=present
The creation date and time for the launch configuration.

Sample:
2017-11-03 23:46:44.841000
image_id
string
when state=present
The ID of the Amazon Machine Image used by the launch configuration.

Sample:
ami-9be6f38c
instance_type
string
when state=present
The instance type for the instances.

Sample:
t1.micro
name
string
when state=present
The name of the launch configuration.

Sample:
launch_config_name
result
complex
when state=present
The specification details for the launch configuration.

 
associate_public_ip_address
boolean
when state=present
(EC2-VPC) Indicates whether to assign a public IP address to each instance.

 
block_device_mappings
complex
when state=present
A block device mapping, which specifies the block devices.

   
device_name
string
when state=present
The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

Sample:
/dev/sda1
   
ebs
complex
when state=present
The information about the Amazon EBS volume.

     
snapshot_id
string
when state=present
The ID of the snapshot.

     
volume_size
string
when state=present
The volume size, in GiB.

Sample:
100
   
virtual_name
string
when state=present
The name of the virtual device (for example, ephemeral0).

Sample:
ephemeral0
  classic_link_vpc_id
string
when state=present
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

  classic_link_vpc_security_groups
list / elements=string
when state=present
The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.

 
created_time
string
when state=present
The creation date and time for the launch configuration.

Sample:
2017-11-03 23:46:44.841000
 
delete_on_termination
boolean
when state=present
Indicates whether the volume is deleted on instance termination.

Sample:
True
 
ebs_optimized
boolean
when state=present
Indicates whether the instance is optimized for EBS I/O (true) or not (false).

 
image_id
string
when state=present
The ID of the Amazon Machine Image used by the launch configuration.

Sample:
ami-9be6f38c
 
instance_monitoring
boolean
when state=present
Indicates whether instances in this group are launched with detailed (true) or basic (false) monitoring.

Sample:
True
 
instance_profile_name
string
when state=present
The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

 
instance_type
string
when state=present
The instance type for the instances.

Sample:
t1.micro
 
iops
integer
when state=present
The number of I/O operations per second (IOPS) to provision for the volume.

 
kernel_id
string
when state=present
The ID of the kernel associated with the AMI.

 
key_name
string
when state=present
The name of the key pair.

Sample:
testkey
 
launch_configuration_arn
string
when state=present
The Amazon Resource Name (ARN) of the launch configuration.

Sample:
arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name
 
member
string
when state=present

Sample:
 
name
string
when state=present
The name of the launch configuration.

Sample:
launch_config_name
 
PlacementTenancy
string
when state=present
The tenancy of the instances, either default or dedicated.

Sample:
default
 
ramdisk_id
string
when state=present
The ID of the RAM disk associated with the AMI.

 
security_groups
list / elements=string
when state=present
The security groups to associate with the instances.

Sample:
['sg-5e27db2f']
 
spot_price
float
when state=present
The price to bid when launching Spot Instances.

 
use_block_device_types
boolean
when state=present
Indicates whether to suppress a device mapping.

 
user_data
string
when state=present
The user data available to the instances.

 
volume_type
string
when state=present
The volume type (one of standard, io1, gp2).

Sample:
io1
security_groups
list / elements=string
when state=present
The security groups to associate with the instances.

Sample:
['sg-5e27db2f']


Authors

  • Gareth Rushgrove (@garethr)

  • Willem van Ketwich (@wilvk)