Skip to content

README.md

Latest commit

 

History

History
93 lines (88 loc) · 17.1 KB

README.md

File metadata and controls

93 lines (88 loc) · 17.1 KB

Requirements

No requirements.

Inputs

Name Description Type Default Required
aws_account_id The AWS Account ID (numeric) string n/a yes
ca_pem_filename Filename for the CA truststore file within the s3 bucket string null no
commit_id The commit to deploy. Must be in the tree for branch_name string "HEAD" no
component The variable encapsulating the name of this component string "supapi" no
core_account_id AWS Account ID for Core string "000000000000" no
core_environment Environment of Core string "prod" no
csoc_destination_account value of the CSOC destination account, if applicable. If null, CSOC destination account will not be added as a resource in the logging policy string "000000000000" no
csoc_log_forwarding Enable forwarding of API Gateway logs to CSOC bool true no
default_tags A map of default tags to apply to all taggable resources within the component map(string) {} no
disable_gateway_execute_endpoint Disable the execution endpoint for the API Gateway bool true no
enable_alarms Enable CloudWatch alarms for this deployed environment bool true no
enable_api_data_trace Enable API Gateway data trace logging bool false no
enable_backups Enable backups bool false no
enable_event_anomaly_detection Enable CloudWatch anomaly detection alarm for SNS message Detects abnormal drops or spikes in event publishing volume. bool true no
enable_event_cache Enable caching of events to an S3 bucket bool true no
enable_sns_delivery_logging Enable SNS Delivery Failure Notifications bool true no
environment The name of the tfscaffold environment string n/a yes
event_anomaly_band_width The width of the anomaly detection band. Higher values (e.g. 4-6) reduce sensitivity and noise, lower values (e.g. 2-3) increase sensitivity. Recommended: 2-4. number 4 no
event_anomaly_evaluation_periods Number of evaluation periods for the anomaly alarm. Each period is defined by event_anomaly_period. number 3 no
event_anomaly_period The period in seconds over which the specified statistic is applied for anomaly detection. Minimum 300 seconds (5 minutes). Recommended: 300-600. number 300 no
eventpub_control_plane_bus_arn ARN of the EventBridge control plane bus for eventpub string "" no
eventpub_data_plane_bus_arn ARN of the EventBridge data plane bus for eventpub string "" no
force_destroy Flag to force deletion of S3 buckets bool false no
force_lambda_code_deploy If the lambda package in s3 has the same commit id tag as the terraform build branch, the lambda will not update automatically. Set to True if making changes to Lambda code from on the same commit for example during development bool false no
group The group variables are being inherited from (often synonmous with account short-name) string n/a yes
kms_deletion_window When a kms key is deleted, how long should it wait in the pending deletion state? string "30" no
letter_event_source Source value to use for the letter status event updates string "/data-plane/supplier-api/nhs-supplier-api-prod/main/update-status" no
letter_table_ttl_hours Number of hours to set as TTL on letters table number 24 no
letter_variant_map n/a map(object({ supplierId = string, specId = string, priority = number, billingId = string })) 
{
  "digitrials-aspiring": {
    "billingId": "digitrials-aspiring-billing",
    "priority": "0",
    "specId": "digitrials-aspiring",
    "supplierId": "supplier1"
  },
  "digitrials-dmapp": {
    "billingId": "notify-admail-billing",
    "priority": "1",
    "specId": "notify-admail",
    "supplierId": "supplier1"
  },
  "digitrials-globalminds": {
    "billingId": "digitrials-globalminds-billing",
    "priority": "2",
    "specId": "digitrials-globalminds",
    "supplierId": "supplier1"
  },
  "digitrials-mymelanoma": {
    "billingId": "digitrials-mymelanoma-billing",
    "priority": "3",
    "specId": "digitrials-mymelanoma",
    "supplierId": "supplier1"
  },
  "digitrials-ofh": {
    "billingId": "digitrials-ofh-billing",
    "priority": "4",
    "specId": "digitrials-ofh",
    "supplierId": "supplier1"
  },
  "digitrials-prostateprogress": {
    "billingId": "digitrials-prostateprogress-billing",
    "priority": "5",
    "specId": "digitrials-prostateprogress",
    "supplierId": "supplier1"
  },
  "digitrials-protectc": {
    "billingId": "notify-c5-colour-billing",
    "priority": "6",
    "specId": "notify-c5-colour",
    "supplierId": "supplier1"
  },
  "digitrials-restore": {
    "billingId": "digitrials-restore-billing",
    "priority": "7",
    "specId": "digitrials-restore",
    "supplierId": "supplier1"
  },
  "gpreg-admail": {
    "billingId": "notify-admail-billing",
    "priority": "8",
    "specId": "notify-admail",
    "supplierId": "supplier1"
  },
  "nces-abnormal-results": {
    "billingId": "nces-abnormal-results-billing",
    "priority": "9",
    "specId": "nces-abnormal-results",
    "supplierId": "supplier1"
  },
  "nces-abnormal-results-braille": {
    "billingId": "nces-abnormal-results-braille-billing",
    "priority": "10",
    "specId": "nces-abnormal-results-braille",
    "supplierId": "supplier1"
  },
  "nces-invites": {
    "billingId": "nces-invites-billing",
    "priority": "10",
    "specId": "nces-invites",
    "supplierId": "supplier1"
  },
  "nces-invites-braille": {
    "billingId": "nces-invites-braille-billing",
    "priority": "10",
    "specId": "nces-invites-braille",
    "supplierId": "supplier1"
  },
  "nces-standard": {
    "billingId": "notify-c5-whitemail-billing",
    "priority": "11",
    "specId": "notify-c5-whitemail",
    "supplierId": "supplier1"
  },
  "nces-standard-braille": {
    "billingId": "notify-braille-whitemail-billing",
    "priority": "12",
    "specId": "notify-braille-whitemail",
    "supplierId": "supplier1"
  },
  "notify-braille": {
    "billingId": "notify-braille-billing",
    "priority": "13",
    "specId": "notify-braille",
    "supplierId": "supplier1"
  },
  "notify-digital-letters-standard": {
    "billingId": "notify-c5-billing",
    "priority": "97",
    "specId": "notify-c5",
    "supplierId": "supplier1"
  },
  "notify-standard": {
    "billingId": "notify-c5-billing",
    "priority": "98",
    "specId": "notify-c5",
    "supplierId": "supplier1"
  },
  "notify-standard-colour": {
    "billingId": "notify-c5-colour-billing",
    "priority": "99",
    "specId": "notify-c5-colour",
    "supplierId": "supplier1"
  }
}
 no
