community / community.aws / 4.3.0 / module / efs_tag create and remove tags on Amazon EFS resources | "added in version" 2.0.0 of community.aws" Authors: Milan Zink (@zeten30)community.aws.efs_tag (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
Creates and removes tags for Amazon EFS resources.
Resources are referenced by their ID (filesystem or filesystem access point).
- name: Ensure tags are present on a resource community.aws.efs_tag: resource: fs-123456ab state: present tags: Name: MyEFS Env: Production
- name: Remove the Env tag if it's currently 'development' community.aws.efs_tag: resource: fsap-78945ff state: absent tags: Env: development
- name: Remove all tags except for Name community.aws.efs_tag: resource: fsap-78945ff state: absent tags: Name: foo purge_tags: true
- name: Remove all tags community.aws.efs_tag: resource: fsap-78945ff state: absent tags: {} purge_tags: true
tags: aliases: - resource_tags description: - A dictionary of tags to add or remove from the resource. - If the value provided for a tag is null and I(state=absent), the tag will be removed regardless of its current value. required: true type: dict state: choices: - present - absent default: present description: - Whether the tags should be present or absent on the resource. type: str 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: - Uses a boto profile. Only works with boto >= 2.24.0. - 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: - EFS Filesystem ID or EFS Filesystem Access Point ID. required: true type: str 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 I(state=absent), specified tags with non-matching values are not purged. type: bool aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Only used for boto3 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: - 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. - 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: - 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. - 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_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. 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