amazon.aws.ec2_ami – Create or destroy an image (AMI) in ec2

Note

This plugin is part of the amazon.aws collection.

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

To use it in a playbook, specify: amazon.aws.ec2_ami.

New in version 1.0.0: of amazon.aws

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
string
Default:
"x86_64"
The target architecture of the image to register
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
billing_products
list / elements=string
A list of valid billing codes. To be used with valid accounts by aws marketplace vendors.
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.
delete_snapshot
boolean
    Choices:
  • no ←
  • yes
Delete snapshots when deregistering the AMI.
description
string
Human-readable string describing the contents and purpose of the AMI.
device_mapping
list / elements=dictionary
List of device hashes/dictionaries with custom configurations (same block-device-mapping parameters).
delete_on_termination
boolean
    Choices:
  • no
  • yes
Whether the device should be automatically deleted when the Instance is terminated.
device_name
string
The device name. For example /dev/sda.
encrypted
boolean
    Choices:
  • no
  • yes
Whether the volume should be encrypted.
iops
integer
When using an io1 volume_type this sets the number of IOPS provisioned for the volume
no_device
boolean
    Choices:
  • no
  • yes
Suppresses the specified device included in the block device mapping of the AMI.
Alias NoDevice has been deprecated and will be removed after 2022-06-01.

aliases: NoDevice
snapshot_id
string
The ID of the Snapshot.
virtual_name
string
The virtual name for the device.
Alias VirtualName has been deprecated and will be removed after 2022-06-01.

aliases: VirtualName
volume_size
integer
The size of the volume (in GiB)

aliases: size
volume_type
string
The volume type. Defaults to gp2 when not set.
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
enhanced_networking
boolean
    Choices:
  • no
  • yes
A boolean representing whether enhanced networking with ENA is enabled or not.
image_id
string
Image ID to be deregistered.
image_location
string
The s3 location of an image to use for the AMI.
instance_id
string
Instance ID to create the AMI from.
kernel_id
string
The target kernel id of the image to register.
launch_permissions
dictionary
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
string
The name of the new AMI.
no_reboot
boolean
    Choices:
  • 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
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
purge_tags
boolean
    Choices:
  • no ←
  • yes
Whether to remove existing tags that aren't passed in the tags parameter
ramdisk_id
string
The ID of the RAM disk.
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
root_device_name
string
The root device name of the image to register.
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
sriov_net_support
string
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
string
    Choices:
  • absent
  • present ←
Register or deregister an AMI.
tags
dictionary
A dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
virtualization_type
string
Default:
"hvm"
The virtualization type of the image to register.
wait
boolean
    Choices:
  • no ←
  • yes
Wait for the AMI to be in state 'available' before returning.
wait_timeout
integer
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_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

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

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

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

- name: AMI Registration from EBS Snapshot
  amazon.aws.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

- name: AMI Creation, with a custom root-device size and another EBS attached
  amazon.aws.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

- name: AMI Creation, excluding a volume attached at /dev/sdb
  amazon.aws.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

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

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

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

- name: Allow AMI to be launched by another account
  amazon.aws.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 / elements=string
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 / elements=string
after AMI is deregistered, if delete_snapshot=true
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


Authors