diff --git a/README.md b/README.md index c17f7ab..014c5a6 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,14 @@ The function audits each user in an account for access keys and determines how l | [key\_age\_inactive](#input\_key\_age\_inactive) | Age at which a key should be inactive (e.g. 90) | `number` | n/a | yes | | [key\_age\_warning](#input\_key\_age\_warning) | Age at which to warn (e.g. 75) | `number` | n/a | yes | | [key\_use\_threshold](#input\_key\_use\_threshold) | Age at which unused keys should be deleted (e.g.30) | `number` | n/a | yes | -| [accounts](#input\_accounts) | List of account objects to create events for | 
list(object({
    account_name        = string
    account_number      = string
    role_name           = optional(string) # deprecated
    armed               = bool
    debug               = optional(bool, false)
    email_user_enabled  = bool
    email_targets       = list(string)
    exempt_groups       = list(string)
    schedule_expression = optional(string, "cron(0 1 ? * SUN *)")

  }))
| `[]` | no | +| [accounts](#input\_accounts) | List of account objects to create events for | 
list(object({
    account_name        = string
    account_number      = string
    role_name           = optional(string) # deprecated
    armed               = bool
    debug               = optional(bool, false)
    email_user_enabled  = bool
    email_targets       = list(string)
    exempt_groups       = list(string)
    schedule_expression = optional(string, "cron(0 1 ? * SUN *)")

  }))
| `[]` | no | | [email\_admin\_report\_enabled](#input\_email\_admin\_report\_enabled) | Used to enable or disable the SES emailed report | `bool` | `false` | no | | [email\_admin\_report\_subject](#input\_email\_admin\_report\_subject) | Subject of the report email that is sent | `string` | `null` | no | | [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 | | [email\_banner\_message\_color](#input\_email\_banner\_message\_color) | Color of email banner message, must be valid html color | `string` | `"red"` | no | | [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 | -| [email\_templates](#input\_email\_templates) | Email templates to use for Admin and User emails | 
object({
    admin = optional(object({
      subject = optional(string, null),
      html    = optional(string, null),
      text    = optional(string, null),
    }), {}),
    user = optional(object({
      subject = optional(string, null),
      html    = optional(string, null),
      text    = optional(string, null),
    }), {})
  })
| `{}` | no | -| [lambda](#input\_lambda) | Map of any additional arguments for the upstream lambda module. See | 
object({
    artifacts_dir            = optional(string, "builds")
    build_in_docker          = optional(bool, false)
    create_package           = optional(bool, true)
    ephemeral_storage_size   = optional(number)
    ignore_source_code_hash  = optional(bool, true)
    local_existing_package   = optional(string)
    recreate_missing_package = optional(bool, false)
    runtime                  = optional(string, "python3.11")
    s3_bucket                = optional(string)
    s3_existing_package      = optional(map(string))
    s3_prefix                = optional(string)
    store_on_s3              = optional(bool, false)
    timeout                  = optional(number, 300)
    source_path = optional(object({
      patterns = optional(list(string), ["!\\.terragrunt-source-manifest"])
    }), {})
  })
| `{}` | no | +| [email\_templates](#input\_email\_templates) | Email templates to use for Admin and User emails | 
object({
    admin = optional(object({
      subject = optional(string, null),
      html    = optional(string, null),
      text    = optional(string, null),
    }), {}),
    user = optional(object({
      subject = optional(string, null),
      html    = optional(string, null),
      text    = optional(string, null),
    }), {})
  })
| `{}` | no | +| [lambda](#input\_lambda) | Map of any additional arguments for the upstream lambda module. See | 
object({
    artifacts_dir            = optional(string, "builds")
    build_in_docker          = optional(bool, false)
    create_package           = optional(bool, true)
    ephemeral_storage_size   = optional(number)
    ignore_source_code_hash  = optional(bool, true)
    local_existing_package   = optional(string)
    recreate_missing_package = optional(bool, false)
    runtime                  = optional(string, "python3.11")
    s3_bucket                = optional(string)
    s3_existing_package      = optional(map(string))
    s3_prefix                = optional(string)
    store_on_s3              = optional(bool, false)
    timeout                  = optional(number, 300)
    source_path = optional(object({
      patterns = optional(list(string), ["!\\.terragrunt-source-manifest"])
    }), {})
  })
| `{}` | no | | [log\_level](#input\_log\_level) | Log level for lambda | `string` | `"INFO"` | no | | [project\_name](#input\_project\_name) | Project name to prefix resources with | `string` | `"iam-key-enforcer"` | no | | [s3\_bucket](#input\_s3\_bucket) | Bucket name to write the audit report to if s3\_enabled is set to 'true' | `string` | `null` | no | diff --git a/modules/scheduled_event/README.md b/modules/scheduled_event/README.md index 5c4dc1f..4536440 100644 --- a/modules/scheduled_event/README.md +++ b/modules/scheduled_event/README.md @@ -24,9 +24,9 @@ | [event\_name](#input\_event\_name) | Name of the event | `string` | n/a | yes | | [event\_rule\_description](#input\_event\_rule\_description) | Description of what the event rule does | `string` | n/a | yes | | [lambda\_arn](#input\_lambda\_arn) | ARN of the target lambda | `string` | n/a | yes | -| [dead\_letter\_config](#input\_dead\_letter\_config) | Configuration of the dead letter queue | 
object({
    arn = string
  })
| `null` | no | +| [dead\_letter\_config](#input\_dead\_letter\_config) | Configuration of the dead letter queue | 
object({
    arn = string
  })
| `null` | no | | [event\_bus\_name](#input\_event\_bus\_name) | EventBridge event bus | `string` | `"default"` | no | -| [input\_transformer](#input\_input\_transformer) | Transform to apply on the event input | 
object({
    input_template = string
  })
| `null` | no | +| [input\_transformer](#input\_input\_transformer) | Transform to apply on the event input | 
object({
    input_template = string
  })
| `null` | no | | [project\_name](#input\_project\_name) | Project name to prefix resources with | `string` | `"iam-key-enforcer"` | no | | [schedule\_expression](#input\_schedule\_expression) | Schedule Expression for scheduled event | `string` | `"cron(0 0 * * 1 *)"` | no | | [tags](#input\_tags) | A map of tags to add to the module resources | `map(string)` | `{}` | no |