Package software.amazon.awscdk.services.cloudwatch

Interface CfnMetricStreamProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnMetricStreamProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:24:56.218Z") @Stability(Stable) public interface CfnMetricStreamProps extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.cloudwatch.*;
 CfnMetricStreamProps cfnMetricStreamProps = CfnMetricStreamProps.builder()
         .firehoseArn("firehoseArn")
         .outputFormat("outputFormat")
         .roleArn("roleArn")
         // the properties below are optional
         .excludeFilters(List.of(MetricStreamFilterProperty.builder()
                 .namespace("namespace")
                 // the properties below are optional
                 .metricNames(List.of("metricNames"))
                 .build()))
         .includeFilters(List.of(MetricStreamFilterProperty.builder()
                 .namespace("namespace")
                 // the properties below are optional
                 .metricNames(List.of("metricNames"))
                 .build()))
         .includeLinkedAccountsMetrics(false)
         .name("name")
         .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:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnMetricStreamProps.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.
    String
    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.
    String
    getOutputFormat()
    The output format for the stream.
    String
    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