Skip to content

README.md

Latest commit

 

History

History
86 lines (81 loc) · 12 KB

README.md

File metadata and controls

86 lines (81 loc) · 12 KB

Requirements

No requirements.

Inputs

Name Description Type Default Required
aws_account_id The AWS Account ID (numeric) string n/a yes
cloudfront_distribution_arn ARN of the cloudfront distribution to serve files from string null no
cognito_config Cognito config 
object({
    USER_POOL_ID : string,
    USER_POOL_CLIENT_ID : string
  })
 n/a yes
component The variable encapsulating the name of this component string n/a yes
csi CSI from the parent component string n/a yes
email_domain Email domain string n/a yes
enable_backup Enable Backups for the DynamoDB table? bool true no
enable_event_stream Enable DynamoDB streaming to EventBridge bool true no
environment The name of the tfscaffold environment string n/a yes
function_s3_bucket Name of S3 bucket to upload lambda artefacts to string n/a yes
group The group variables are being inherited from (often synonmous with account short-name) string n/a yes
kms_key_arn KMS Key ARN string n/a yes
letter_suppliers Letter suppliers enabled in the environment 
map(object({
    email_addresses  = list(string)
    enable_polling   = bool
    default_supplier = optional(bool)
  }))
 n/a yes
log_destination_arn Destination ARN to use for the log subscription filter string "" 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
log_subscription_role_arn The ARN of the IAM role to use for the log subscription filter string "" no
module The variable encapsulating the name of this module string "api" no
parent_acct_environment Name of the environment responsible for the acct resources used string n/a yes
project The name of the tfscaffold project string n/a yes
proof_requested_sender_email_address Proof requested sender email address string n/a yes
region The AWS Region string n/a yes
send_to_firehose Flag indicating whether logs should be sent to firehose bool n/a yes
sns_topic_arn SNS topic ARN string null no
template_submitted_sender_email_address Template submitted sender email address string n/a yes

Modules

Name Source Version
authorizer_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
count_routing_configs_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
create_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
delete_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
get_client_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
get_routing_config_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
get_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_copy_scanned_object_to_internal https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_delete_failed_scanned_object https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_event_publisher https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_process_proof https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_set_file_virus_scan_status_for_upload https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_sftp_poll https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_sftp_request_proof https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
lambda_validate_letter_template_files https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
list_routing_configs_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
list_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
request_proof_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
s3bucket_download https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip n/a
s3bucket_internal https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip n/a
s3bucket_quarantine https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-s3bucket.zip n/a
sqs_sftp_upload https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-sqs.zip n/a
sqs_template_mgmt_events https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-sqs.zip n/a
sqs_template_table_events_pipe_dlq https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-sqs.zip n/a
sqs_validate_letter_template_files https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.20/terraform-sqs.zip n/a
submit_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
update_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a
upload_letter_template_lambda https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.22/terraform-lambda.zip n/a

Outputs

Name Description
api_base_url n/a
client_ssm_path_prefix n/a
download_bucket_name n/a
download_bucket_regional_domain_name n/a
internal_bucket_name n/a
quarantine_bucket_name n/a
request_proof_queue_url n/a
routing_config_table_name n/a
sftp_environment n/a
sftp_mock_credential_path n/a
sftp_poll_lambda_name n/a
templates_table_name n/a