update docs

terraform-modules · Mar 2, 2021 · 52bf960 · 52bf960
1 parent 935d17c
commit 52bf960
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 4 deletions.
diff --git a/iam-general-policies/README.md b/iam-general-policies/README.md
@@ -31,7 +31,8 @@ module "general_full" {
 ```
 
 # Managed Policies  
-This provides a number of AWS manged policies: module.general.managed\_policies[KEY]
+This provides a number of AWS manged policies
+> `module.general.managed_policies[KEY]`
 * AdministratorAccess
 * ReadOnlyAccess
 * AmazonVPCFullAccess
@@ -40,7 +41,38 @@ This provides a number of AWS manged policies: module.general.managed\_policies[
 * Billing
 * NetworkAdministrator
 
-Custom Policies
+# Custom Policies
+
+This provides some custom policies that are to be applied to some accounts and groups.
+> `module.general.custom_policies[KEY]` = { object }
+ ```hcl
+ {
+   "name"
+   "path"
+   "description"
+   "policy"
+   "create_policy"
+   "policy_arn"
+ }
+
+```hcl
+* manage-access-keys
+* manage-credentials
+* deny-billing  
+These are policy documents, used liberally, as needed by applications (typically, EC2 instance roles).
+> `module.general.custom_policy_documents[KEY]` = { object }
+ {
+   "name"
+   "description"
+   "policy"
+   "create\_policy"
+ }
+ ```hcl
+* ec2_assume
+* sts_assume
+* root_assume
+* lambda_assume
+```
 
 ## Requirements
 

diff --git a/iam-general-policies/main.tf b/iam-general-policies/main.tf
@@ -32,7 +32,8 @@
 * ```
 *
 * # Managed Policies
-* This provides a number of AWS manged policies: module.general.managed_policies[KEY]
+* This provides a number of AWS manged policies
+* > `module.general.managed_policies[KEY]`
 * * AdministratorAccess 
 * * ReadOnlyAccess 
 * * AmazonVPCFullAccess 
@@ -41,7 +42,36 @@
 * * Billing 
 * * NetworkAdministrator 
 *
-* Custom Policies
+* # Custom Policies
+* 
+* This provides some custom policies that are to be applied to some accounts and groups.
+* > `module.general.custom_policies[KEY]` = { object }
+*  ```hcl
+*  {
+*    "name"
+*    "path"          
+*    "description"   
+*    "policy"       
+*    "create_policy"
+*    "policy_arn"
+*  }
+*  ```hcl
+* * manage-access-keys
+* * manage-credentials
+* * deny-billing
+* These are policy documents, used liberally, as needed by applications (typically, EC2 instance roles).
+* > `module.general.custom_policy_documents[KEY]` = { object }
+*  {
+*    "name"
+*    "description"   
+*    "policy"       
+*    "create_policy"
+*  }
+*  ```hcl
+* * ec2_assume
+* * sts_assume
+* * root_assume
+* * lambda_assume
 */
 
 locals {