Skip to content

Commit

Permalink
add new variables to README files [skip-ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
briskt committed Mar 7, 2024
1 parent 30ce393 commit 97c166f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions terraform/000-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ used by later workspaces for HTTPS with the ALB.

- `create_acm_cert` - Set to true if an ACM certificate is needed. Default: `false`
- `create_cd_user` - Set to false if an IAM user for continuous deployment is not needed. Default: `true`
- `app_env` - The abbreviated version of the environment used for naming resources, typically either stg or prod. Default: 'prod'
- `appconfig_app_name` - The application name in AppConfig. If not specified, no AppConfig resources will be created."

## Outputs

Expand Down
2 changes: 2 additions & 0 deletions terraform/040-id-broker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,13 @@ This module is used to create an ECS service running id-broker.
- `abandoned_user_abandoned_period` - Time a user record can remain abandoned before HR is notified. Default: `+6 months`
- `abandoned_user_best_practice_url` - URL for best practices, referenced in notification email. Default: (none)
- `abandoned_user_deactivate_instructions_url` - URL for instruction on how to deactivate user accounts, referenced in notification email. Default: (none)
- `app_id` - AppConfig application ID created by AWS. This cannot be the application name. Use with `env_id`.
- `contingent_user_duration` - How long before a new user without a primary email address expires. Default: `+4 weeks`
- `cpu_cron` - How much CPU to allocate to cron service. Default: `128`
- `email_repeat_delay_days` - Don't resend the same type of email to the same user for X days. Default: `31`
- `email_service_assertValidIp` - Whether or not to assert IP address for Email Service API is trusted
- `email_signature` - Signature for use in emails. Default is empty string
- `env_id` - AppConfig environment ID created by AWS. This cannot be the environment name. Use with `app_id`.
- `event_schedule` - Task run schedule. Default: `cron(0 0 * * ? *)`
- `ga_api_secret` - The Google Analytics API secret for the data stream (e.g. aB-abcdef7890123456789)
- `ga_client_id` - Used by Google Analytics to distinguish the user (e.g. IDP-<the idp name>-ID-BROKER)
Expand Down

0 comments on commit 97c166f

Please sign in to comment.