add main to get readme

terraform-modules · Oct 7, 2022 · 30ae2b4 · 30ae2b4
1 parent 1a6595c
commit 30ae2b4
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/tag-shared-vpc-resources/README.md b/tag-shared-vpc-resources/README.md
@@ -1,3 +1,35 @@
+# About aws-vpc-setup ::  tag-shared-vpc-resources
+
+This will tag resources shared to this account.  Currently, you can tag the following shared resources locally, when shared
+through RAM:
+
+* vpc
+* route-table
+* subnet
+* dhcp-option-set
+* network-acl
+
+These resources are not compatible for sharing.  AWS does not support remote (i.e., in a shared to account) tagging:
+
+* transit-gateway
+
+# Usage
+
+```hcl
+module "tag_shared" {
+  source          = "git@github.e.it.census.gov:terraform-modules/aws-vpc-setup.git//tag-shared-vpc-resources?ref=tf-upgrade"
+  network_account_profile = ""057445207498-ent-gov-network-sa"
+
+  ## optional, with defaults
+  ###  tag_enabled_vpcs = true
+  ###  tag_enabled_dhcp_options = true
+  ###  tag_enabled_route_tables = true
+  ###  tag_enabled_subnets = true
+  ###  tag_enabled_network_acls = true
+  ###  tag_enabled_transit_gateway = false
+}
+```
+
 ## Requirements
 
 | Name | Version |

diff --git a/tag-shared-vpc-resources/main.tf b/tag-shared-vpc-resources/main.tf
@@ -0,0 +1,34 @@
+/*
+* # About aws-vpc-setup ::  tag-shared-vpc-resources
+* 
+* This will tag resources shared to this account.  Currently, you can tag the following shared resources locally, when shared
+* through RAM:
+*
+* * vpc
+* * route-table
+* * subnet
+* * dhcp-option-set
+* * network-acl
+*
+* These resources are not compatible for sharing.  AWS does not support remote (i.e., in a shared to account) tagging:
+*
+* * transit-gateway
+*
+* # Usage
+* 
+* ```hcl
+* module "tag_shared" {
+*   source          = "git@github.e.it.census.gov:terraform-modules/aws-vpc-setup.git//tag-shared-vpc-resources?ref=tf-upgrade"
+*   network_account_profile = ""057445207498-ent-gov-network-sa"
+*
+*   ## optional, with defaults
+*   ###  tag_enabled_vpcs = true
+*   ###  tag_enabled_dhcp_options = true
+*   ###  tag_enabled_route_tables = true
+*   ###  tag_enabled_subnets = true
+*   ###  tag_enabled_network_acls = true
+*   ###  tag_enabled_transit_gateway = false
+* }
+* ```
+*/
+