Skip to content

Commit eba0f86

Browse files
committed
docs: updates README files
1 parent 34abdc9 commit eba0f86

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
<!-- BEGIN_TF_DOCS -->
1+
# Terraform AWS Organizations Module
2+
A Terraform module for creating and managing AWS Organizations.
3+
4+
## Available Features
5+
6+
- Organization Creation: Set up AWS Organizations.
7+
- Account Management: Create and manage member accounts.
8+
- Organizational Units: Establish and manage organizational units.
9+
210
## Requirements
311

412
| Name | Version |
@@ -10,7 +18,7 @@
1018

1119
| Name | Version |
1220
|------|---------|
13-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.65.0 |
21+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
1422

1523
## Modules
1624

@@ -42,4 +50,3 @@ No modules.
4250
| <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. |
4351
| <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. |
4452
| <a name="output_aws_organizations_organization_roots"></a> [aws\_organizations\_organization\_roots](#output\_aws\_organizations\_organization\_roots) | List of organization roots. |
45-
<!-- END_TF_DOCS -->

modules/account/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<!-- BEGIN_TF_DOCS -->
1+
# Terraform AWS Organizations Account Module
2+
A Terraform module for creating and managing AWS Organizations member account.
3+
24
## Requirements
35

46
| Name | Version |
@@ -10,7 +12,7 @@
1012

1113
| Name | Version |
1214
|------|---------|
13-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.65.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
1416

1517
## Modules
1618

@@ -26,6 +28,7 @@ No modules.
2628

2729
| Name | Description | Type | Default | Required |
2830
|------|-------------|------|---------|:--------:|
31+
| <a name="input_close_on_deletion"></a> [close\_on\_deletion](#input\_close\_on\_deletion) | (Optional) If true, a deletion event will close the account. Otherwise, it will only remove from the organization. | `bool` | `true` | no |
2932
| <a name="input_email"></a> [email](#input\_email) | (Required) Email address of the owner to assign to the new member account. | `string` | n/a | yes |
3033
| <a name="input_iam_user_access_to_billing"></a> [iam\_user\_access\_to\_billing](#input\_iam\_user\_access\_to\_billing) | (Optional) If set to ALLOW, the new account enables IAM users and roles to access account billing information if they have the required permissions. | `string` | `"ALLOW"` | no |
3134
| <a name="input_name"></a> [name](#input\_name) | (Required) Friendly name for the member account. | `string` | n/a | yes |
@@ -38,4 +41,3 @@ No modules.
3841
|------|-------------|
3942
| <a name="output_aws_organizations_account_arn"></a> [aws\_organizations\_account\_arn](#output\_aws\_organizations\_account\_arn) | The ARN for this account. |
4043
| <a name="output_aws_organizations_account_id"></a> [aws\_organizations\_account\_id](#output\_aws\_organizations\_account\_id) | The AWS account id. |
41-
<!-- END_TF_DOCS -->

modules/organizational_unit/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<!-- BEGIN_TF_DOCS -->
1+
# Terraform AWS Organizational Unit Module
2+
A Terraform module for creating and managing AWS Organizational Unit.
3+
24
## Requirements
35

46
| Name | Version |
@@ -10,7 +12,7 @@
1012

1113
| Name | Version |
1214
|------|---------|
13-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.65.0 |
15+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
1416

1517
## Modules
1618

@@ -37,4 +39,3 @@ No modules.
3739
| <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. |
3840
| <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. |
3941
| <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. |
40-
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)