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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,13 +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 |
24
-
| <aname="input_enable_event_publishing_anomaly_detection"></a> [enable\_event\_publishing\_anomaly\_detection](#input\_enable\_event\_publishing\_anomaly\_detection)| Enable CloudWatch anomaly detection alarm for SNS message publishing. Detects abnormal drops or spikes in event publishing volume. |`bool`|`true`| no |
| <aname="input_environment"></a> [environment](#input\_environment)| The name of the tfscaffold environment |`string`| n/a | yes |
27
-
| <aname="input_event_publishing_anomaly_band_width"></a> [event\_publishing\_anomaly\_band\_width](#input\_event\_publishing\_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 |
28
-
| <aname="input_event_publishing_anomaly_evaluation_periods"></a> [event\_publishing\_anomaly\_evaluation\_periods](#input\_event\_publishing\_anomaly\_evaluation\_periods)| Number of evaluation periods for the publishing anomaly alarm. Each period is defined by event\_publishing\_anomaly\_period. |`number`|`3`| no |
29
-
| <aname="input_event_publishing_anomaly_period"></a> [event\_publishing\_anomaly\_period](#input\_event\_publishing\_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 |
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`|`5`| 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 |
30
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 |
31
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 |
32
32
| <aname="input_force_destroy"></a> [force\_destroy](#input\_force\_destroy)| Flag to force deletion of S3 buckets |`bool`|`false`| no |
description="Number of evaluation periods for the publishing anomaly alarm. Each period is defined by event_publishing_anomaly_period."
211
+
description="Number of evaluation periods for the anomaly alarm. Each period is defined by event_anomaly_period."
212
212
default=3
213
213
}
214
214
215
-
variable"event_publishing_anomaly_period" {
215
+
variable"event_anomaly_period" {
216
216
type=number
217
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
218
default=300
219
219
}
220
220
221
-
variable"event_publishing_anomaly_band_width" {
221
+
variable"event_anomaly_band_width" {
222
222
type=number
223
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."
0 commit comments