log_level The log level to be used in lambda functions within the component. Any log with a lower severity than the configured value will not be logged: https://docs.python.org/3/library/logging.html#levels string "INFO" no
log_retention_in_days The retention period in days for the Cloudwatch Logs events to be retained, default of 0 is indefinite number 0 no
manually_configure_mtls_truststore Manually manage the truststore used for API Gateway mTLS (e.g. for prod environment) bool false no
max_get_limit Default limit to apply to GET requests that support pagination number 2500 no
parent_acct_environment Name of the environment responsible for the acct resources used, affects things like DNS zone. Useful for named dev environments string "main" no
project The name of the tfscaffold project string n/a yes
region The AWS Region string n/a yes
shared_infra_account_id The AWS Account ID of the shared infrastructure account string "000000000000" no
sns_success_logging_sample_percent Enable SNS Delivery Successful Sample Percentage number 0 no

Modules

Name Source Version
amendment_event_transformer https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
amendments_queue https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip n/a
authorizer_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
ddb_alarms_letter_queue ../../modules/alarms-ddb n/a
ddb_alarms_letters ../../modules/alarms-ddb n/a
ddb_alarms_mi ../../modules/alarms-ddb n/a
ddb_alarms_suppliers ../../modules/alarms-ddb n/a
domain_truststore https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-s3bucket.zip n/a
eventpub https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-eventpub.zip n/a
eventsub ../../modules/eventsub n/a
get_letter https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
get_letter_data https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
get_letters https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
get_mi https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
get_status https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
kms https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-kms.zip n/a
lambda_alarms ../../modules/alarms-lambda n/a
letter_status_updates_queue https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip n/a
letter_updates_transformer https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
mi_updates_transformer https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip n/a
patch_letter https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
post_letters https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
post_mi https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
s3bucket_test_letters https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-s3bucket.zip n/a
sqs_alarms ../../modules/alarms-sqs n/a
sqs_letter_updates https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip n/a
sqs_supplier_allocator https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/3.0.6/terraform-sqs.zip n/a
supplier_allocator https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
supplier_ssl https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-ssl.zip n/a
update_letter_queue https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a
upsert_letter https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip n/a

Outputs

Name Description
api_urll n/a
deployment Deployment details used for post-deployment scripts