ansible / ansible.builtin / v2.4.3.0-1 / module / ec2_tag create and remove tag(s) to ec2 resources. | "added in version" 1.3 of ansible.builtin" Authors: Lester Wade (@lwade) stableinterface | supported by certifiedansible.builtin.ec2_tag (v2.4.3.0-1) — module
pip
Install with pip install ansible==2.4.3.0.post1
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.
- name: Ensure tags are present on a resource ec2_tag: region: eu-west-1 resource: vol-XXXXXX state: present tags: Name: ubervol env: prod
- name: Ensure one dbserver is running ec2: count_tag: 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: Retrieve all volumes for a queried instance ec2_vol: instance: '{{ item.id }}' region: eu-west-1 state: list with_items: '{{ ec2.tagged_instances }}' register: ec2_vol
- name: Ensure all volumes are tagged ec2_tag: region: eu-west-1 resource: '{{ item.id }}' state: present tags: Name: dbserver Env: production with_items: - ec2_vol.volumes
- name: Get EC2 facts action: ec2_facts
- name: Retrieve all 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 and env debug: msg: '{{ ec2_tags.tags.Name }} {{ ec2_tags.tags.env }}'
tags: aliases: [] default: null description: - a hash/dictionary of tags to add to the resource; '{"key":"value"}' and '{"key":"value","key":"value"}' required: true state: aliases: [] choices: - present - absent - list default: present description: - Whether the tags should be present or absent on the resource. Use list to interrogate the tags of an instance. required: false region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str profile: aliases: - aws_profile description: - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str resource: aliases: [] default: null description: - The EC2 resource id. required: true aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - The I(aws_access_key) and I(profile) options are mutually exclusive. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - The I(aws_secret_key) and I(profile) options are mutually exclusive. type: str security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool