Docs4dev
Docs
ansible / 2.4 / ec2_ami_search_module.html

ec2_ami_search - Retrieve AWS AMI information for a given operating system.

New in version 1.6.

DEPRECATED

Use ec2_ami_find instead.

Synopsis

  • Look up the most recent AMI on AWS for a given operating system.
  • Returns ami, aki, ari, serial, tag
  • If there is no AKI or ARI associated with an image, these will be null.
  • Only supports images from cloud-images.ubuntu.com
  • Example output: {"ami": "ami-69f5a900", "changed": false, "aki": "aki-88aa75e1", "tag": "release", "ari": null, "serial": "20131024"}

Options

parameter required default choices comments
arch
 no amd64
  • i386
  • amd64
CPU architecture
distro
 yes
  • ubuntu
Linux distribution (e.g., ubuntu)
region
 no us-east-1
  • ap-northeast-1
  • ap-southeast-1
  • ap-northeast-2
  • ap-southeast-2
  • ca-central-1
  • eu-central-1
  • eu-west-1
  • eu-west-2
  • sa-east-1
  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • us-gov-west-1
EC2 region
release
 yes
short name of the release (e.g., precise)
store
 no ebs
  • ebs
  • ebs-io1
  • ebs-ssd
  • instance-store
Back-end store for instance
stream
 no server
  • server
  • desktop
Type of release.
virt
 no paravirtual
  • paravirtual
  • hvm
virutalization type

Examples

- name: Launch an Ubuntu 12.04 (Precise Pangolin) EC2 instance
  hosts: 127.0.0.1
  connection: local
  tasks:
  - name: Get the Ubuntu precise AMI
    ec2_ami_search:
      distro: ubuntu
      release: precise
      region: us-west-1
      store: instance-store
    register: ubuntu_image

  - name: Start the EC2 instance
    ec2:
      image: "{{ ubuntu_image.ami }}"
      instance_type: m1.small
      key_name: mykey

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

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