From a072765498db68ca12db53de58896df2af63d212 Mon Sep 17 00:00:00 2001 From: Alina Buzachis Date: Thu, 23 May 2024 15:34:15 +0200 Subject: [PATCH] [Part #3] Ensures the modules documentation follows the correct formats (#2082) [Part #3] Ensures the modules documentation follows the correct formats SUMMARY ISSUE TYPE Bugfix Pull Request Docs Pull Request Feature Pull Request New Module Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Mark Chappell (cherry picked from commit b47d1cffde53d3576d40d705d003214c6deeb06b) --- .../fragments/documentation_update_3.yml | 2 + plugins/modules/ec2_vol.py | 28 +++++------ plugins/modules/ec2_vpc_dhcp_option.py | 4 +- plugins/modules/ec2_vpc_endpoint.py | 24 ++++----- plugins/modules/ec2_vpc_endpoint_info.py | 4 +- plugins/modules/ec2_vpc_igw.py | 26 +++++----- plugins/modules/ec2_vpc_igw_info.py | 6 +-- plugins/modules/ec2_vpc_nat_gateway.py | 30 +++++------ plugins/modules/ec2_vpc_nat_gateway_info.py | 2 +- plugins/modules/ec2_vpc_net.py | 50 +++++++++---------- plugins/modules/ec2_vpc_net_info.py | 4 +- plugins/modules/ec2_vpc_route_table.py | 28 +++++------ plugins/modules/ec2_vpc_route_table_info.py | 4 +- plugins/modules/ec2_vpc_subnet.py | 40 +++++++-------- plugins/modules/ec2_vpc_subnet_info.py | 4 +- 15 files changed, 129 insertions(+), 127 deletions(-) create mode 100644 changelogs/fragments/documentation_update_3.yml diff --git a/changelogs/fragments/documentation_update_3.yml b/changelogs/fragments/documentation_update_3.yml new file mode 100644 index 00000000000..67e6daac534 --- /dev/null +++ b/changelogs/fragments/documentation_update_3.yml @@ -0,0 +1,2 @@ +trivial: + - "Part #3 - Ensures the modules documentation follows the correct formats (see also https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#semantic-markup-within-module-documentation)." diff --git a/plugins/modules/ec2_vol.py b/plugins/modules/ec2_vol.py index d1000e0c436..e68c978c41c 100644 --- a/plugins/modules/ec2_vol.py +++ b/plugins/modules/ec2_vol.py @@ -11,12 +11,12 @@ short_description: Create and attach a volume, return volume ID and device map description: - Creates an EBS volume and optionally attaches it to an instance. - - If both I(instance) and I(name) are given and the instance has a device at the device name, then no volume is created and no attachment is made. + - If both O(instance) and O(name) are given and the instance has a device at the device name, then no volume is created and no attachment is made. options: instance: description: - Instance ID if you wish to attach the volume. - - Set to C(None) to detach the volume. + - Set to V(None) to detach the volume. type: str name: description: @@ -32,9 +32,9 @@ type: int volume_type: description: - - Type of EBS volume; C(standard) (magnetic), C(gp2) (SSD), C(gp3) (SSD), C(io1) (Provisioned IOPS), C(io2) (Provisioned IOPS), - C(st1) (Throughput Optimized HDD), C(sc1) (Cold HDD). - - C(standard) is the old EBS default and continues to remain the Ansible default for backwards compatibility. + - Type of EBS volume; V(standard) (magnetic), V(gp2) (SSD), V(gp3) (SSD), V(io1) (Provisioned IOPS), V(io2) (Provisioned IOPS), + V(st1) (Throughput Optimized HDD), V(sc1) (Cold HDD). + - V(standard) is the old EBS default and continues to remain the Ansible default for backwards compatibility. default: standard choices: ['standard', 'gp2', 'io1', 'st1', 'sc1', 'gp3', 'io2'] type: str @@ -72,15 +72,15 @@ state: description: - Whether to ensure the volume is present or absent. - - I(state=list) was deprecated in release 1.1.0 and is no longer available + - O(state=list) was deprecated in release 1.1.0 and is no longer available with release 4.0.0. - - The C(list) functionality has been moved to a dedicated module M(amazon.aws.ec2_vol_info). + - The V(list) functionality has been moved to a dedicated module M(amazon.aws.ec2_vol_info). default: present choices: ['absent', 'present'] type: str modify_volume: description: - - The volume won't be modified unless this key is C(true). + - The volume won't be modified unless this key is V(true). type: bool default: false version_added: 1.4.0 @@ -93,7 +93,7 @@ version_added: 1.4.0 multi_attach: description: - - If set to C(true), Multi-Attach will be enabled when creating the volume. + - If set to V(true), Multi-Attach will be enabled when creating the volume. - When you create a new volume, Multi-Attach is disabled by default. - This parameter is supported with io1 and io2 volumes only. type: bool @@ -107,7 +107,7 @@ author: - "Lester Wade (@lwade)" notes: - - Support for I(purge_tags) was added in release 1.5.0. + - Support for O(purge_tags) was added in release 1.5.0. extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules @@ -205,22 +205,22 @@ RETURN = r""" device: - description: device name of attached volume + description: Device name of attached volume. returned: when success type: str sample: "/dev/sdf" volume_id: - description: the id of volume + description: The id of volume. returned: when success type: str sample: "vol-35b333d9" volume_type: - description: the volume type + description: The volume type. returned: when success type: str sample: "standard" volume: - description: a dictionary containing detailed attributes of the volume + description: A dictionary containing detailed attributes of the volume. returned: when success type: dict contains: diff --git a/plugins/modules/ec2_vpc_dhcp_option.py b/plugins/modules/ec2_vpc_dhcp_option.py index 7ed8865ca43..305a9814984 100644 --- a/plugins/modules/ec2_vpc_dhcp_option.py +++ b/plugins/modules/ec2_vpc_dhcp_option.py @@ -68,7 +68,7 @@ inherit_existing: description: - For any DHCP options not specified in these parameters, whether to - inherit them from the options set already applied to I(vpc_id), or to + inherit them from the options set already applied to O(vpc_id), or to reset them to be empty. type: bool default: false @@ -87,7 +87,7 @@ choices: [ 'absent', 'present' ] type: str notes: - - Support for I(purge_tags) was added in release 2.0.0. + - Support for O(purge_tags) was added in release 2.0.0. extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules diff --git a/plugins/modules/ec2_vpc_endpoint.py b/plugins/modules/ec2_vpc_endpoint.py index a52bf2180bf..2ac7df38376 100644 --- a/plugins/modules/ec2_vpc_endpoint.py +++ b/plugins/modules/ec2_vpc_endpoint.py @@ -29,7 +29,7 @@ vpc_endpoint_subnets: description: - The list of subnets to attach to the endpoint. - - Requires I(vpc_endpoint_type=GatewayLoadBalancer) or I(vpc_endpoint_type=Interface). + - Requires O(vpc_endpoint_type=GatewayLoadBalancer) or O(vpc_endpoint_type=Interface). required: false type: list elements: str @@ -37,7 +37,7 @@ vpc_endpoint_security_groups: description: - The list of security groups to attach to the endpoint. - - Requires I(vpc_endpoint_type=GatewayLoadBalancer) or I(vpc_endpoint_type=Interface). + - Requires O(vpc_endpoint_type=GatewayLoadBalancer) or O(vpc_endpoint_type=Interface). required: false type: list elements: str @@ -59,15 +59,15 @@ type: json state: description: - - C(present) to ensure resource is created. - - C(absent) to remove resource. + - V(present) to ensure resource is created. + - V(absent) to remove resource. required: false default: present choices: [ "present", "absent" ] type: str wait: description: - - When specified, will wait for status to reach C(available) for I(state=present). + - When specified, will wait for status to reach available for O(state=present). - Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS. required: false @@ -75,7 +75,7 @@ type: bool wait_timeout: description: - - Used in conjunction with I(wait). + - Used in conjunction with O(wait). - Number of seconds to wait for status. - Unfortunately this is ignored for delete actions due to a difference in behaviour from AWS. @@ -87,14 +87,14 @@ - List of one or more route table IDs to attach to the endpoint. - A route is added to the route table with the destination of the endpoint if provided. - - Route table IDs are only valid for C(Gateway) endpoints. + - Route table IDs are only valid for Gateway endpoints. required: false type: list elements: str vpc_endpoint_id: description: - One or more VPC endpoint IDs to remove from the AWS account. - - Required if I(state=absent). + - Required if O(state=absent). required: false type: str client_token: @@ -105,9 +105,9 @@ author: - Karen Cheng (@Etherdaemon) notes: - - Support for I(tags) and I(purge_tags) was added in release 1.5.0. - - The C(policy_file) paramater was removed in release 6.0.0 please use the - I(policy) option and a file lookup instead. + - Support for O(tags) and I(purge_tags) was added in release 1.5.0. + - The I(policy_file) paramater was removed in release 6.0.0 please use the + O(policy) option and the P(ansible.builtin.file#lookup) lookup plugin instead. extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules @@ -150,7 +150,7 @@ RETURN = r""" endpoints: - description: The resulting endpoints from the module call + description: The resulting endpoints from the module call. returned: success type: list elements: dict diff --git a/plugins/modules/ec2_vpc_endpoint_info.py b/plugins/modules/ec2_vpc_endpoint_info.py index 77a9f040551..4dd4067214d 100644 --- a/plugins/modules/ec2_vpc_endpoint_info.py +++ b/plugins/modules/ec2_vpc_endpoint_info.py @@ -30,8 +30,8 @@ - amazon.aws.region.modules - amazon.aws.boto3 notes: - - Support for the C(query) parameter was dropped in release 6.0.0. This module now only queries - for endpoints. Information about endpoint services can be retrieved using the + - Support for the I(query) parameter was dropped in release 6.0.0. This module now only queries + for endpoints. Information about endpoint services can be retrieved using the M(amazon.aws.ec2_vpc_endpoint_service_info) module. """ diff --git a/plugins/modules/ec2_vpc_igw.py b/plugins/modules/ec2_vpc_igw.py index b19507a9c72..b8d468aba41 100644 --- a/plugins/modules/ec2_vpc_igw.py +++ b/plugins/modules/ec2_vpc_igw.py @@ -10,7 +10,7 @@ version_added: 1.0.0 short_description: Manage an AWS VPC Internet gateway description: - - Manage an AWS VPC Internet gateway + - Manage an AWS VPC Internet gateway. author: Robert Estelle (@erydo) options: internet_gateway_id: @@ -21,33 +21,33 @@ type: str vpc_id: description: - - The VPC ID for the VPC to attach (when state=present) - - VPC ID can also be provided to find the internet gateway to manage that the VPC is attached to + - The VPC ID for the VPC to attach (when O(state=present)). + - VPC ID can also be provided to find the internet gateway to manage that the VPC is attached to. required: false type: str state: description: - - Create or terminate the IGW + - Create or terminate the IGW. default: present choices: [ 'present', 'absent' ] type: str force_attach: version_added: 7.0.0 description: - - Force attaching VPC to I(vpc_id). - - Setting this option to true will detach an existing VPC attachment and attach to the supplied I(vpc_id). - - Ignored when I(state=absent). - - I(vpc_id) must be specified when I(force_attach) is true + - Force attaching VPC to O(vpc_id). + - Setting this option to true will detach an existing VPC attachment and attach to the supplied O(vpc_id). + - Ignored when O(state=absent). + - O(vpc_id) must be specified when O(force_attach=true). default: false type: bool detach_vpc: version_added: 7.0.0 description: - - Remove attached VPC from gateway + - Remove attached VPC from gateway. default: false type: bool notes: -- Support for I(purge_tags) was added in release 1.3.0. +- Support for O(purge_tags) was added in release 1.3.0. extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules @@ -118,20 +118,20 @@ gateway_id: description: The unique identifier for the Internet Gateway. type: str - returned: I(state=present) + returned: O(state=present) sample: gateway_id: "igw-XXXXXXXX" tags: description: The tags associated the Internet Gateway. type: dict - returned: I(state=present) + returned: O(state=present) sample: tags: "Ansible": "Test" vpc_id: description: The VPC ID associated with the Internet Gateway. type: str - returned: I(state=present) + returned: O(state=present) sample: vpc_id: "vpc-XXXXXXXX" """ diff --git a/plugins/modules/ec2_vpc_igw_info.py b/plugins/modules/ec2_vpc_igw_info.py index ac8681fc7d6..6a76365d420 100644 --- a/plugins/modules/ec2_vpc_igw_info.py +++ b/plugins/modules/ec2_vpc_igw_info.py @@ -27,8 +27,8 @@ convert_tags: description: - Convert tags from boto3 format (list of dictionaries) to the standard dictionary format. - - Prior to release 4.0.0 this defaulted to C(False). - default: True + - Prior to release 4.0.0 this defaulted to V(false). + default: true type: bool version_added: 1.3.0 extends_documentation_fragment: @@ -67,7 +67,7 @@ description: True if listing the internet gateways succeeds. type: bool returned: always - sample: "false" + sample: false internet_gateways: description: The internet gateways for the account. returned: always diff --git a/plugins/modules/ec2_vpc_nat_gateway.py b/plugins/modules/ec2_vpc_nat_gateway.py index b0b6b209e36..fbc15292f16 100644 --- a/plugins/modules/ec2_vpc_nat_gateway.py +++ b/plugins/modules/ec2_vpc_nat_gateway.py @@ -43,12 +43,12 @@ eip_address: description: - The elastic IP address of the EIP you want attached to this NAT Gateway. - If this is not passed and the allocation_id is not passed, + If this is not passed and the O(allocation_id) is not passed, an EIP is generated for this NAT Gateway. type: str if_exist_do_not_create: description: - - if a NAT Gateway exists already in the subnet_id, then do not create a new one. + - If a NAT Gateway exists already in the O(subnet_id), then do not create a new one. required: false default: false type: bool @@ -77,11 +77,11 @@ type: str default_create: description: - - When I(default_create=True) and I(eip_address) has been set, but not yet + - When O(default_create=true) and O(eip_address) has been set, but not yet allocated, the NAT gateway is created and a new EIP is automatically allocated. - - When I(default_create=False) and I(eip_address) has been set, but not yet + - When O(default_create=false) and O(eip_address) has been set, but not yet allocated, the module will fail. - - If I(eip_address) has not been set, this parameter has no effect. + - If O(eip_address) has not been set, this parameter has no effect. default: false type: bool version_added: 6.2.0 @@ -91,7 +91,7 @@ - Karen Cheng (@Etherdaemon) - Alina Buzachis (@alinabuzachis) notes: - - Support for I(tags) and I(purge_tags) was added in release 1.4.0. + - Support for O(tags) and O(purge_tags) was added in release 1.4.0. extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules @@ -205,22 +205,22 @@ sample: public create_time: description: The ISO 8601 date time format in UTC. - returned: In all cases. + returned: always type: str sample: "2016-03-05T05:19:20.282000+00:00'" nat_gateway_id: - description: id of the VPC NAT Gateway - returned: In all cases. + description: Id of the VPC NAT Gateway. + returned: always type: str sample: "nat-0d1e3a878585988f8" subnet_id: - description: id of the Subnet - returned: In all cases. + description: Id of the Subnet. + returned: always type: str sample: "subnet-12345" state: description: The current state of the NAT Gateway. - returned: In all cases. + returned: always type: str sample: "available" tags: @@ -231,13 +231,13 @@ tags: "Ansible": "Test" vpc_id: - description: id of the VPC. - returned: In all cases. + description: Id of the VPC. + returned: always type: str sample: "vpc-12345" nat_gateway_addresses: description: List of dictionaries containing the public_ip, network_interface_id, private_ip, and allocation_id. - returned: In all cases. + returned: always type: complex contains: allocation_id: diff --git a/plugins/modules/ec2_vpc_nat_gateway_info.py b/plugins/modules/ec2_vpc_nat_gateway_info.py index 3e685447124..c805e7386dc 100644 --- a/plugins/modules/ec2_vpc_nat_gateway_info.py +++ b/plugins/modules/ec2_vpc_nat_gateway_info.py @@ -9,7 +9,7 @@ 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 + - Gets various details related to AWS VPC Managed Nat Gateways. options: nat_gateway_ids: description: diff --git a/plugins/modules/ec2_vpc_net.py b/plugins/modules/ec2_vpc_net.py index 9e286201381..a3bc5aa9772 100644 --- a/plugins/modules/ec2_vpc_net.py +++ b/plugins/modules/ec2_vpc_net.py @@ -17,42 +17,42 @@ options: name: description: - - The name to give your VPC. This is used in combination with I(cidr_block) + - The name to give your VPC. This is used in combination with O(cidr_block) to determine if a VPC already exists. - - The value of I(name) overrides any value set for C(Name) in the I(tags) + - The value of O(name) overrides any value set for V(Name) in the O(tags) parameter. - - At least one of I(name) and I(vpc_id) must be specified. - - I(name) must be specified when creating a new VPC. + - At least one of O(name) and O(vpc_id) must be specified. + - O(name) must be specified when creating a new VPC. type: str vpc_id: version_added: 4.0.0 description: - The ID of the VPC. - - At least one of I(name) and I(vpc_id) must be specified. - - At least one of I(name) and I(cidr_block) must be specified. + - At least one of O(name) and O(vpc_id) must be specified. + - At least one of O(name) and O(cidr_block) must be specified. type: str cidr_block: description: - The primary CIDR of the VPC. - The first in the list will be used as the primary CIDR - and is used in conjunction with I(name) to ensure idempotence. - - Required when I(vpc_id) is not set. + and is used in conjunction with O(name) to ensure idempotence. + - Required when O(vpc_id) is not set. type: list elements: str ipv6_cidr: description: - Request an Amazon-provided IPv6 CIDR block with /56 prefix length. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. - - Default value is C(false) when creating a new VPC. + - Default value is V(false) when creating a new VPC. type: bool purge_cidrs: description: - - Remove CIDRs that are associated with the VPC and are not specified in I(cidr_block). + - Remove CIDRs that are associated with the VPC and are not specified in O(cidr_block). default: false type: bool tenancy: description: - - Whether to be default or dedicated tenancy. + - Whether to be V(default) or V(dedicated) tenancy. - This cannot be changed after the VPC has been created. default: default choices: [ 'default', 'dedicated' ] @@ -60,12 +60,12 @@ dns_support: description: - Whether to enable AWS DNS support. - - Default value is C(true) when creating a new VPC. + - Default value is V(true) when creating a new VPC. type: bool dns_hostnames: description: - Whether to enable AWS hostname support. - - Default value is C(true) when creating a new VPC. + - Default value is V(true) when creating a new VPC. type: bool dhcp_opts_id: description: @@ -80,7 +80,7 @@ multi_ok: description: - By default the module will not create another VPC if there is another VPC with the same name and CIDR block. - Specify I(multi_ok=true) if you want duplicate VPCs created. + Specify O(multi_ok=true) if you want duplicate VPCs created. type: bool default: false extends_documentation_fragment: @@ -119,17 +119,17 @@ RETURN = r""" vpc: - description: info about the VPC that was created or deleted + description: Info about the VPC that was created or deleted. returned: always type: complex contains: cidr_block: - description: The CIDR of the VPC + description: The CIDR of the VPC. returned: always type: str sample: 10.0.0.0/16 cidr_block_association_set: - description: IPv4 CIDR blocks associated with the VPC + description: IPv4 CIDR blocks associated with the VPC. returned: success type: list sample: @@ -143,12 +143,12 @@ } ] dhcp_options_id: - description: the id of the DHCP options associated with this VPC + description: The id of the DHCP options associated with this VPC. returned: always type: str sample: dopt-12345678 id: - description: VPC resource id + description: VPC resource id. returned: always type: str sample: vpc-12345678 @@ -159,12 +159,12 @@ sample: MyVPC version_added: 4.0.0 instance_tenancy: - description: indicates whether VPC uses default or dedicated tenancy + description: Indicates whether VPC uses default or dedicated tenancy. returned: always type: str sample: default ipv6_cidr_block_association_set: - description: IPv6 CIDR blocks associated with the VPC + description: IPv6 CIDR blocks associated with the VPC. returned: success type: list sample: @@ -178,22 +178,22 @@ } ] is_default: - description: indicates whether this is the default VPC + description: Indicates whether this is the default VPC. returned: always type: bool sample: false state: - description: state of the VPC + description: State of the VPC. returned: always type: str sample: available tags: - description: tags attached to the VPC, includes name + description: Tags attached to the VPC, includes name. returned: always type: complex contains: Name: - description: name tag for the VPC + description: Name tag for the VPC. returned: always type: str sample: pk_vpc4 diff --git a/plugins/modules/ec2_vpc_net_info.py b/plugins/modules/ec2_vpc_net_info.py index 93b44fa7920..a9d357cfb86 100644 --- a/plugins/modules/ec2_vpc_net_info.py +++ b/plugins/modules/ec2_vpc_net_info.py @@ -8,9 +8,9 @@ --- module: ec2_vpc_net_info version_added: 1.0.0 -short_description: Gather information about ec2 VPCs in AWS +short_description: Gather information about EC2 VPCs in AWS description: - - Gather information about ec2 VPCs in AWS + - Gather information about EC2 VPCs in AWS. author: "Rob White (@wimnat)" options: vpc_ids: diff --git a/plugins/modules/ec2_vpc_route_table.py b/plugins/modules/ec2_vpc_route_table.py index debf5039af1..57db93cdb91 100644 --- a/plugins/modules/ec2_vpc_route_table.py +++ b/plugins/modules/ec2_vpc_route_table.py @@ -19,18 +19,18 @@ gateway_id: description: - The ID of the gateway to associate with the route table. - - If I(gateway_id) is C('None') or C(''), gateway will be disassociated with the route table. + - If O(gateway_id) is V('None') or V(''), gateway will be disassociated with the route table. type: str version_added: 3.2.0 lookup: description: - - Look up route table by either I(tags) or by I(route_table_id). - - If I(lookup=tag) and I(tags) is not specified then no lookup for an + - Look up route table by either O(tags) or by O(route_table_id). + - If O(lookup=tag) and O(tags) is not specified then no lookup for an existing route table is performed and a new route table will be created. - - When using I(lookup=tag), multiple matches being found will result in + - When using O(lookup=tag), multiple matches being found will result in a failure and no changes will be made. - - To change the tags of a route table use I(lookup=id). - - I(vpc_id) must be specified when I(lookup=tag). + - To change the tags of a route table use O(lookup=id). + - O(vpc_id) must be specified when O(lookup=tag). default: tag choices: [ 'tag', 'id' ] type: str @@ -51,16 +51,16 @@ route_table_id: description: - The ID of the route table to update or delete. - - Required when I(lookup=id). + - Required when O(lookup=id). type: str routes: description: - List of routes in the route table. - - Routes are specified as dicts containing the keys C(dest) and one of C(gateway_id), - C(instance_id), C(network_interface_id), or C(vpc_peering_connection_id). - - The value of C(dest) is used for the destination match. It may be a IPv4 CIDR block + - Routes are specified as dicts containing the keys V(dest) and one of V(gateway_id), + V(instance_id), V(network_interface_id), or V(vpc_peering_connection_id). + - The value of V(dest) is used for the destination match. It may be a IPv4 CIDR block or a IPv6 CIDR block. - - If I(gateway_id) is specified, you can refer to the VPC's IGW by using the value C(igw). + - If V(gateway_id) is specified, you can refer to the VPC's IGW by using the value V(igw). - Routes are required for present states. type: list elements: dict @@ -78,10 +78,10 @@ vpc_id: description: - VPC ID of the VPC in which to create the route table. - - Required when I(state=present) or I(lookup=tag). + - Required when O(state=present) or O(lookup=tag). type: str notes: - - Tags are used to uniquely identify route tables within a VPC when the I(route_table_id) is not supplied. + - Tags are used to uniquely identify route tables within a VPC when the O(route_table_id) is not supplied. extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules @@ -207,7 +207,7 @@ type: str sample: subnet-82055af9 id: - description: ID of the route table (same as route_table_id for backwards compatibility). + description: ID of the route table (same as RV(route_table.route_table_id) for backwards compatibility). returned: always type: str sample: rtb-bf779ed7 diff --git a/plugins/modules/ec2_vpc_route_table_info.py b/plugins/modules/ec2_vpc_route_table_info.py index d330299af37..bde66f03378 100644 --- a/plugins/modules/ec2_vpc_route_table_info.py +++ b/plugins/modules/ec2_vpc_route_table_info.py @@ -10,7 +10,7 @@ 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 + - Gather information about EC2 VPC route tables in AWS. author: - "Rob White (@wimnat)" - "Mark Chappell (@tremble)" @@ -103,7 +103,7 @@ type: str sample: subnet-82055af9 id: - description: ID of the route table (same as route_table_id for backwards compatibility). + description: ID of the route table (same as RV(route_tables.route_table_id) for backwards compatibility). returned: always type: str sample: rtb-bf779ed7 diff --git a/plugins/modules/ec2_vpc_subnet.py b/plugins/modules/ec2_vpc_subnet.py index b7446794a61..e84ba577f7f 100644 --- a/plugins/modules/ec2_vpc_subnet.py +++ b/plugins/modules/ec2_vpc_subnet.py @@ -18,25 +18,25 @@ az: description: - The availability zone for the subnet. - - Required if I(outpost_arn) is set. + - Required if O(outpost_arn) is set. type: str cidr: description: - - The CIDR block for the subnet. E.g. C(192.0.2.0/24). + - The CIDR block for the subnet. E.g. V(192.0.2.0/24). type: str required: true ipv6_cidr: description: - The IPv6 CIDR block for the subnet. - The VPC must have a /56 block assigned and this value must be a valid IPv6 /64 that falls in the VPC range. - - Required if I(assign_instances_ipv6=true) + - Required if O(assign_instances_ipv6=true) type: str default: '' outpost_arn: description: - The Amazon Resource Name (ARN) of the Outpost. - If set, allows to create subnet in an Outpost. - - If I(outpost_arn) is set, I(az) must also be specified. + - If O(outpost_arn) is set, O(az) must also be specified. type: str default: '' state: @@ -58,7 +58,7 @@ assign_instances_ipv6: description: - Whether instances launched into the subnet should default to being automatically assigned an IPv6 address. - - If I(assign_instances_ipv6=true), I(ipv6_cidr) must also be specified. + - If O(assign_instances_ipv6=true), O(ipv6_cidr) must also be specified. type: bool default: false wait: @@ -69,7 +69,7 @@ wait_timeout: description: - Number of seconds to wait for changes to complete - - Ignored unless I(wait=True). + - Ignored unless O(wait=true). default: 300 type: int extends_documentation_fragment: @@ -114,27 +114,27 @@ RETURN = r""" subnet: - description: Dictionary of subnet values + description: Dictionary of subnet values. returned: O(state=present) type: complex contains: id: - description: Subnet resource id + description: Subnet resource id. returned: O(state=present) type: str sample: subnet-b883b2c4 cidr_block: - description: The IPv4 CIDR of the Subnet + description: The IPv4 CIDR of the Subnet. returned: O(state=present) type: str sample: "10.0.0.0/16" ipv6_cidr_block: - description: The IPv6 CIDR block actively associated with the Subnet + description: The IPv6 CIDR block actively associated with the Subnet. returned: O(state=present) type: str sample: "2001:db8:0:102::/64" availability_zone: - description: Availability zone of the Subnet + description: Availability zone of the Subnet. returned: O(state=present) type: str sample: us-east-1a @@ -144,37 +144,37 @@ type: str sample: use1-az6 state: - description: state of the Subnet + description: State of the Subnet. returned: O(state=present) type: str sample: available tags: - description: tags attached to the Subnet, includes name + description: Tags attached to the Subnet, includes name. returned: O(state=present) type: dict sample: {"Name": "My Subnet", "env": "staging"} map_public_ip_on_launch: - description: whether public IP is auto-assigned to new instances + description: Whether public IP is auto-assigned to new instances. returned: O(state=present) type: bool sample: false assign_ipv6_address_on_creation: - description: whether IPv6 address is auto-assigned to new instances + description: Whether IPv6 address is auto-assigned to new instances. returned: O(state=present) type: bool sample: false vpc_id: - description: the id of the VPC where this Subnet exists + description: The id of the VPC where this Subnet exists. returned: O(state=present) type: str sample: vpc-67236184 available_ip_address_count: - description: number of available IPv4 addresses + description: Number of available IPv4 addresses. returned: O(state=present) type: str sample: 251 default_for_az: - description: indicates whether this is the default Subnet for this Availability Zone + description: Indicates whether this is the default Subnet for this Availability Zone. returned: O(state=present) type: bool sample: false @@ -184,7 +184,7 @@ type: bool sample: false ipv6_association_id: - description: The IPv6 association ID for the currently associated CIDR + description: The IPv6 association ID for the currently associated CIDR. returned: O(state=present) type: str sample: subnet-cidr-assoc-b85c74d2 @@ -198,7 +198,7 @@ type: complex contains: association_id: - description: The association ID + description: The association ID. returned: always type: str ipv6_cidr_block: diff --git a/plugins/modules/ec2_vpc_subnet_info.py b/plugins/modules/ec2_vpc_subnet_info.py index 7fe2064c319..9bf2133911a 100644 --- a/plugins/modules/ec2_vpc_subnet_info.py +++ b/plugins/modules/ec2_vpc_subnet_info.py @@ -8,9 +8,9 @@ --- module: ec2_vpc_subnet_info version_added: 1.0.0 -short_description: Gather information about ec2 VPC subnets in AWS +short_description: Gather information about EC2 VPC subnets in AWS description: - - Gather information about ec2 VPC subnets in AWS + - Gather information about EC2 VPC subnets in AWS. author: "Rob White (@wimnat)" options: subnet_ids: