Documentation

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

New in version 1.3.

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

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
      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.
        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
            resource
            yes
              The EC2 resource id.
              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
                • present
                • absent
                • list
                Whether the tags should be present or absent on the resource. Use list to interrogate the tags of an instance.
                tags
                yes
                  a hash/dictionary of tags to add to the resource; '{"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.

                  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
                  

                  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.