ec2_lc – Create or delete AWS Autoscaling Launch Configurations

From Get docs
Ansible/docs/2.7/modules/ec2 lc module


ec2_lc – Create or delete AWS Autoscaling Launch Configurations

New in version 1.6.


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

-

added in 1.8

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.

aws_access_key

-

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.


aliases: ec2_access_key, access_key

aws_secret_key

-

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.


aliases: ec2_secret_key, secret_key

classic_link_vpc_id

-

added in 2.0

Id of ClassicLink enabled VPC

classic_link_vpc_security_groups

-

added in 2.0

A list of security group IDs with which to associate the ClassicLink VPC instances.

ebs_optimized

-

added in 1.8

Default:

"no"

Specifies whether the instance is optimized for EBS I/O (true) or not (false).

ec2_url

-

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.

image_id

-

The AMI unique identifier to be used for the group

instance_id

-

added in 2.4

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

  • no

  • yes

Specifies whether instances are launched with detailed monitoring.

instance_profile_name

-

added in 1.8

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instances.

instance_type

- / required

Instance type to use for the instance

kernel_id

-

Kernel id for the EC2 instance

key_name

-

The SSH key name to be used for access to managed instances

name

- / required

Unique name for configuration

placement_tenancy

-

added in 2.4

Default:

"default"

Determines whether the instance runs on single-tenant harware or not.

profile

-

added in 1.6

Uses a boto profile. Only works with boto >= 2.24.0.

ramdisk_id

-

added in 1.8

A RAM disk id for the instances.

region

-

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

-

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

-

added in 1.6

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.


aliases: access_token

spot_price

-

The spot price you are bidding. Only applies for an autoscaling group with spot instances.

state

-

  • present

  • absent

Register or deregister the instance

user_data

-

Opaque blob of data which is made available to the ec2 instance. Mutually exclusive with user_data_path.

user_data_path

-

added in 2.3

Path to the file that contains userdata for the ec2 instances. Mutually exclusive with user_data.

validate_certs

boolean

added in 1.5

  • no
  • yes

When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

volumes

-

A list of volume dicts, each containing device name and optionally ephemeral id or snapshot id. Size and type (and number of iops for io device type) must be specified for a new volume or a root volume, and may be passed for a snapshot volume. For any volume, a volume size less than 1 will be interpreted as a request not to create the volume.

vpc_id

-

added in 2.4

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_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
  • 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
  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

# create a launch configuration using a running instance id as a basis

- 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

# create a launch configuration to omit the /dev/sdf EBS device that is included in the AMI image

- 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

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

NoneType

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

NoneType

when state=present

The ID of the snapshot.


volume_size

string

when state=present

The volume size, in GiB.


Sample:

100

virtual_name

NoneType

when state=present

The name of the virtual device (for example, ephemeral0).


classic_link_vpc_id

NoneType

when state=present

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.


classic_link_vpc_security_groups

list

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

NoneType

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

when state=present

The security groups to associate with the instances.


Sample:

['sg-5e27db2f']

spot_price

NoneType

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

NoneType

when state=present

The volume type (one of standard, io1, gp2).


security_groups

list

when state=present

The security groups to associate with the instances.


Sample:

['sg-5e27db2f']




Status

  • This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
  • This module is maintained by an Ansible Partner. [certified]

Authors

  • Gareth Rushgrove (@garethr)
  • Willem van Ketwich (@wilvk)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ec2_lc_module.html