ec2_ami – create or destroy an image in ec2

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


ec2_ami – create or destroy an image in ec2

New in version 1.3.


Synopsis

  • Registers or deregisters ec2 images.

Requirements

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

  • python >= 2.6
  • boto

Parameters

Parameter Choices/Defaults Comments

architecture

-

added in 2.3

The target architecture of the image to register

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

billing_products

-

added in 2.5

A list of valid billing codes. To be used with valid accounts by aws marketplace vendors.

delete_snapshot

boolean

  • no

  • yes

Delete snapshots when deregistering the AMI.

description

-

Human-readable string describing the contents and purpose of the AMI.

device_mapping

-

added in 2.0

List of device hashes/dictionaries with custom configurations (same block-device-mapping parameters).

Valid properties include: device_name, volume_type, size/volume_size (in GB), delete_on_termination (boolean), no_device (boolean), snapshot_id, iops (for io1 volume_type), encrypted

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.

enhanced_networking

-

added in 2.5

A boolean representing whether enhanced networking with ENA is enabled or not.

image_id

-

Image ID to be deregistered.

image_location

-

added in 2.5

The s3 location of an image to use for the AMI.

instance_id

-

Instance ID to create the AMI from.

kernel_id

-

added in 2.3

The target kernel id of the image to register.

launch_permissions

-

added in 2.0

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.

You must pass all desired launch permissions if you wish to modify existing launch permissions (passing just groups will remove all users)

name

-

The name of the new AMI.

no_reboot

boolean

  • no

  • yes

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.

profile

-

added in 1.6

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

purge_tags

-

added in 2.5

Default:

"no"

Whether to remove existing tags that aren't passed in the tags parameter

ramdisk_id

-

added in 2.5

The ID of the RAM disk.

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

root_device_name

-

added in 2.3

The root device name of the image to register.

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

sriov_net_support

-

added in 2.5

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

state

-

  • absent
  • present

Register or deregister an AMI.

tags

-

added in 2.0

A dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'

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.

virtualization_type

-

added in 2.3

The virtualization type of the image to register.

wait

boolean

  • no

  • yes

Wait for the AMI to be in state 'available' before returning.

wait_timeout

-

Default:

900

How long before wait gives up, in seconds.



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

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Basic AMI Creation
- ec2_ami:
    instance_id: i-xxxxxx
    wait: yes
    name: newtest
    tags:
      Name: newtest
      Service: TestService

# Basic AMI Creation, without waiting
- ec2_ami:
    instance_id: i-xxxxxx
    wait: no
    name: newtest

# AMI Registration from EBS Snapshot
- ec2_ami:
    name: newtest
    state: present
    architecture: x86_64
    virtualization_type: hvm
    root_device_name: /dev/xvda
    device_mapping:
      - device_name: /dev/xvda
        volume_size: 8
        snapshot_id: snap-xxxxxxxx
        delete_on_termination: true
        volume_type: gp2

# AMI Creation, with a custom root-device size and another EBS attached
- ec2_ami:
    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

# AMI Creation, excluding a volume attached at /dev/sdb
- ec2_ami:
    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

# Deregister/Delete AMI (keep associated snapshots)
- ec2_ami:
    image_id: "{{ instance.image_id }}"
    delete_snapshot: False
    state: absent

# Deregister AMI (delete associated snapshots too)
- ec2_ami:
    image_id: "{{ instance.image_id }}"
    delete_snapshot: True
    state: absent

# Update AMI Launch Permissions, making it public
- ec2_ami:
    image_id: "{{ instance.image_id }}"
    state: present
    launch_permissions:
      group_names: ['all']

# Allow AMI to be launched by another account
- ec2_ami:
    image_id: "{{ instance.image_id }}"
    state: present
    launch_permissions:
      user_ids: ['123456789012']

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

architecture

string

when AMI is created or already exists

architecture of image


Sample:

x86_64

block_device_mapping

dictionary

when AMI is created or already exists

block device mapping associated with image


Sample:

{'/dev/sda1': {'delete_on_termination': True, 'encrypted': False, 'size': 10, 'snapshot_id': 'snap-1a03b80e7', 'volume_type': 'standard'}}

creationDate

string

when AMI is created or already exists

creation date of image


Sample:

2015-10-15T22:43:44.000Z

description

string

when AMI is created or already exists

description of image


Sample:

nat-server

hypervisor

string

when AMI is created or already exists

type of hypervisor


Sample:

xen

image_id

string

when AMI is created or already exists

id of the image


Sample:

ami-1234abcd

is_public

boolean

when AMI is created or already exists

whether image is public


launch_permission

list

when AMI is created or already exists

permissions allowing other accounts to access the AMI


Sample:

[{'group': 'all'}]

location

string

when AMI is created or already exists

location of image


Sample:

315210894379/nat-server

name

string

when AMI is created or already exists

ami name of image


Sample:

nat-server

ownerId

string

when AMI is created or already exists

owner of image


Sample:

435210894375

platform

string

when AMI is created or already exists

platform of image


root_device_name

string

when AMI is created or already exists

root device name of image


Sample:

/dev/sda1

root_device_type

string

when AMI is created or already exists

root device type of image


Sample:

ebs

snapshots_deleted

list

after AMI is deregistered, if 'delete_snapshot' is set to 'yes'

a list of snapshot ids deleted after deregistering image


Sample:

['snap-fbcccb8f', 'snap-cfe7cdb4']

state

string

when AMI is created or already exists

state of image


Sample:

available

tags

dictionary

when AMI is created or already exists

a dictionary of tags assigned to image


Sample:

{'Env': 'devel', 'Name': 'nat-server'}

virtualization_type

string

when AMI is created or already exists

image virtualization type


Sample:

hvm




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

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_ami_module.html