interface CfnMetricStreamProps

Language	Type name
.NET	`Amazon.CDK.AWS.CloudWatch.CfnMetricStreamProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#CfnMetricStreamProps`
Java	`software.amazon.awscdk.services.cloudwatch.CfnMetricStreamProps`
Python	`aws_cdk.aws_cloudwatch.CfnMetricStreamProps`
TypeScript	`aws-cdk-lib` » `aws_cloudwatch` » `CfnMetricStreamProps`

Properties for defining a CfnMetricStream.

Example

// 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

Name	Type	Description
firehoseArn	`string`	The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
outputFormat	`string`	The output format for the stream.
roleArn	`string`	The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
excludeFilters?	`IResolvable` `\|` `IResolvable` `\|` `MetricStreamFilterProperty[]`	If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
includeFilters?	`IResolvable` `\|` `IResolvable` `\|` `MetricStreamFilterProperty[]`	If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
includeLinkedAccountsMetrics?	`boolean \|` `IResolvable`	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.
name?	`string`	If you are creating a new metric stream, this is the name for the new stream.
statisticsConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `MetricStreamStatisticsConfigurationProperty[]`	By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
tags?	`CfnTag[]`	An array of key-value pairs to apply to the metric stream.

firehoseArn

Type: string

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.

outputFormat

Type: string

The output format for the stream.

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.

roleArn

Type: string

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.

excludeFilters?

Type: IResolvable | IResolvable | MetricStreamFilterProperty[] (optional)

If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

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.

includeFilters?

Type: IResolvable | IResolvable | MetricStreamFilterProperty[] (optional)

If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

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

includeLinkedAccountsMetrics?

Type: boolean | IResolvable (optional)

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

name?

Type: string (optional)

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.

statisticsConfigurations?

Type: IResolvable | IResolvable | MetricStreamStatisticsConfigurationProperty[] (optional)

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.

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.

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to the metric stream.

For more information, see Tag .