From 91f2bc4ad851465b297bb390ffeabb3d0b576d6b Mon Sep 17 00:00:00 2001 From: Jill R <4121322+jillr@users.noreply.github.com> Date: Wed, 17 Jun 2020 09:31:32 -0700 Subject: [PATCH] Update docs (#99) * Update docs Remove .git from repo url so links in readme will generate correctly Add required ansible version Run latest version of add_docs.py Add version_added string to modules * galaxy.yml was missing authors This commit was initially merged in https://github.com/ansible-collections/community.aws See: https://github.com/ansible-collections/community.aws/commit/96ee268e5267f5b12c3d59892bc1279f75aa3135 --- plugins/modules/ec2_vpc_egress_igw.py | 1 + plugins/modules/ec2_vpc_endpoint.py | 1 + plugins/modules/ec2_vpc_endpoint_info.py | 1 + plugins/modules/ec2_vpc_igw.py | 1 + plugins/modules/ec2_vpc_igw_info.py | 1 + plugins/modules/ec2_vpc_nacl.py | 1 + plugins/modules/ec2_vpc_nacl_info.py | 1 + plugins/modules/ec2_vpc_nat_gateway.py | 1 + plugins/modules/ec2_vpc_nat_gateway_info.py | 1 + plugins/modules/ec2_vpc_peer.py | 1 + plugins/modules/ec2_vpc_peering_info.py | 1 + plugins/modules/ec2_vpc_route_table.py | 1 + plugins/modules/ec2_vpc_route_table_info.py | 1 + plugins/modules/ec2_vpc_vgw.py | 1 + plugins/modules/ec2_vpc_vgw_info.py | 1 + plugins/modules/ec2_vpc_vpn.py | 1 + plugins/modules/ec2_vpc_vpn_info.py | 1 + 17 files changed, 17 insertions(+) diff --git a/plugins/modules/ec2_vpc_egress_igw.py b/plugins/modules/ec2_vpc_egress_igw.py index 2981d194ef9..b2f481b86dd 100644 --- a/plugins/modules/ec2_vpc_egress_igw.py +++ b/plugins/modules/ec2_vpc_egress_igw.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_egress_igw +version_added: 1.0.0 short_description: Manage an AWS VPC Egress Only Internet gateway description: - Manage an AWS VPC Egress Only Internet gateway diff --git a/plugins/modules/ec2_vpc_endpoint.py b/plugins/modules/ec2_vpc_endpoint.py index 7978c48dfde..920cf45ca6e 100644 --- a/plugins/modules/ec2_vpc_endpoint.py +++ b/plugins/modules/ec2_vpc_endpoint.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' module: ec2_vpc_endpoint short_description: Create and delete AWS VPC Endpoints. +version_added: 1.0.0 description: - Creates AWS VPC endpoints. - Deletes AWS VPC endpoints. diff --git a/plugins/modules/ec2_vpc_endpoint_info.py b/plugins/modules/ec2_vpc_endpoint_info.py index 0f23ca53217..a1f3ff0a901 100644 --- a/plugins/modules/ec2_vpc_endpoint_info.py +++ b/plugins/modules/ec2_vpc_endpoint_info.py @@ -8,6 +8,7 @@ DOCUMENTATION = ''' module: ec2_vpc_endpoint_info short_description: Retrieves AWS VPC endpoints details using AWS methods. +version_added: 1.0.0 description: - Gets various details related to AWS VPC Endpoints. - This module was called C(ec2_vpc_endpoint_facts) before Ansible 2.9. The usage did not change. diff --git a/plugins/modules/ec2_vpc_igw.py b/plugins/modules/ec2_vpc_igw.py index c1960c14bbb..b920682b76c 100644 --- a/plugins/modules/ec2_vpc_igw.py +++ b/plugins/modules/ec2_vpc_igw.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_igw +version_added: 1.0.0 short_description: Manage an AWS VPC Internet gateway description: - Manage an AWS VPC Internet gateway diff --git a/plugins/modules/ec2_vpc_igw_info.py b/plugins/modules/ec2_vpc_igw_info.py index dcc07a4349b..f33020e0c24 100644 --- a/plugins/modules/ec2_vpc_igw_info.py +++ b/plugins/modules/ec2_vpc_igw_info.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_igw_info +version_added: 1.0.0 short_description: Gather information about internet gateways in AWS description: - Gather information about internet gateways in AWS. diff --git a/plugins/modules/ec2_vpc_nacl.py b/plugins/modules/ec2_vpc_nacl.py index 14853edf767..f2ca5cda6f6 100644 --- a/plugins/modules/ec2_vpc_nacl.py +++ b/plugins/modules/ec2_vpc_nacl.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' module: ec2_vpc_nacl short_description: create and delete Network ACLs. +version_added: 1.0.0 description: - Read the AWS documentation for Network ACLS U(https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html) diff --git a/plugins/modules/ec2_vpc_nacl_info.py b/plugins/modules/ec2_vpc_nacl_info.py index 2cc4f012d58..337a91d1c93 100644 --- a/plugins/modules/ec2_vpc_nacl_info.py +++ b/plugins/modules/ec2_vpc_nacl_info.py @@ -8,6 +8,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_nacl_info +version_added: 1.0.0 short_description: Gather information about Network ACLs in an AWS VPC description: - Gather information about Network ACLs in an AWS VPC diff --git a/plugins/modules/ec2_vpc_nat_gateway.py b/plugins/modules/ec2_vpc_nat_gateway.py index 306c8ac49c4..4272dc648c4 100644 --- a/plugins/modules/ec2_vpc_nat_gateway.py +++ b/plugins/modules/ec2_vpc_nat_gateway.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_nat_gateway +version_added: 1.0.0 short_description: Manage AWS VPC NAT Gateways. description: - Ensure the state of AWS VPC NAT Gateways based on their id, allocation and subnet ids. diff --git a/plugins/modules/ec2_vpc_nat_gateway_info.py b/plugins/modules/ec2_vpc_nat_gateway_info.py index 83fb9b0f182..b734721b5ea 100644 --- a/plugins/modules/ec2_vpc_nat_gateway_info.py +++ b/plugins/modules/ec2_vpc_nat_gateway_info.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' module: ec2_vpc_nat_gateway_info short_description: Retrieves AWS VPC Managed Nat Gateway details using AWS methods. +version_added: 1.0.0 description: - Gets various details related to AWS VPC Managed Nat Gateways - This module was called C(ec2_vpc_nat_gateway_facts) before Ansible 2.9. The usage did not change. diff --git a/plugins/modules/ec2_vpc_peer.py b/plugins/modules/ec2_vpc_peer.py index 5c94d4e399b..2a08618a73f 100644 --- a/plugins/modules/ec2_vpc_peer.py +++ b/plugins/modules/ec2_vpc_peer.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' module: ec2_vpc_peer short_description: create, delete, accept, and reject VPC peering connections between two VPCs. +version_added: 1.0.0 description: - Read the AWS documentation for VPC Peering Connections U(https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-peering.html). diff --git a/plugins/modules/ec2_vpc_peering_info.py b/plugins/modules/ec2_vpc_peering_info.py index 8472fc4f58c..f552358e362 100644 --- a/plugins/modules/ec2_vpc_peering_info.py +++ b/plugins/modules/ec2_vpc_peering_info.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' module: ec2_vpc_peering_info short_description: Retrieves AWS VPC Peering details using AWS methods. +version_added: 1.0.0 description: - Gets various details related to AWS VPC Peers - This module was called C(ec2_vpc_peering_facts) before Ansible 2.9. The usage did not change. diff --git a/plugins/modules/ec2_vpc_route_table.py b/plugins/modules/ec2_vpc_route_table.py index fbbae5c5a00..39f0ffc42bf 100644 --- a/plugins/modules/ec2_vpc_route_table.py +++ b/plugins/modules/ec2_vpc_route_table.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_route_table +version_added: 1.0.0 short_description: Manage route tables for AWS virtual private clouds description: - Manage route tables for AWS virtual private clouds diff --git a/plugins/modules/ec2_vpc_route_table_info.py b/plugins/modules/ec2_vpc_route_table_info.py index 4823f2db49e..8af3935bd36 100644 --- a/plugins/modules/ec2_vpc_route_table_info.py +++ b/plugins/modules/ec2_vpc_route_table_info.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_route_table_info +version_added: 1.0.0 short_description: Gather information about ec2 VPC route tables in AWS description: - Gather information about ec2 VPC route tables in AWS diff --git a/plugins/modules/ec2_vpc_vgw.py b/plugins/modules/ec2_vpc_vgw.py index 511616a0838..1ce3df5672e 100644 --- a/plugins/modules/ec2_vpc_vgw.py +++ b/plugins/modules/ec2_vpc_vgw.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' module: ec2_vpc_vgw short_description: Create and delete AWS VPN Virtual Gateways. +version_added: 1.0.0 description: - Creates AWS VPN Virtual Gateways - Deletes AWS VPN Virtual Gateways diff --git a/plugins/modules/ec2_vpc_vgw_info.py b/plugins/modules/ec2_vpc_vgw_info.py index d526b54a372..5c7b866c7d6 100644 --- a/plugins/modules/ec2_vpc_vgw_info.py +++ b/plugins/modules/ec2_vpc_vgw_info.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_vgw_info +version_added: 1.0.0 short_description: Gather information about virtual gateways in AWS description: - Gather information about virtual gateways in AWS. diff --git a/plugins/modules/ec2_vpc_vpn.py b/plugins/modules/ec2_vpc_vpn.py index 72a3b9a3eb1..1ac818485bb 100644 --- a/plugins/modules/ec2_vpc_vpn.py +++ b/plugins/modules/ec2_vpc_vpn.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_vpn +version_added: 1.0.0 short_description: Create, modify, and delete EC2 VPN connections. description: - This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters diff --git a/plugins/modules/ec2_vpc_vpn_info.py b/plugins/modules/ec2_vpc_vpn_info.py index b9830d7d31e..1ba8210a722 100644 --- a/plugins/modules/ec2_vpc_vpn_info.py +++ b/plugins/modules/ec2_vpc_vpn_info.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' --- module: ec2_vpc_vpn_info +version_added: 1.0.0 short_description: Gather information about VPN Connections in AWS. description: - Gather information about VPN Connections in AWS.