Skip to content

Commit

Permalink
Updates readme for latest terraform-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lorengordon committed Dec 31, 2024
1 parent 186fea2 commit 1509233
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ The function audits each user in an account for access keys and determines how l
| <a name="input_key_age_inactive"></a> [key\_age\_inactive](#input\_key\_age\_inactive) | Age at which a key should be inactive (e.g. 90) | `number` | n/a | yes |
| <a name="input_key_age_warning"></a> [key\_age\_warning](#input\_key\_age\_warning) | Age at which to warn (e.g. 75) | `number` | n/a | yes |
| <a name="input_key_use_threshold"></a> [key\_use\_threshold](#input\_key\_use\_threshold) | Age at which unused keys should be deleted (e.g.30) | `number` | n/a | yes |
| <a name="input_accounts"></a> [accounts](#input\_accounts) | List of account objects to create events for | <pre>list(object({<br> account_name = string<br> account_number = string<br> role_name = optional(string) # deprecated<br> armed = bool<br> debug = optional(bool, false)<br> email_user_enabled = bool<br> email_targets = list(string)<br> exempt_groups = list(string)<br> schedule_expression = optional(string, "cron(0 1 ? * SUN *)")<br><br> }))</pre> | `[]` | no |
| <a name="input_accounts"></a> [accounts](#input\_accounts) | List of account objects to create events for | <pre>list(object({<br/> account_name = string<br/> account_number = string<br/> role_name = optional(string) # deprecated<br/> armed = bool<br/> debug = optional(bool, false)<br/> email_user_enabled = bool<br/> email_targets = list(string)<br/> exempt_groups = list(string)<br/> schedule_expression = optional(string, "cron(0 1 ? * SUN *)")<br/><br/> }))</pre> | `[]` | no |
| <a name="input_email_admin_report_enabled"></a> [email\_admin\_report\_enabled](#input\_email\_admin\_report\_enabled) | Used to enable or disable the SES emailed report | `bool` | `false` | no |
| <a name="input_email_admin_report_subject"></a> [email\_admin\_report\_subject](#input\_email\_admin\_report\_subject) | Subject of the report email that is sent | `string` | `null` | no |
| <a name="input_email_banner_message"></a> [email\_banner\_message](#input\_email\_banner\_message) | Messages that will be at the top of all emails sent to notify recipients of important information | `string` | `""` | no |
| <a name="input_email_banner_message_color"></a> [email\_banner\_message\_color](#input\_email\_banner\_message\_color) | Color of email banner message, must be valid html color | `string` | `"red"` | no |
| <a name="input_email_tag"></a> [email\_tag](#input\_email\_tag) | Tag to be placed on the IAM user that we can use to notify when their key is going to be disabled/deleted | `string` | `"keyenforcer:email"` | no |
| <a name="input_email_templates"></a> [email\_templates](#input\_email\_templates) | Email templates to use for Admin and User emails | <pre>object({<br> admin = optional(object({<br> subject = optional(string, null),<br> html = optional(string, null),<br> text = optional(string, null),<br> }), {}),<br> user = optional(object({<br> subject = optional(string, null),<br> html = optional(string, null),<br> text = optional(string, null),<br> }), {})<br> })</pre> | `{}` | no |
| <a name="input_lambda"></a> [lambda](#input\_lambda) | Map of any additional arguments for the upstream lambda module. See <https://github.com/terraform-aws-modules/terraform-aws-lambda> | <pre>object({<br> artifacts_dir = optional(string, "builds")<br> build_in_docker = optional(bool, false)<br> create_package = optional(bool, true)<br> ephemeral_storage_size = optional(number)<br> ignore_source_code_hash = optional(bool, true)<br> local_existing_package = optional(string)<br> recreate_missing_package = optional(bool, false)<br> runtime = optional(string, "python3.11")<br> s3_bucket = optional(string)<br> s3_existing_package = optional(map(string))<br> s3_prefix = optional(string)<br> store_on_s3 = optional(bool, false)<br> timeout = optional(number, 300)<br> source_path = optional(object({<br> patterns = optional(list(string), ["!\\.terragrunt-source-manifest"])<br> }), {})<br> })</pre> | `{}` | no |
| <a name="input_email_templates"></a> [email\_templates](#input\_email\_templates) | Email templates to use for Admin and User emails | <pre>object({<br/> admin = optional(object({<br/> subject = optional(string, null),<br/> html = optional(string, null),<br/> text = optional(string, null),<br/> }), {}),<br/> user = optional(object({<br/> subject = optional(string, null),<br/> html = optional(string, null),<br/> text = optional(string, null),<br/> }), {})<br/> })</pre> | `{}` | no |
| <a name="input_lambda"></a> [lambda](#input\_lambda) | Map of any additional arguments for the upstream lambda module. See <https://github.com/terraform-aws-modules/terraform-aws-lambda> | <pre>object({<br/> artifacts_dir = optional(string, "builds")<br/> build_in_docker = optional(bool, false)<br/> create_package = optional(bool, true)<br/> ephemeral_storage_size = optional(number)<br/> ignore_source_code_hash = optional(bool, true)<br/> local_existing_package = optional(string)<br/> recreate_missing_package = optional(bool, false)<br/> runtime = optional(string, "python3.11")<br/> s3_bucket = optional(string)<br/> s3_existing_package = optional(map(string))<br/> s3_prefix = optional(string)<br/> store_on_s3 = optional(bool, false)<br/> timeout = optional(number, 300)<br/> source_path = optional(object({<br/> patterns = optional(list(string), ["!\\.terragrunt-source-manifest"])<br/> }), {})<br/> })</pre> | `{}` | no |
| <a name="input_log_level"></a> [log\_level](#input\_log\_level) | Log level for lambda | `string` | `"INFO"` | no |
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | Project name to prefix resources with | `string` | `"iam-key-enforcer"` | no |
| <a name="input_s3_bucket"></a> [s3\_bucket](#input\_s3\_bucket) | Bucket name to write the audit report to if s3\_enabled is set to 'true' | `string` | `null` | no |
Expand Down
4 changes: 2 additions & 2 deletions modules/scheduled_event/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
| <a name="input_event_name"></a> [event\_name](#input\_event\_name) | Name of the event | `string` | n/a | yes |
| <a name="input_event_rule_description"></a> [event\_rule\_description](#input\_event\_rule\_description) | Description of what the event rule does | `string` | n/a | yes |
| <a name="input_lambda_arn"></a> [lambda\_arn](#input\_lambda\_arn) | ARN of the target lambda | `string` | n/a | yes |
| <a name="input_dead_letter_config"></a> [dead\_letter\_config](#input\_dead\_letter\_config) | Configuration of the dead letter queue | <pre>object({<br> arn = string<br> })</pre> | `null` | no |
| <a name="input_dead_letter_config"></a> [dead\_letter\_config](#input\_dead\_letter\_config) | Configuration of the dead letter queue | <pre>object({<br/> arn = string<br/> })</pre> | `null` | no |
| <a name="input_event_bus_name"></a> [event\_bus\_name](#input\_event\_bus\_name) | EventBridge event bus | `string` | `"default"` | no |
| <a name="input_input_transformer"></a> [input\_transformer](#input\_input\_transformer) | Transform to apply on the event input | <pre>object({<br> input_template = string<br> })</pre> | `null` | no |
| <a name="input_input_transformer"></a> [input\_transformer](#input\_input\_transformer) | Transform to apply on the event input | <pre>object({<br/> input_template = string<br/> })</pre> | `null` | no |
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | Project name to prefix resources with | `string` | `"iam-key-enforcer"` | no |
| <a name="input_schedule_expression"></a> [schedule\_expression](#input\_schedule\_expression) | Schedule Expression for scheduled event | `string` | `"cron(0 0 * * 1 *)"` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to the module resources | `map(string)` | `{}` | no |
Expand Down

0 comments on commit 1509233

Please sign in to comment.