Skip to content

Commit

Permalink
config: update terraform-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nimisha-gj committed Jul 25, 2024
1 parent 3b615aa commit f3e2669
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .terraform-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ output:
file: "README.md"
mode: replace
template: |-
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
{{- printf "\n" -}}
sort:
enabled: true
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizations Module
A Terraform module for creating and managing AWS Organizations.

Expand Down Expand Up @@ -50,3 +51,4 @@ No modules.
| <a name="output_aws_organizations_organization_master_account_id"></a> [aws\_organizations\_organization\_master\_account\_id](#output\_aws\_organizations\_organization\_master\_account\_id) | Identifier of the master account. |
| <a name="output_aws_organizations_organization_none_master_accounts"></a> [aws\_organizations\_organization\_none\_master\_accounts](#output\_aws\_organizations\_organization\_none\_master\_accounts) | List of organization accounts excluding the master account. |
| <a name="output_aws_organizations_organization_roots"></a> [aws\_organizations\_organization\_roots](#output\_aws\_organizations\_organization\_roots) | List of organization roots. |
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/account/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizations Account Module
A Terraform module for creating and managing AWS Organizations member account.

Expand Down Expand Up @@ -42,3 +43,4 @@ No modules.
|------|-------------|
| <a name="output_aws_organizations_account_arn"></a> [aws\_organizations\_account\_arn](#output\_aws\_organizations\_account\_arn) | The ARN for this account. |
| <a name="output_aws_organizations_account_id"></a> [aws\_organizations\_account\_id](#output\_aws\_organizations\_account\_id) | The AWS account id. |
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/account_users_and_groups_assignments/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Account Users and Groups Assignments Module
A Terraform module for assigning users and groups to AWS accounts.

Expand Down Expand Up @@ -47,3 +48,4 @@ No modules.
| Name | Description |
|------|-------------|
| <a name="output_assignments"></a> [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. |
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/organizational_unit/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizational Unit Module
A Terraform module for creating and managing AWS Organizational Unit.

Expand Down Expand Up @@ -40,3 +41,4 @@ No modules.
| <a name="output_aws_organizations_organizational_unit_accounts"></a> [aws\_organizations\_organizational\_unit\_accounts](#output\_aws\_organizations\_organizational\_unit\_accounts) | List of child accounts for org\_unit Organizational Unit. |
| <a name="output_aws_organizations_organizational_unit_arn"></a> [aws\_organizations\_organizational\_unit\_arn](#output\_aws\_organizations\_organizational\_unit\_arn) | ARN of the organizational unit. |
| <a name="output_aws_organizations_organizational_unit_id"></a> [aws\_organizations\_organizational\_unit\_id](#output\_aws\_organizations\_organizational\_unit\_id) | Identifier of the organization unit. |
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/permission_sets/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizations Permission-Sets Module
A Terraform module for creating and managing AWS SSO (Single Sign-On) Permission Sets within AWS Organizations

Expand Down Expand Up @@ -40,3 +41,4 @@ No modules.
| Name | Description |
|------|-------------|
| <a name="output_permission_sets_arns"></a> [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. |
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/policy/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizations Policy Module

A Terraform module for creating and managing AWS Organizations Policy.
Expand Down Expand Up @@ -43,3 +44,4 @@ No modules.
| <a name="output_aws_organizations_policy_arn"></a> [aws\_organizations\_policy\_arn](#output\_aws\_organizations\_policy\_arn) | Amazon Resource Name (ARN) of the policy. |
| <a name="output_aws_organizations_policy_id"></a> [aws\_organizations\_policy\_id](#output\_aws\_organizations\_policy\_id) | The unique identifier (ID) of the policy. |
| <a name="output_aws_organizations_policy_tags_all"></a> [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. |
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/policy_attachment/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizations Policy Attachement module
A Terraform module for attaching policies to organizational unit or accounts

Expand Down Expand Up @@ -35,3 +36,4 @@ No modules.
## Outputs

No outputs.
<!-- END_TF_DOCS -->
2 changes: 2 additions & 0 deletions modules/sso_groups/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- BEGIN_TF_DOCS -->
# Terraform AWS Organizations SSO Groups module
A Terraform module for creating sso groups and attaching users to the groups within the organisation.

Expand Down Expand Up @@ -39,3 +40,4 @@ No modules.
| Name | Description |
|------|-------------|
| <a name="output_sso_group_ids"></a> [sso\_group\_ids](#output\_sso\_group\_ids) | A map of SSO groups IDs created by this module |
<!-- END_TF_DOCS -->

0 comments on commit f3e2669

Please sign in to comment.