Documentation

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 (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
assign_public_ip
(added in 1.8)
no
    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
    no
      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
      no
        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)
        no
          Id of ClassicLink enabled VPC
          classic_link_vpc_security_groups
          (added in 2.0)
          no
            A list of security group id's with which to associate the ClassicLink VPC instances.
            ebs_optimized
            (added in 1.8)
            no
              Specifies whether the instance is optimized for EBS I/O (true) or not (false).
              ec2_url
              no
                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
                no
                  The AMI unique identifier to be used for the group
                  instance_monitoring
                  no
                    whether instances in group are launched with detailed monitoring.
                    instance_profile_name
                    (added in 1.8)
                    no
                      The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instances.
                      instance_type
                      yes
                        instance type to use for the instance
                        kernel_id
                        no
                          Kernel id for the EC2 instance
                          key_name
                          no
                            The SSH key name to be used for access to managed instances
                            name
                            yes
                              Unique name for configuration
                              profile
                              (added in 1.6)
                              no
                                uses a boto profile. Only works with boto >= 2.24.0
                                ramdisk_id
                                (added in 1.8)
                                no
                                  A RAM disk id for the instances.
                                  region
                                  no
                                    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
                                    no
                                      A list of security groups into which instances should be found
                                      security_token
                                      (added in 1.6)
                                      no
                                        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
                                        no
                                          The spot price you are bidding. Only applies for an autoscaling group with spot instances.
                                          state
                                          yes
                                          • present
                                          • absent
                                          register or deregister the instance
                                          user_data
                                          no
                                            opaque blob of data which is made available to the ec2 instance
                                            validate_certs
                                            (added in 1.5)
                                            no yes
                                            • yes
                                            • no
                                            When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
                                            volumes
                                            no
                                              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.

                                              Examples

                                              - 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
                                                    device_type: io1
                                                    iops: 3000
                                                    delete_on_termination: true
                                              

                                              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.

                                              Note

                                              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

                                              Note

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

                                              Note

                                              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

                                              This is a Core Module

                                              For more information on what this means please read Core Modules

                                              For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.