diff --git a/changelogs/fragments/transit_gateway_doc_update.yaml b/changelogs/fragments/transit_gateway_doc_update.yaml new file mode 100644 index 00000000..26925b17 --- /dev/null +++ b/changelogs/fragments/transit_gateway_doc_update.yaml @@ -0,0 +1,3 @@ +--- +trivial: +- "Update the README of manage_transit_gateway role to match the argument specs." diff --git a/roles/manage_transit_gateway/README.md b/roles/manage_transit_gateway/README.md index c1673384..069a79f1 100644 --- a/roles/manage_transit_gateway/README.md +++ b/roles/manage_transit_gateway/README.md @@ -21,17 +21,21 @@ AWS User Account with the following permission: Role Variables -------------- -* **action**: Whether to create or delete the transit gateway. Choices: 'create', 'delete'. -* **transit_gateway**: A dict of parameters needed to create transit gateway. - **asn**: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. - **tags**: A dict of tags for the transit gateway. - **description**: Description for the transit gateway. -* **vpc_attachment**: A list of dict of parameters to create vpc attachments. - **name**: Name for the VPC attachment. - **tags**: A dict of tags for the attachment. - **subnets**: A list of subnets to be added to the attachment. -* **vpn_attachment**: A list of dict of parameters to create vpn attachments. - **customer_gateway_id**: Id of the customer gateway. +* **action** (str): Whether to create or delete the transit gateway. Choices: 'create', 'delete'. +* **transit_gateway** (dict): A dict of parameters needed to create transit gateway. + **asn** (int): A private Autonomous System Number (ASN) for the Amazon side of a BGP session. + **tags** (dict): A dict of tags for the transit gateway. + **description** (str): Description for the transit gateway. +* **vpc_attachment** (list(dict)): A list of dict of parameters to create vpc attachments. + **name** (str): Name for the VPC attachment. + **tags** (dict): A dict of tags for the attachment. + **subnets** (list(str)): A list of subnets to be added to the attachment. +* **vpn_attachment** list(dict): A list of dict of parameters to create vpn attachments. + **customer_gateway_id** (str): Id of the customer gateway. +* **vpc_route_table** (list(dict)): Route table entries for the VPC. + **vpc_id** (str): VPC id for which the route should be added.. + **cidr_block** (str): Destination CIDR block. + **tags** (dict): A dict of tags for the route table. Dependencies ------------ diff --git a/roles/manage_transit_gateway/meta/argument_specs.yaml b/roles/manage_transit_gateway/meta/argument_specs.yaml index cc7e10b0..99e014f3 100644 --- a/roles/manage_transit_gateway/meta/argument_specs.yaml +++ b/roles/manage_transit_gateway/meta/argument_specs.yaml @@ -54,7 +54,7 @@ argument_specs: elements: dict options: vpc_id: - description: Te VPC id for which the route should be added. + description: The VPC id for which the route should be added. type: str cidr_block: description: Destination CIDR block.