Interface IMetricConfig

SecurityConfig / CloudWatchConfig / MetricSetConfig / MetricConfig

Description

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
interface IMetricConfig {
    filterName: string;
    filterPattern: string;
    logGroupName: string;
    metricName: string;
    metricNamespace: string;
    metricValue: string;
    treatMissingData?: string;
}

Properties

filterName filterPattern logGroupName metricName metricNamespace metricValue treatMissingData?

Properties

ReadonlyfilterName

filterName: string

Metric filter name

ReadonlyfilterPattern

filterPattern: string

Pattern to search for log events.

ReadonlylogGroupName

logGroupName: string

The log group to create the filter on.

ReadonlymetricName

metricName: string

The name of the metric to emit.

ReadonlymetricNamespace

metricNamespace: string

The namespace of the metric to emit.

ReadonlymetricValue

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.

Remarks

Note: 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'.

Optional ReadonlytreatMissingData

treatMissingData?: string

Sets how this alarm is to handle missing data points.

Settings

Member Visibility

On This Page

Properties