AWS CDK Reference

Appearance

v2.275.0

CfnMetricStreamProps Struct ​

Properties for defining a CfnMetricStream.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const cfnMetricStreamProps: cloudwatch.CfnMetricStreamProps = {
  firehoseArn: 'firehoseArn',
  outputFormat: 'outputFormat',
  roleArn: 'roleArn',

  // the properties below are optional
  excludeFilters: [{
    namespace: 'namespace',

    // the properties below are optional
    metricNames: ['metricNames'],
  }],
  includeFilters: [{
    namespace: 'namespace',

    // the properties below are optional
    metricNames: ['metricNames'],
  }],
  includeLinkedAccountsMetrics: false,
  name: 'name',
  statisticsConfigurations: [{
    additionalStatistics: ['additionalStatistics'],
    includeMetrics: [{
      metricName: 'metricName',
      namespace: 'namespace',
    }],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

excludeFiltersoptionalIResolvable | IResolvable | CfnMetricStream.MetricStreamFilterProperty[]exclude_filtersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricStreamFilterProperty]]]excludeFiltersoptionalIResolvableExcludeFiltersoptionalIResolvableExcludeFiltersoptionalinterface{}#
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
notes

You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

firehoseArnstring | IDeliveryStreamReffirehose_arntyping.Union[str, IDeliveryStreamRef]firehoseArnStringFirehoseArnstringFirehoseArninterface{}required#
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.

This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.

includeFiltersoptionalIResolvable | IResolvable | CfnMetricStream.MetricStreamFilterProperty[]include_filtersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricStreamFilterProperty]]]includeFiltersoptionalIResolvableIncludeFiltersoptionalIResolvableIncludeFiltersoptionalinterface{}#
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
notes

You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

When you modify the IncludeFilters or ExcludeFilters of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.

includeLinkedAccountsMetricsoptionalboolean | IResolvableinclude_linked_accounts_metricsoptionaltyping.Union[bool, IResolvable]includeLinkedAccountsMetricsoptionalBooleanIncludeLinkedAccountsMetricsoptionalboolIncludeLinkedAccountsMetricsoptionalinterface{}#
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 .

For more information about linking accounts, see CloudWatch cross-account observability

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
If you are creating a new metric stream, this is the name for the new stream.

The name must be different than the names of other metric streams in this account and Region.

If you are updating a metric stream, specify the name of that stream here.

outputFormatstringoutput_formatstroutputFormatStringOutputFormatstringOutputFormat*stringrequired#
The output format for the stream.
notes

Valid values are json , opentelemetry1.0 and opentelemetry0.7 For more information about metric stream output formats, see Metric streams output formats .

This parameter is required.

roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}required#
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.

This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the firehose:PutRecord and firehose:PutRecordBatch permissions.

statisticsConfigurationsoptionalIResolvable | IResolvable | CfnMetricStream.MetricStreamStatisticsConfigurationProperty[]statistics_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricStreamStatisticsConfigurationProperty]]]statisticsConfigurationsoptionalIResolvableStatisticsConfigurationsoptionalIResolvableStatisticsConfigurationsoptionalinterface{}#
By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
notes

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.

For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat . If the OutputFormat is json , you can stream any additional statistic that is supported by CloudWatch , listed in CloudWatch statistics definitions . If the OutputFormat is OpenTelemetry, you can stream percentile statistics.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to the metric stream.

For more information, see Tag .