Requirements

Name Version
terraform >= 1.9.0

Inputs

Name Description Type Default Required
access_logging_bucket S3 Access logging bucket name. string "" no
additional_policies_for_event_cache_bucket A list of JSON policies to use to build the bucket policy list(string) [] no
aws_account_id The AWS Account ID (numeric) string n/a yes
component The name of the terraformscaffold component calling this module string n/a yes
control_plane_bus_arn Data plane event bus arn string n/a yes
data_plane_bus_arn Data plane event bus arn string n/a yes
default_tags Default tag map for application to all taggable resources in the module map(string) {} no
enable_event_anomaly_detection Enable CloudWatch anomaly detection alarm for SNS message publishing. Detects abnormal drops or spikes in event publishing volume. bool true no
enable_event_cache Enable caching of events to an S3 bucket bool false no
enable_firehose_raw_message_delivery Enables raw message delivery on firehose subscription bool false no
enable_sns_delivery_logging Enable SNS Delivery Failure Notifications bool false no
environment The name of the terraformscaffold environment the module is called for 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 5 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
event_cache_buffer_interval The buffer interval for data firehose number 500 no
event_cache_expiry_days s3 archiving expiry in days number 30 no
force_destroy When enabled will force destroy event-cache S3 bucket bool false no
group The name of the tfscaffold group string null no
iam_permissions_boundary_arn The ARN of the permissions boundary to use for the IAM role string null no
kms_key_arn KMS key arn to use for this function string n/a yes
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 "WARN" no
log_retention_in_days The retention period in days for the Cloudwatch Logs events generated by the lambda function number n/a yes
name A unique name to distinguish this module invocation from others within the same CSI scope string n/a yes
project The name of the terraformscaffold project calling the module string n/a yes
region The AWS Region string n/a yes
sns_success_logging_sample_percent Enable SNS Delivery Successful Sample Percentage number 0 no

Outputs

Name Description
publishing_anomaly_alarm CloudWatch anomaly detection alarm details for SNS publishing
s3_bucket_event_cache S3 Bucket ARN and Name for event cache
sns_topic SNS Topic ARN and Name