Documentation

ec2_ami - create or destroy an image in ec2

New in version 1.3.

Synopsis

Creates or deletes ec2 images.

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
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
      delete_snapshot
      no
        Whether or not to delete an AMI while deregistering it.
        description
        no
          An optional human-readable string describing the contents and purpose of the AMI.
          device_mapping
          (added in 2.0)
          no
            An optional list of device hashes/dictionaries with custom configurations (same block-device-mapping parameters)
            Valid properties include: device_name, volume_type, size (in GB), delete_on_termination (boolean), no_device (boolean), snapshot_id, iops (for io1 volume_type)
            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
                Image ID to be deregistered.
                instance_id
                no
                  instance id of the image to create
                  launch_permissions
                  (added in 2.0)
                  no
                    Users and groups that should be able to launch the ami. Expects dictionary with a key of user_ids and/or group_names. user_ids should be a list of account ids. group_name should be a list of groups, "all" is the only acceptable value currently.
                    name
                    no
                      The name of the new image to create
                      no_reboot
                      no
                      • yes
                      • no
                      An optional flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the responsibility of maintaining file system integrity is left to the owner of the instance. The default choice is "no".
                      profile
                      (added in 1.6)
                      no
                        uses a boto profile. Only works with boto >= 2.24.0
                        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_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
                            state
                            no present
                              create or deregister/delete image
                              tags
                              (added in 2.0)
                              no
                                a hash/dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'
                                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.
                                wait
                                no no
                                • yes
                                • no
                                wait for the AMI to be in state 'available' before returning.
                                wait_timeout
                                no 300
                                  how long before wait gives up, in seconds

                                  Examples

                                  # Basic AMI Creation
                                  - ec2_ami:
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      instance_id: i-xxxxxx
                                      wait: yes
                                      name: newtest
                                      tags:
                                        Name: newtest
                                        Service: TestService
                                    register: instance
                                  
                                  # Basic AMI Creation, without waiting
                                  - ec2_ami:
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      region: xxxxxx
                                      instance_id: i-xxxxxx
                                      wait: no
                                      name: newtest
                                    register: instance
                                  
                                  # AMI Creation, with a custom root-device size and another EBS attached
                                  - ec2_ami
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      instance_id: i-xxxxxx
                                      name: newtest
                                      device_mapping:
                                          - device_name: /dev/sda1
                                            size: XXX
                                            delete_on_termination: true
                                            volume_type: gp2
                                          - device_name: /dev/sdb
                                            size: YYY
                                            delete_on_termination: false
                                            volume_type: gp2
                                    register: instance
                                  
                                  # AMI Creation, excluding a volume attached at /dev/sdb
                                  - ec2_ami
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      instance_id: i-xxxxxx
                                      name: newtest
                                      device_mapping:
                                          - device_name: /dev/sda1
                                            size: XXX
                                            delete_on_termination: true
                                            volume_type: gp2
                                          - device_name: /dev/sdb
                                            no_device: yes
                                    register: instance
                                  
                                  # Deregister/Delete AMI
                                  - ec2_ami:
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      region: xxxxxx
                                      image_id: "{{ instance.image_id }}"
                                      delete_snapshot: True
                                      state: absent
                                  
                                  # Deregister AMI
                                  - ec2_ami:
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      region: xxxxxx
                                      image_id: "{{ instance.image_id }}"
                                      delete_snapshot: False
                                      state: absent
                                  
                                  # Update AMI Launch Permissions, making it public
                                  - ec2_ami:
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      region: xxxxxx
                                      image_id: "{{ instance.image_id }}"
                                      state: present
                                      launch_permissions:
                                        group_names: ['all']
                                  
                                  # Allow AMI to be launched by another account
                                  - ec2_ami:
                                      aws_access_key: xxxxxxxxxxxxxxxxxxxxxxx
                                      aws_secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                      region: xxxxxx
                                      image_id: "{{ instance.image_id }}"
                                      state: present
                                      launch_permissions:
                                        user_ids: ['123456789012']
                                  

                                  Notes

                                  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.