Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-cloudwatch-metricstream.json
Parent schema serverless-framework-configuration
Type: object

Properties

FirehoseArn string | Aws_CF_FunctionString required

The ARN of the Kinesis Firehose where to stream the data.

RoleArn string | Aws_CF_FunctionString required

The ARN of the role that provides access to the Kinesis Firehose.

OutputFormat string | Aws_CF_FunctionString required

The output format of the data streamed to the Kinesis Firehose.

ExcludeFilters MetricStreamFilter[]

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

maxItems=1000uniqueItems=true
IncludeFilters MetricStreamFilter[]

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

maxItems=1000uniqueItems=true
Name string | Aws_CF_FunctionString

Name of the metric stream.

StatisticsConfigurations MetricStreamStatisticsConfiguration[]

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

maxItems=100uniqueItems=true
Tags Tag[]

A set of tags to assign to the delivery stream.

maxItems=50uniqueItems=true
IncludeLinkedAccountsMetrics boolean

If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default is false.

Any of

1. variant
2. variant
3. variant

Definitions

MetricStreamFilter object

This structure defines the metrics that will be streamed.

Namespace string | Aws_CF_FunctionString required

Only metrics with Namespace matching this value will be streamed.

MetricNames string[]

Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.

maxItems=999
MetricStreamStatisticsConfiguration object

This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.

AdditionalStatistics string[] required

The additional statistics to stream for the metrics listed in IncludeMetrics.

maxItems=20uniqueItems=true
IncludeMetrics MetricStreamStatisticsMetric[] required

An array that defines the metrics that are to have additional statistics streamed.

maxItems=100uniqueItems=true
MetricStreamStatisticsMetric object

A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.

MetricName string | Aws_CF_FunctionString required

The name of the metric.

Namespace string | Aws_CF_FunctionString required

The namespace of the metric.

Tag object

Metadata that you can assign to a Metric Stream, consisting of a key-value pair.

Key string | Aws_CF_FunctionString required

A unique identifier for the tag.

Value string | Aws_CF_FunctionString required

String which you can use to describe or define the tag.