Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README of manage_transit_gateway role #96

Merged
merged 1 commit into from
Sep 14, 2023
+19 −12
Merged

Update README of manage_transit_gateway role #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelogs/fragments/transit_gateway_doc_update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
trivial:
- "Update the README of manage_transit_gateway role to match the argument specs."
26 changes: 15 additions & 11 deletions roles/manage_transit_gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down
2 changes: 1 addition & 1 deletion roles/manage_transit_gateway/meta/argument_specs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down