From f3e266903496203b72c0fccfb3aaf149e3b1da90 Mon Sep 17 00:00:00 2001 From: nimisha-gj Date: Thu, 25 Jul 2024 10:39:28 +0530 Subject: [PATCH] config: update terraform-docs --- .terraform-docs.yaml | 3 +++ README.md | 2 ++ modules/account/README.md | 2 ++ modules/account_users_and_groups_assignments/README.md | 2 ++ modules/organizational_unit/README.md | 2 ++ modules/permission_sets/README.md | 2 ++ modules/policy/README.md | 2 ++ modules/policy_attachment/README.md | 2 ++ modules/sso_groups/README.md | 2 ++ 9 files changed, 19 insertions(+) diff --git a/.terraform-docs.yaml b/.terraform-docs.yaml index cb17c02..d53573a 100644 --- a/.terraform-docs.yaml +++ b/.terraform-docs.yaml @@ -12,7 +12,10 @@ output: file: "README.md" mode: replace template: |- + {{ .Content }} + + {{- printf "\n" -}} sort: enabled: true diff --git a/README.md b/README.md index ab510ce..d10d98b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizations Module A Terraform module for creating and managing AWS Organizations. @@ -50,3 +51,4 @@ No modules. | [aws\_organizations\_organization\_master\_account\_id](#output\_aws\_organizations\_organization\_master\_account\_id) | Identifier of the master account. | | [aws\_organizations\_organization\_none\_master\_accounts](#output\_aws\_organizations\_organization\_none\_master\_accounts) | List of organization accounts excluding the master account. | | [aws\_organizations\_organization\_roots](#output\_aws\_organizations\_organization\_roots) | List of organization roots. | + diff --git a/modules/account/README.md b/modules/account/README.md index f8481b2..7e59b84 100644 --- a/modules/account/README.md +++ b/modules/account/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizations Account Module A Terraform module for creating and managing AWS Organizations member account. @@ -42,3 +43,4 @@ No modules. |------|-------------| | [aws\_organizations\_account\_arn](#output\_aws\_organizations\_account\_arn) | The ARN for this account. | | [aws\_organizations\_account\_id](#output\_aws\_organizations\_account\_id) | The AWS account id. | + diff --git a/modules/account_users_and_groups_assignments/README.md b/modules/account_users_and_groups_assignments/README.md index 659e294..4e437bd 100644 --- a/modules/account_users_and_groups_assignments/README.md +++ b/modules/account_users_and_groups_assignments/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Account Users and Groups Assignments Module A Terraform module for assigning users and groups to AWS accounts. @@ -47,3 +48,4 @@ No modules. | Name | Description | |------|-------------| | [assignments](#output\_assignments) | The account assignment resources created for AWS SSO. Each resource includes details about the account, permission set, principal, and the status of the assignments. | + diff --git a/modules/organizational_unit/README.md b/modules/organizational_unit/README.md index 026ead9..ce31fae 100644 --- a/modules/organizational_unit/README.md +++ b/modules/organizational_unit/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizational Unit Module A Terraform module for creating and managing AWS Organizational Unit. @@ -40,3 +41,4 @@ No modules. | [aws\_organizations\_organizational\_unit\_accounts](#output\_aws\_organizations\_organizational\_unit\_accounts) | List of child accounts for org\_unit Organizational Unit. | | [aws\_organizations\_organizational\_unit\_arn](#output\_aws\_organizations\_organizational\_unit\_arn) | ARN of the organizational unit. | | [aws\_organizations\_organizational\_unit\_id](#output\_aws\_organizations\_organizational\_unit\_id) | Identifier of the organization unit. | + diff --git a/modules/permission_sets/README.md b/modules/permission_sets/README.md index ff0d755..916e2b1 100644 --- a/modules/permission_sets/README.md +++ b/modules/permission_sets/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizations Permission-Sets Module A Terraform module for creating and managing AWS SSO (Single Sign-On) Permission Sets within AWS Organizations @@ -40,3 +41,4 @@ No modules. | Name | Description | |------|-------------| | [permission\_sets\_arns](#output\_permission\_sets\_arns) | A map of the permission sets that were created. Each key is the name of the permission set, and the value contains the ARNs of the created permission sets. | + diff --git a/modules/policy/README.md b/modules/policy/README.md index 44cc1f9..6180996 100644 --- a/modules/policy/README.md +++ b/modules/policy/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizations Policy Module A Terraform module for creating and managing AWS Organizations Policy. @@ -43,3 +44,4 @@ No modules. | [aws\_organizations\_policy\_arn](#output\_aws\_organizations\_policy\_arn) | Amazon Resource Name (ARN) of the policy. | | [aws\_organizations\_policy\_id](#output\_aws\_organizations\_policy\_id) | The unique identifier (ID) of the policy. | | [aws\_organizations\_policy\_tags\_all](#output\_aws\_organizations\_policy\_tags\_all) | A map of tags assigned to the resource, including those inherited from the provider default\_tags configuration block. | + diff --git a/modules/policy_attachment/README.md b/modules/policy_attachment/README.md index 4943477..bb205c1 100644 --- a/modules/policy_attachment/README.md +++ b/modules/policy_attachment/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizations Policy Attachement module A Terraform module for attaching policies to organizational unit or accounts @@ -35,3 +36,4 @@ No modules. ## Outputs No outputs. + diff --git a/modules/sso_groups/README.md b/modules/sso_groups/README.md index 8c090f2..c1c2685 100644 --- a/modules/sso_groups/README.md +++ b/modules/sso_groups/README.md @@ -1,3 +1,4 @@ + # Terraform AWS Organizations SSO Groups module A Terraform module for creating sso groups and attaching users to the groups within the organisation. @@ -39,3 +40,4 @@ No modules. | Name | Description | |------|-------------| | [sso\_group\_ids](#output\_sso\_group\_ids) | A map of SSO groups IDs created by this module | +