Package software.amazon.awscdk.cfnpropertymixins.services.cloudwatch

Interface CfnMetricStreamMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMetricStreamMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.205Z")
@Stability(Stable)
public interface CfnMetricStreamMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnMetricStreamPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.*;
 CfnMetricStreamMixinProps cfnMetricStreamMixinProps = CfnMetricStreamMixinProps.builder()
         .excludeFilters(List.of(MetricStreamFilterProperty.builder()
                 .metricNames(List.of("metricNames"))
                 .namespace("namespace")
                 .build()))
         .firehoseArn("firehoseArn")
         .includeFilters(List.of(MetricStreamFilterProperty.builder()
                 .metricNames(List.of("metricNames"))
                 .namespace("namespace")
                 .build()))
         .includeLinkedAccountsMetrics(false)
         .name("name")
         .outputFormat("outputFormat")
         .roleArn("roleArn")
         .statisticsConfigurations(List.of(MetricStreamStatisticsConfigurationProperty.builder()
                 .additionalStatistics(List.of("additionalStatistics"))
                 .includeMetrics(List.of(MetricStreamStatisticsMetricProperty.builder()
                         .metricName("metricName")
                         .namespace("namespace")
                         .build()))
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMetricStreamMixinProps.Builder	A builder for CfnMetricStreamMixinProps
static final class	CfnMetricStreamMixinProps.Jsii$Proxy	An implementation for CfnMetricStreamMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnMetricStreamMixinProps.Builder	builder()
default Object	getExcludeFilters()	If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
default Object	getFirehoseArn()	The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
default Object	getIncludeFilters()	If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
default Object	getIncludeLinkedAccountsMetrics()	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.
default String	getName()	If you are creating a new metric stream, this is the name for the new stream.
default String	getOutputFormat()	The output format for the stream.
default Object	getRoleArn()	The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
default Object	getStatisticsConfigurations()	By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to the metric stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExcludeFilters

@Stability(Stable)
@Nullable
default Object getExcludeFilters()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMetricStreamPropsMixin.MetricStreamFilterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-excludefilters

getFirehoseArn

@Stability(Stable)
@Nullable
default Object getFirehoseArn()

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.

Returns union: either String or IDeliveryStreamRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-firehosearn

getIncludeFilters

@Stability(Stable)
@Nullable
default Object getIncludeFilters()

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.

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMetricStreamPropsMixin.MetricStreamFilterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includefilters

getIncludeLinkedAccountsMetrics

@Stability(Stable)
@Nullable
default Object getIncludeLinkedAccountsMetrics()

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-includelinkedaccountsmetrics

getName

@Stability(Stable)
@Nullable
default String getName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-name

getOutputFormat

@Stability(Stable)
@Nullable
default String getOutputFormat()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-outputformat

getRoleArn

@Stability(Stable)
@Nullable
default Object getRoleArn()

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.

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-rolearn

getStatisticsConfigurations

@Stability(Stable)
@Nullable
default Object getStatisticsConfigurations()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMetricStreamPropsMixin.MetricStreamStatisticsConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-statisticsconfigurations

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html#cfn-cloudwatch-metricstream-tags

builder

@Stability(Stable)
static CfnMetricStreamMixinProps.Builder builder()

Returns:

a CfnMetricStreamMixinProps.Builder of CfnMetricStreamMixinProps