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

Class CfnMetricStreamPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cloudwatch.CfnMetricStreamPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.207Z") @Stability(Stable) public class CfnMetricStreamPropsMixin extends Mixin implements software.constructs.IMixin
Creates or updates a metric stream.

Metrics streams can automatically stream CloudWatch metrics to AWS destinations including Amazon S3 and to many third-party solutions. For more information, see Metric streams .

To create a metric stream, you must be logged on to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission.

When you create or update a metric stream, you choose one of the following:

  • Stream metrics from all metric namespaces in the account.
  • Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters .
  • Stream metrics from only the metric namespaces that you list in IncludeFilters .

When you create a metric stream, the stream is created in the running state. If you update an existing metric stream, the state does not change.

If you create a metric stream in an account that has been set up as a monitoring account in CloudWatch cross-account observability, you can choose whether to include metrics from linked source accounts in the metric stream.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnMetricStreamPropsMixin cfnMetricStreamPropsMixin = CfnMetricStreamPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnMetricStreamPropsMixin

      protected CfnMetricStreamPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMetricStreamPropsMixin

      protected CfnMetricStreamPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMetricStreamPropsMixin

      @Stability(Stable) public CfnMetricStreamPropsMixin(@NotNull CfnMetricStreamMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudWatch::MetricStream.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnMetricStreamPropsMixin

      @Stability(Stable) public CfnMetricStreamPropsMixin(@NotNull CfnMetricStreamMixinProps props)
      Create a mixin to apply properties to AWS::CloudWatch::MetricStream.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnMetricStreamMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()