From efc1577a0f45e3e538b62613486667e9b9ea27fa Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 17 Sep 2024 09:53:02 +0000 Subject: [PATCH] terraform-docs: automated action --- README.md | 201 +++--------------------------------------------------- 1 file changed, 11 insertions(+), 190 deletions(-) diff --git a/README.md b/README.md index cc33d07..da6e4fb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# AWS Organizations Terraform module -A Terraform module which configures your AWS Organization and creates AWS accounts. Read [this](https://docs.aws.amazon.com/organizations/index.html) page for more information, and for a secure reference architecture by AWS, read [this](https://docs.aws.amazon.com/prescriptive-guidance/latest/security-reference-architecture/welcome.html) page. + +# Terraform Aws Organization Module +Terraform module to create an AWS Organization -[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://www.blackbird.cloud) +[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://blackbird.cloud) ## Example ```hcl @@ -111,206 +112,25 @@ module "org_policies" { } ``` -# AWS Organizations Terraform module -A Terraform module which configures your AWS Organization and creates AWS accounts. Read [this](https://docs.aws.amazon.com/organizations/index.html) page for more information, and for a secure reference architecture by AWS, read [this](https://docs.aws.amazon.com/prescriptive-guidance/latest/security-reference-architecture/welcome.html) page. - -[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://www.blackbird.cloud) - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1 | -| [aws](#requirement\_aws) | ~> 5 | - -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | 5.49.0 | - -## Resources - -| Name | Type | -|------|------| -| [aws_account_alternate_contact.billing](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_alternate_contact) | resource | -| [aws_account_alternate_contact.operations](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_alternate_contact) | resource | -| [aws_account_alternate_contact.security](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_alternate_contact) | resource | -| [aws_account_primary_contact.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_primary_contact) | resource | -| [aws_organizations_account.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_account) | resource | -| [aws_organizations_delegated_administrator.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_delegated_administrator) | resource | - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [accounts](#input\_accounts) | List of AWS accounts to create | 
map(object({
    email                            = string
    close_on_deletion                = optional(bool)
    iam_user_access_to_billing       = optional(bool)
    delegated_administrator_services = list(string)
    tags                             = optional(map(string))
    parent_id                        = optional(string)
  }))
