Skip to content

Commit

Permalink
Tagging fragment - Move simplest cases over to the docs fragment. (an…
Browse files Browse the repository at this point in the history
…sible-collections#1182)

Tagging fragment - Move simplest cases over to the docs fragment.

Depends-On: ansible-collections/amazon.aws#844
SUMMARY
Migrate simplest cases over to the new docs fragment and add resource_tags as an alias to tags.
ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
changelogs/fragments/1182-tagging.yml
plugins/modules/aws_glue_job.py
plugins/modules/aws_msk_cluster.py
plugins/modules/aws_secret.py
plugins/modules/aws_step_functions_state_machine.py
plugins/modules/dynamodb_table.py
plugins/modules/ec2_eip.py
plugins/modules/ec2_transit_gateway_vpc_attachment.py
plugins/modules/ec2_vpc_peer.py
plugins/modules/elb_application_lb.py
plugins/modules/elb_network_lb.py
plugins/modules/iam_role.py
plugins/modules/iam_user.py
plugins/modules/networkfirewall.py
plugins/modules/networkfirewall_policy.py
plugins/modules/networkfirewall_rule_group.py
plugins/modules/rds_cluster.py
plugins/modules/rds_instance.py
plugins/modules/rds_instance_snapshot.py
plugins/modules/rds_option_group.py
plugins/modules/rds_subnet_group.py
plugins/modules/redshift.py
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@b11ffae
  • Loading branch information
tremble authored and goneri committed Sep 21, 2022
1 parent ddf6313 commit 85ea736
Showing 1 changed file with 16 additions and 23 deletions.
39 changes: 16 additions & 23 deletions plugins/modules/ec2_eip.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
version_added: 1.0.0
short_description: manages EC2 elastic IP (EIP) addresses.
description:
- This module can allocate or release an EIP.
- This module can associate/disassociate an EIP with instances or network interfaces.
- This module can allocate or release an EIP.
- This module can associate/disassociate an EIP with instances or network interfaces.
options:
device_id:
description:
Expand Down Expand Up @@ -64,16 +64,6 @@
network interface or instance to be re-associated with the specified instance or interface.
default: false
type: bool
tags:
description: A dictionary of tags to apply to the EIP.
type: dict
version_added: 2.1.0
purge_tags:
description: Whether the I(tags) argument should cause tags not in the
dictionary to be removed.
default: True
type: bool
version_added: 2.1.0
tag_name:
description:
- When I(reuse_existing_ip_allowed=true), supplement with this option to only reuse
Expand All @@ -89,18 +79,21 @@
only applies to newly allocated Elastic IPs, isn't validated when I(reuse_existing_ip_allowed=true).
type: str
extends_documentation_fragment:
- amazon.aws.aws
- amazon.aws.ec2
- amazon.aws.aws
- amazon.aws.ec2
- amazon.aws.tags
author: "Rick Mendes (@rickmendes) <[email protected]>"
author:
- "Rick Mendes (@rickmendes) <[email protected]>"
notes:
- There may be a delay between the time the EIP is assigned and when
the cloud instance is reachable via the new address. Use wait_for and
pause to delay further playbook execution until the instance is reachable,
if necessary.
- This module returns multiple changed statuses on disassociation or release.
It returns an overall status based on any changes occurring. It also returns
individual changed statuses for disassociation and release.
- There may be a delay between the time the EIP is assigned and when
the cloud instance is reachable via the new address. Use wait_for and
pause to delay further playbook execution until the instance is reachable,
if necessary.
- This module returns multiple changed statuses on disassociation or release.
It returns an overall status based on any changes occurring. It also returns
individual changed statuses for disassociation and release.
- Support for I(tags) and I(purge_tags) was added in release 2.1.0.
'''

EXAMPLES = '''
Expand Down Expand Up @@ -543,7 +536,7 @@ def main():
release_on_disassociation=dict(required=False, type='bool', default=False),
allow_reassociation=dict(type='bool', default=False),
private_ip_address=dict(),
tags=dict(required=False, type='dict'),
tags=dict(required=False, type='dict', aliases=['resource_tags']),
purge_tags=dict(required=False, type='bool', default=True),
tag_name=dict(),
tag_value=dict(),
Expand Down

0 comments on commit 85ea736

Please sign in to comment.