From 36ac2df167ea6e4f0c98bfc68ae5eae4448539c6 Mon Sep 17 00:00:00 2001 From: badra001 Date: Wed, 31 Mar 2021 16:33:58 -0400 Subject: [PATCH] add readme --- iam-account-setings/README.md | 53 +++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 iam-account-setings/README.md diff --git a/iam-account-setings/README.md b/iam-account-setings/README.md new file mode 100644 index 0000000..fdd7a38 --- /dev/null +++ b/iam-account-setings/README.md @@ -0,0 +1,53 @@ +# aws-inf-setup :: iam-account-settings + +# Usage +Here is a simple example, the one most commonly expected to be used. + +```hcl +module "settings" { + source = "git@github.e.it.census.gov:terraform-modules/aws-inf-setup.git//iam-account-settings" + + account_alias = "ma5-gov" + account_usage = "GovCloud Management Account" +} +``` + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_iam_account_alias.alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_account_alias) | resource | +| [aws_iam_account_password_policy.account_settings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_account_password_policy) | resource | +| [aws_arn.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/arn) | data source | +| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source | +| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [account\_alias](#input\_account\_alias) | AWS Account Alias | `string` | `""` | no | +| [account\_id](#input\_account\_id) | AWS Account ID (default will pull from current user) | `string` | `""` | no | +| [account\_usage](#input\_account\_usage) | AWS Account Usage (what we are using it for) | `string` | `""` | no | +| [override\_prefixes](#input\_override\_prefixes) | Override built-in prefixes by component (efs, s3, ebs, kms, role, policy, security-group). This should be used primarily for common infrastructure things | `map(string)` | `{}` | no | +| [tags](#input\_tags) | AWS Tags to apply to appropriate resources (S3, KMS). Do not include safeguard tags here, use the data\_safeguard field for such things. | `map(string)` | `{}` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [console\_url](#output\_console\_url) | AWS Console URL |