| n/a | yes | -| [contacts](#input\_contacts) | Primary and alternate contacts for the accounts | 
object({
    primary_contact = object({
      address_line_1     = string
      address_line_2     = optional(string)
      address_line_3     = optional(string)
      city               = string
      company_name       = optional(string)
      country_code       = string
      district_or_county = optional(string)
      full_name          = string
      phone_number       = string
      postal_code        = string
      state_or_region    = optional(string)
      website_url        = optional(string)
    })
    operations_contact = object({
      name          = string
      title         = string
      email_address = string
      phone_number  = optional(string)
    })
    billing_contact = object({
      name          = string
      title         = string
      email_address = string
      phone_number  = optional(string)
    })
    security_contact = object({
      name          = string
      title         = string
      email_address = string
      phone_number  = optional(string)
    })
  })
| n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| [accounts](#output\_accounts) | The accounts created | - -## About - -We are [Blackbird Cloud](https://blackbird.cloud), Amsterdam based cloud consultancy, and cloud management service provider. We help companies build secure, cost efficient, and scale-able solutions. - -Checkout our other :point\_right: [terraform modules](https://registry.terraform.io/namespaces/blackbird-cloud) - -## Copyright - -Copyright © 2017-2023 [Blackbird Cloud](https://www.blackbird.cloud) -# AWS Organizations Terraform module -A Terraform module which configures your AWS Organization and creates AWS accounts. Read [this](https://docs.aws.amazon.com/organizations/index.html) page for more information, and for a secure reference architecture by AWS, read [this](https://docs.aws.amazon.com/prescriptive-guidance/latest/security-reference-architecture/welcome.html) page. - -[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://www.blackbird.cloud) - ## Requirements -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1 | -| [aws](#requirement\_aws) | ~> 5 | +No requirements. ## Providers -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | 5.49.0 | +No providers. ## Resources -| Name | Type | -|------|------| -| [aws_account_alternate_contact.root_billing](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_alternate_contact) | resource | -| [aws_account_alternate_contact.root_operations](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_alternate_contact) | resource | -| [aws_account_alternate_contact.root_security](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_alternate_contact) | resource | -| [aws_account_primary_contact.root](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/account_primary_contact) | resource | -| [aws_organizations_organization.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_organization) | resource | +No resources. ## Inputs -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [aws\_service\_access\_principals](#input\_aws\_service\_access\_principals) | (Optional) List of AWS service principal names for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com. Organization must have feature\_set set to ALL. Some services do not support enablement via this endpoint, see warning in aws docs. https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services_list.html | `list(string)` | n/a | yes | -| [billing\_contact](#input\_billing\_contact) | email\_address - (Required) An email address for the alternate contact. name - (Required) Name of the alternate contact. phone\_number - (Required) Phone number for the alternate contact. title - (Required) Title for the alternate contact. | `any` | n/a | yes | -| [enabled\_policy\_types](#input\_enabled\_policy\_types) | (Optional) List of Organizations policy types to enable in the Organization Root. Organization must have feature\_set set to ALL. For additional information about valid policy types (e.g., AISERVICES\_OPT\_OUT\_POLICY, BACKUP\_POLICY, SERVICE\_CONTROL\_POLICY, and TAG\_POLICY), see the AWS Organizations API Reference. | `list(string)` | `[]` | no | -| [feature\_set](#input\_feature\_set) | (Optional) Specify "ALL" (default) or "CONSOLIDATED\_BILLING". | `string` | n/a | yes | -| [operations\_contact](#input\_operations\_contact) | email\_address - (Required) An email address for the alternate contact. name - (Required) Name of the alternate contact. phone\_number - (Required) Phone number for the alternate contact. title - (Required) Title for the alternate contact. | `any` | n/a | yes | -| [primary\_contact](#input\_primary\_contact) | address\_line\_1 - (Required) The first line of the primary contact address. address\_line\_2 - (Optional) The second line of the primary contact address, if any. address\_line\_3 - (Optional) The third line of the primary contact address, if any. city - (Required) The city of the primary contact address. company\_name - (Optional) The name of the company associated with the primary contact information, if any. country\_code - (Required) The ISO-3166 two-letter country code for the primary contact address. district\_or\_county - (Optional) The district or county of the primary contact address, if any. full\_name - (Required) The full name of the primary contact address. phone\_number - (Required) The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation. postal\_code - (Required) The postal code of the primary contact address. state\_or\_region - (Optional) The state or region of the primary contact address. This field is required in selected countries. website\_url - (Optional) The URL of the website associated with the primary contact information, if any. | `any` | n/a | yes | -| [security\_contact](#input\_security\_contact) | email\_address - (Required) An email address for the alternate contact. name - (Required) Name of the alternate contact. phone\_number - (Required) Phone number for the alternate contact. title - (Required) Title for the alternate contact. | `any` | n/a | yes | +No inputs. ## Outputs -| Name | Description | -|------|-------------| -| [contacts](#output\_contacts) | The contacts for the organization | -| [organization\_root\_id](#output\_organization\_root\_id) | The ID of the organization root | - -## About - -We are [Blackbird Cloud](https://blackbird.cloud), Amsterdam based cloud consultancy, and cloud management service provider. We help companies build secure, cost efficient, and scale-able solutions. - -Checkout our other :point\_right: [terraform modules](https://registry.terraform.io/namespaces/blackbird-cloud) - -## Copyright - -Copyright © 2017-2023 [Blackbird Cloud](https://www.blackbird.cloud) -# AWS Organizations Terraform module -A Terraform module which configures your AWS Organization and creates AWS accounts. Read [this](https://docs.aws.amazon.com/organizations/index.html) page for more information, and for a secure reference architecture by AWS, read [this](https://docs.aws.amazon.com/prescriptive-guidance/latest/security-reference-architecture/welcome.html) page. - -[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://www.blackbird.cloud) - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1 | -| [aws](#requirement\_aws) | ~> 5 | - -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | 5.49.0 | - -## Resources - -| Name | Type | -|------|------| -| [aws_organizations_policy.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_policy) | resource | -| [aws_organizations_policy_attachment.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_policy_attachment) | resource | - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [organizations\_policies](#input\_organizations\_policies) | A map of policies to attach to the organization | 
map(object({
    content      = string
    ous          = list(string)
    description  = optional(string)
    skip_destroy = optional(bool)
    type         = optional(string)
  }))
| n/a | yes | -| [tags](#input\_tags) | A map of tags to add to the resources | `map(string)` | n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| [policies](#output\_policies) | The policies for the organization | - -## About - -We are [Blackbird Cloud](https://blackbird.cloud), Amsterdam based cloud consultancy, and cloud management service provider. We help companies build secure, cost efficient, and scale-able solutions. - -Checkout our other :point\_right: [terraform modules](https://registry.terraform.io/namespaces/blackbird-cloud) - -## Copyright - -Copyright © 2017-2023 [Blackbird Cloud](https://www.blackbird.cloud) -# AWS Organizations Terraform module -A Terraform module which configures your AWS Organization and creates AWS accounts. Read [this](https://docs.aws.amazon.com/organizations/index.html) page for more information, and for a secure reference architecture by AWS, read [this](https://docs.aws.amazon.com/prescriptive-guidance/latest/security-reference-architecture/welcome.html) page. - -[![blackbird-logo](https://raw.githubusercontent.com/blackbird-cloud/terraform-module-template/main/.config/logo_simple.png)](https://www.blackbird.cloud) - - -## Requirements - -| Name | Version | -|------|---------| -| [terraform](#requirement\_terraform) | >= 1 | -| [aws](#requirement\_aws) | ~> 5 | - -## Providers - -| Name | Version | -|------|---------| -| [aws](#provider\_aws) | 5.49.0 | - -## Resources - -| Name | Type | -|------|------| -| [aws_organizations_organizational_unit.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_organizational_unit) | resource | - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [organization\_units](#input\_organization\_units) | List of organizational units to create | 
map(object(
    {
      name      = string
      parent_id = string
      tags      = optional(map(string))
    }
  ))
| n/a | yes | - -## Outputs - -| Name | Description | -|------|-------------| -| [ous](#output\_ous) | The organizational units for the organization | - -## About - -We are [Blackbird Cloud](https://blackbird.cloud), Amsterdam based cloud consultancy, and cloud management service provider. We help companies build secure, cost efficient, and scale-able solutions. - -Checkout our other :point\_right: [terraform modules](https://registry.terraform.io/namespaces/blackbird-cloud) - -## Copyright - -Copyright © 2017-2023 [Blackbird Cloud](https://www.blackbird.cloud) +No outputs. ## About @@ -320,4 +140,5 @@ Checkout our other :point\_right: [terraform modules](https://registry.terraform ## Copyright -Copyright © 2017-2023 [Blackbird Cloud](https://www.blackbird.cloud) \ No newline at end of file +Copyright © 2017-2024 [Blackbird Cloud](https://blackbird.cloud) + \ No newline at end of file