diff --git a/README.md b/README.md index 816630e..25c0dbf 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,58 @@ An exception is made for ENIs attached to DataSync tasks since DataSync only est This includes a 24 hour cloudwatch alarm to trigger the lambda regularly in an effort to keep the account clean and make the resources available for another consumer. +## Requirements +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.14 | +| [archive](#requirement\_archive) | ~> 2.2 | +| [aws](#requirement\_aws) | > 4.0 | +| [random](#requirement\_random) | >= 3.1.0 | +## Providers + +| Name | Version | +|------|---------| +| [archive](#provider\_archive) | ~> 2.2 | +| [aws](#provider\_aws) | > 4.0 | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [iam](#module\_iam) | ./iam | n/a | + +## Resources + +| Name | Type | +|------|------| +| [aws_cloudwatch_event_rule.ip_address_release_lambda_interval](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_rule) | resource | +| [aws_cloudwatch_event_target.ip_address_release_lambda_attach](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_target) | resource | +| [aws_lambda_function.ip_address_release_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource | +| [aws_lambda_permission.event_permission](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource | +| [archive_file.lambda_source](https://registry.terraform.io/providers/hashicorp/archive/latest/docs/data-sources/file) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [account\_name](#input\_account\_name) | The account name for use in alarm description. | `string` | n/a | yes | +| [iam\_role\_arn](#input\_iam\_role\_arn) | The ARN of the IAM Role to use (creates a new one if set to `null`) | `string` | `null` | no | +| [internet\_egress\_security\_group\_id](#input\_internet\_egress\_security\_group\_id) | security group id that allows internet outbound calls to port 443 | `string` | n/a | yes | +| [kms\_key\_arn](#input\_kms\_key\_arn) | ARN of the key to give to Lambda for access | `string` | n/a | yes | +| [lambda\_runtime](#input\_lambda\_runtime) | Python runtime to use for this lambda | `string` | `"python3.9"` | no | +| [permissions\_boundary\_arn](#input\_permissions\_boundary\_arn) | The ARN of the policy that is used to set the permissions boundary for the IAM roles. | `string` | `null` | no | +| [prefix](#input\_prefix) | prefix name, can be a team or product name. E.g., 'SRE' | `string` | n/a | yes | +| [subnet\_ids](#input\_subnet\_ids) | Subnets that Lambda will be created with in the VPC | `list(string)` | n/a | yes | +| [timeout](#input\_timeout) | Timeout value for the lambda | `number` | `300` | no | +| [vpc\_id](#input\_vpc\_id) | VPC ID to attach the IP Address Release lambda to. | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| [iam\_role\_arn](#output\_iam\_role\_arn) | The IAM Role created, or the one passed in. | # Multi-region deployment