ansible / ansible.builtin / v2.9.0 / module / ec2_tag create and remove tags on ec2 resources. | "added in version" 1.3 of ansible.builtin" Authors: Lester Wade (@lwade), Paul Arthur (@flowerysong) stableinterface | supported by communityansible.builtin.ec2_tag (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Creates, removes and lists tags for 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.
- 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 all volumes are tagged ec2_tag: region: eu-west-1 resource: '{{ item.id }}' state: present tags: Name: dbserver Env: production loop: '{{ ec2_vol.volumes }}'
- name: Retrieve all tags on an instance ec2_tag: region: eu-west-1 resource: i-xxxxxxxxxxxxxxxxx state: list register: ec2_tags
- name: Remove the Env tag ec2_tag: region: eu-west-1 resource: i-xxxxxxxxxxxxxxxxx tags: Env: state: absent
- name: Remove the Env tag if it's currently 'development' ec2_tag: region: eu-west-1 resource: i-xxxxxxxxxxxxxxxxx tags: Env: development state: absent
- name: Remove all tags except for Name from an instance ec2_tag: region: eu-west-1 resource: i-xxxxxxxxxxxxxxxxx tags: Name: '' state: absent purge_tags: true
tags: description: - A dictionary of tags to add or remove from the resource. - If the value provided for a tag is null and C(state) is I(absent), the tag will be removed regardless of its current value. required: true state: 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. 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 ec2_url: aliases: - aws_endpoint_url - endpoint_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 profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str resource: 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). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict purge_tags: default: false description: - Whether unspecified tags should be removed from the resource. - 'Note that when combined with C(state: absent), specified tags with non-matching values are not purged.' type: bool version_added: '2.7' version_added_collection: ansible.builtin aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - '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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 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. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. 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. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. - 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
added_tags: description: A dict of tags that were added to the resource returned: If tags were added type: dict removed_tags: description: A dict of tags that were removed from the resource returned: If tags were removed type: dict tags: description: A dict containing the tags on the resource returned: always type: dict