Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetricConfig

SecurityConfig / CloudWatchConfig / MetricSetConfig / MetricConfig

AWS CloudWatch Metric configuration

example
- filterName: MetricFilter
  logGroupName: aws-controltower/CloudTrailLogs
  filterPattern: '{$.userIdentity.type="Root" && $.userIdentity.invokedBy NOT EXISTS && $.eventType !="AwsServiceEvent"}'
  metricNamespace: LogMetrics
  metricName: RootAccountUsage
  metricValue: "1"
  treatMissingData: notBreaching

Hierarchy

  • MetricConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly filterName

filterName: string = ''

Metric filter name

Readonly filterPattern

filterPattern: string = ''

Pattern to search for log events.

Readonly logGroupName

logGroupName: string = ''

The log group to create the filter on.

Readonly metricName

metricName: string = ''

The name of the metric to emit.

Readonly metricNamespace

metricNamespace: string = ''

The namespace of the metric to emit.

Readonly metricValue

metricValue: string = ''

The value to emit for the metric.

Can either be a literal number (typically “1”), or the name of a field in the structure to take the value from the matched event. If you are using a field value, the field value must have been matched using the pattern.

If you want to specify a field from a matched JSON structure, use '$.fieldName', and make sure the field is in the pattern (if only as '$.fieldName = *').

If you want to specify a field from a matched space-delimited structure, use '$fieldName'.

Readonly treatMissingData

treatMissingData: undefined | string = undefined

Sets how this alarm is to handle missing data points.

Generated using TypeDoc