You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: infrastructure/terraform/components/api/README.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,13 @@ No requirements.
20
20
| <aname="input_enable_alarms"></a> [enable\_alarms](#input\_enable\_alarms)| Enable CloudWatch alarms for this deployed environment |`bool`|`true`| no |
21
21
| <aname="input_enable_api_data_trace"></a> [enable\_api\_data\_trace](#input\_enable\_api\_data\_trace)| Enable API Gateway data trace logging |`bool`|`false`| no |
22
22
| <aname="input_enable_backups"></a> [enable\_backups](#input\_enable\_backups)| Enable backups |`bool`|`false`| no |
23
+
| <aname="input_enable_event_anomaly_detection"></a> [enable\_event\_anomaly\_detection](#input\_enable\_event\_anomaly\_detection)| Enable CloudWatch anomaly detection alarm for SNS message Detects abnormal drops or spikes in event publishing volume. |`bool`|`true`| no |
23
24
| <aname="input_enable_event_cache"></a> [enable\_event\_cache](#input\_enable\_event\_cache)| Enable caching of events to an S3 bucket |`bool`|`true`| no |
| <aname="input_environment"></a> [environment](#input\_environment)| The name of the tfscaffold environment |`string`| n/a | yes |
27
+
| <aname="input_event_anomaly_band_width"></a> [event\_anomaly\_band\_width](#input\_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 |
28
+
| <aname="input_event_anomaly_evaluation_periods"></a> [event\_anomaly\_evaluation\_periods](#input\_event\_anomaly\_evaluation\_periods)| Number of evaluation periods for the anomaly alarm. Each period is defined by event\_anomaly\_period. |`number`|`3`| no |
29
+
| <aname="input_event_anomaly_period"></a> [event\_anomaly\_period](#input\_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 |
26
30
| <aname="input_eventpub_control_plane_bus_arn"></a> [eventpub\_control\_plane\_bus\_arn](#input\_eventpub\_control\_plane\_bus\_arn)| ARN of the EventBridge control plane bus for eventpub |`string`|`""`| no |
27
31
| <aname="input_eventpub_data_plane_bus_arn"></a> [eventpub\_data\_plane\_bus\_arn](#input\_eventpub\_data\_plane\_bus\_arn)| ARN of the EventBridge data plane bus for eventpub |`string`|`""`| no |
28
32
| <aname="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy)| Flag to force deletion of S3 buckets |`bool`|`false`| no |
Copy file name to clipboardExpand all lines: infrastructure/terraform/components/api/variables.tf
+24Lines changed: 24 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -199,3 +199,27 @@ variable "enable_alarms" {
199
199
description="Enable CloudWatch alarms for this deployed environment"
200
200
default=true
201
201
}
202
+
203
+
variable"enable_event_anomaly_detection" {
204
+
type=bool
205
+
description="Enable CloudWatch anomaly detection alarm for SNS message Detects abnormal drops or spikes in event publishing volume."
206
+
default=true
207
+
}
208
+
209
+
variable"event_anomaly_evaluation_periods" {
210
+
type=number
211
+
description="Number of evaluation periods for the anomaly alarm. Each period is defined by event_anomaly_period."
212
+
default=3
213
+
}
214
+
215
+
variable"event_anomaly_period" {
216
+
type=number
217
+
description="The period in seconds over which the specified statistic is applied for anomaly detection. Minimum 300 seconds (5 minutes). Recommended: 300-600."
218
+
default=300
219
+
}
220
+
221
+
variable"event_anomaly_band_width" {
222
+
type=number
223
+
description="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."
Copy file name to clipboardExpand all lines: infrastructure/terraform/modules/eventsub/README.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,10 +15,14 @@
15
15
| <aname="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id)| The AWS Account ID (numeric) |`string`| n/a | yes |
16
16
| <aname="input_component"></a> [component](#input\_component)| The name of the terraformscaffold component calling this module |`string`| n/a | yes |
17
17
| <aname="input_default_tags"></a> [default\_tags](#input\_default\_tags)| Default tag map for application to all taggable resources in the module |`map(string)`|`{}`| no |
18
+
| <aname="input_enable_event_anomaly_detection"></a> [enable\_event\_anomaly\_detection](#input\_enable\_event\_anomaly\_detection)| Enable CloudWatch anomaly detection alarm for SNS topic message publishing |`bool`|`true`| no |
18
19
| <aname="input_enable_event_cache"></a> [enable\_event\_cache](#input\_enable\_event\_cache)| Enable caching of events to an S3 bucket |`bool`|`true`| no |
19
20
| <aname="input_enable_firehose_raw_message_delivery"></a> [enable\_firehose\_raw\_message\_delivery](#input\_enable\_firehose\_raw\_message\_delivery)| Enables raw message delivery on firehose subscription |`bool`|`false`| no |
| <aname="input_environment"></a> [environment](#input\_environment)| The name of the terraformscaffold environment the module is called for |`string`| n/a | yes |
23
+
| <aname="input_event_anomaly_band_width"></a> [event\_anomaly\_band\_width](#input\_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`|`3`| no |
24
+
| <aname="input_event_anomaly_evaluation_periods"></a> [event\_anomaly\_evaluation\_periods](#input\_event\_anomaly\_evaluation\_periods)| Number of evaluation periods for the anomaly alarm. Each period is defined by event\_anomaly\_period. |`number`|`2`| no |
25
+
| <aname="input_event_anomaly_period"></a> [event\_anomaly\_period](#input\_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 |
22
26
| <aname="input_event_cache_buffer_interval"></a> [event\_cache\_buffer\_interval](#input\_event\_cache\_buffer\_interval)| The buffer interval for data firehose |`number`|`500`| no |
23
27
| <aname="input_event_cache_expiry_days"></a> [event\_cache\_expiry\_days](#input\_event\_cache\_expiry\_days)| s3 archiving expiry in days |`number`|`30`| no |
24
28
| <aname="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy)| When enabled will force destroy event-cache S3 bucket |`bool`|`false`| no |
0 commit comments