Skip to content

docs: add inputs and outputs to README #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2021
Merged

docs: add inputs and outputs to README #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,22 @@ A Terraform Module to integrate Amazon Container Registries (ECR) with Lacework.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|----------|
| registry_domain | The registry domain to configure | `string` | `""` | no |
| use_existing_iam_role | Set this to true to use an existing IAM role | `bool` | `false` | no |
| iam_role_arn | The IAM role ARN. required when setting use_existing_iam_role to true | `string` | `""` | no |
| iam_role_external_id | The external ID configured inside the IAM role. required when setting use_existing_iam_role to true | `string` | `""` | no |
| iam_role_name | The IAM role name. Required to match with iam_role_arn if use_existing_iam_role is set to true | `string` | `""` | no |
| external_id_length | The length of the external ID to generate. Max length is 1224. Ignored when use_existing_iam_role is set to true | `number` | `16` | no |
| lacework_aws_account_id | The Lacework AWS account that the IAM role will grant access | `string` | `"434813966438"` | no |
| tags | A map/dictionary of Tags to be assigned to created resources | `map(string)` | `{}` | no |
| wait_time | Amount of time to wait before the next resource is provisioned | `string` | `"15s"` | no |
| lacework_integration_name | The name of the external ECR integration | `string` | `"TF ECR IAM ROLE"` | no |

## Outputs

| Name | Description |
|------|-------------|
| external_id | The external ID configured into the IAM role |
| iam_role_name | The IAM Role name |
| iam_role_arn | The IAM Role ARN |
| registry_domain | The registry domain configured |