ec2_tag - create and remove tag(s) to ec2 resources.

• Synopsis
• Requirements (on host that executes module)
• Options
• Examples
• Notes
• This is a Core Module

Synopsis

Creates, removes and lists tags from any EC2 resource. The resource is referenced by its resource id (e.g. an instance being i-XXXXXXX). It is designed to be used with complex args (tags), see the examples. This module has a dependency on python-boto.

Requirements (on host that executes module)

• python >= 2.6
• boto

Options

Examples

# Basic example of adding tag(s)
tasks:
- name: tag a resource
  ec2_tag:
    region: eu-west-1
    resource: vol-XXXXXX
    state: present
    tags:
      Name: ubervol
      env: prod

# Playbook example of adding tags to volumes on an instance
tasks:
- name: launch an instance
  ec2:
    count_tags:
      Name: dbserver
      Env: production
    exact_count: 1
    group: "{{ security_group }}"
    keypair: "{{ keypair }}"
    image: "{{ image_id }}"
    instance_tags:
      Name: dbserver
      Env: production
    instance_type: "{{ instance_type }}"
    region: eu-west-1
    volumes:
      - device_name: /dev/xvdb
        device_type: standard
        volume_size: 10
        delete_on_termination: true
    wait: true
  register: ec2

- name: list the volumes for the instance
  ec2_vol:
    instance: "{{ item.id }}"
    region: eu-west-1
    state: list
  with_items: ec2.tagged_instances
  register: ec2_vol

- name: tag the volumes
  ec2_tag:
    region:  eu-west-1
    resource: "{{ item.id }}"
    state: present
    tags:
      Name: dbserver
      Env: production
  with_subelements:
    - ec2_vol.results
    - volumes

# Playbook example of listing tags on an instance
tasks:
- name: get ec2 facts
  action: ec2_facts

- name: list tags on an instance
  ec2_tag:
    region: "{{ ansible_ec2_placement_region }}"
    resource: "{{ ansible_ec2_instance_id }}"
    state: list
  register: ec2_tags

- name: list tags, such as Name, env if exist
  shell: echo {{ ec2_tags.tags.Name }} {{ ec2_tags.tags.env }}

Notes

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, developing_test_pr and Developing Modules.