|
| 1 | +# account |
| 2 | + |
| 3 | +This module creates following resources. |
| 4 | + |
| 5 | +- `aws_organizations_account` |
| 6 | +- `aws_organizations_policy_attachment` (optional) |
| 7 | +- `aws_organizations_delegated_administrator` (optional) |
| 8 | +- `aws_fms_admin_account` (optional) |
| 9 | +- `aws_guardduty_organization_admin_account` (optional) |
| 10 | +- `aws_macie2_organization_admin_account` (optional) |
| 11 | +- `aws_securityhub_organization_admin_account` (optional) |
| 12 | +- `aws_vpc_ipam_organization_admin_account` (optional) |
| 13 | + |
| 14 | +<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 15 | +## Requirements |
| 16 | + |
| 17 | +| Name | Version | |
| 18 | +|------|---------| |
| 19 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5 | |
| 20 | +| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.65 | |
| 21 | + |
| 22 | +## Providers |
| 23 | + |
| 24 | +| Name | Version | |
| 25 | +|------|---------| |
| 26 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.19.0 | |
| 27 | + |
| 28 | +## Modules |
| 29 | + |
| 30 | +| Name | Source | Version | |
| 31 | +|------|--------|---------| |
| 32 | +| <a name="module_resource_group"></a> [resource\_group](#module\_resource\_group) | tedilabs/misc/aws//modules/resource-group | ~> 0.10.0 | |
| 33 | + |
| 34 | +## Resources |
| 35 | + |
| 36 | +| Name | Type | |
| 37 | +|------|------| |
| 38 | +| [aws_fms_admin_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/fms_admin_account) | resource | |
| 39 | +| [aws_guardduty_organization_admin_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_organization_admin_account) | resource | |
| 40 | +| [aws_macie2_organization_admin_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/macie2_organization_admin_account) | resource | |
| 41 | +| [aws_organizations_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_account) | resource | |
| 42 | +| [aws_organizations_delegated_administrator.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_delegated_administrator) | resource | |
| 43 | +| [aws_organizations_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_policy_attachment) | resource | |
| 44 | +| [aws_securityhub_organization_admin_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/securityhub_organization_admin_account) | resource | |
| 45 | +| [aws_vpc_ipam_organization_admin_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_ipam_organization_admin_account) | resource | |
| 46 | +| [aws_organizations_organization.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/organizations_organization) | data source | |
| 47 | + |
| 48 | +## Inputs |
| 49 | + |
| 50 | +| Name | Description | Type | Default | Required | |
| 51 | +|------|-------------|------|---------|:--------:| |
| 52 | +| <a name="input_email"></a> [email](#input\_email) | The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. | `string` | n/a | yes | |
| 53 | +| <a name="input_name"></a> [name](#input\_name) | A friendly name for the member account. | `string` | n/a | yes | |
| 54 | +| <a name="input_delegated_services"></a> [delegated\_services](#input\_delegated\_services) | A list of service principals of the AWS service for which you want to make the member account a delegated administrator. | `set(string)` | `[]` | no | |
| 55 | +| <a name="input_iam_user_access_to_billing_allowed"></a> [iam\_user\_access\_to\_billing\_allowed](#input\_iam\_user\_access\_to\_billing\_allowed) | If true, the new account enables IAM users to access account billing information if they have the required permissions. If false, then only the root user of the new account can access account billing information. | `bool` | `false` | no | |
| 56 | +| <a name="input_module_tags_enabled"></a> [module\_tags\_enabled](#input\_module\_tags\_enabled) | Whether to create AWS Resource Tags for the module informations. | `bool` | `true` | no | |
| 57 | +| <a name="input_parent_id"></a> [parent\_id](#input\_parent\_id) | Parent Organizational Unit ID or Root ID for the account. Defaults to the Organization default Root ID. A configuration must be present for this argument to perform drift detection. | `string` | `null` | no | |
| 58 | +| <a name="input_policies"></a> [policies](#input\_policies) | List of IDs of the policies to be attached to the Account. | `list(string)` | `[]` | no | |
| 59 | +| <a name="input_preconfigured_administrator_role_name"></a> [preconfigured\_administrator\_role\_name](#input\_preconfigured\_administrator\_role\_name) | The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account. | `string` | `null` | no | |
| 60 | +| <a name="input_resource_group_description"></a> [resource\_group\_description](#input\_resource\_group\_description) | The description of Resource Group. | `string` | `"Managed by Terraform."` | no | |
| 61 | +| <a name="input_resource_group_enabled"></a> [resource\_group\_enabled](#input\_resource\_group\_enabled) | Whether to create Resource Group to find and group AWS resources which are created by this module. | `bool` | `true` | no | |
| 62 | +| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | The name of Resource Group. A Resource Group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`. | `string` | `""` | no | |
| 63 | +| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources. | `map(string)` | `{}` | no | |
| 64 | + |
| 65 | +## Outputs |
| 66 | + |
| 67 | +| Name | Description | |
| 68 | +|------|-------------| |
| 69 | +| <a name="output_arn"></a> [arn](#output\_arn) | The Amazon Resource Name (ARN) of this account. | |
| 70 | +| <a name="output_created_at"></a> [created\_at](#output\_created\_at) | The datetime which this account joined to the organization. | |
| 71 | +| <a name="output_created_by"></a> [created\_by](#output\_created\_by) | The method how this account joined to the organization. | |
| 72 | +| <a name="output_delegated_services"></a> [delegated\_services](#output\_delegated\_services) | A list of service principals of the AWS service which the member account is a delegated administrator. | |
| 73 | +| <a name="output_email"></a> [email](#output\_email) | The email address of this account. | |
| 74 | +| <a name="output_iam_user_access_to_billing_allowed"></a> [iam\_user\_access\_to\_billing\_allowed](#output\_iam\_user\_access\_to\_billing\_allowed) | Whether accessing account billing information by IAM User is allowed. | |
| 75 | +| <a name="output_id"></a> [id](#output\_id) | The ID of this account. | |
| 76 | +| <a name="output_name"></a> [name](#output\_name) | The name of this account. | |
| 77 | +| <a name="output_parent_id"></a> [parent\_id](#output\_parent\_id) | The ID of the parent Organizational Unit. | |
| 78 | +| <a name="output_preconfigured_administrator_role_name"></a> [preconfigured\_administrator\_role\_name](#output\_preconfigured\_administrator\_role\_name) | The name of an IAM role that allow users in the master account to assume as administrator. | |
| 79 | +<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
0 commit comments