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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:36.847Z")
@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();
 

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

Method Details

getFirehoseArn

@Stability(Stable)
@NotNull
String 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.

getOutputFormat

@Stability(Stable)
@NotNull
String getOutputFormat()

The output format for the stream.

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

This parameter is required.

getRoleArn

@Stability(Stable)
@NotNull
String 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.

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.

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.

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

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.

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 opentelemetry0 .7, you can stream percentile statistics (p??) .

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 .

builder

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

Returns:

a CfnMetricStreamProps.Builder of CfnMetricStreamProps