Package software.amazon.awscdk.services.cloudwatch

Interface CfnMetricStream.MetricStreamFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMetricStream.MetricStreamFilterProperty.Jsii$Proxy

Enclosing class:

CfnMetricStream

@Stability(Stable)
public static interface CfnMetricStream.MetricStreamFilterProperty
extends software.amazon.jsii.JsiiSerializable

This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric ' stream or exclude from a metric stream.

A metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.

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.*;
 MetricStreamFilterProperty metricStreamFilterProperty = MetricStreamFilterProperty.builder()
         .namespace("namespace")
         // the properties below are optional
         .metricNames(List.of("metricNames"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMetricStream.MetricStreamFilterProperty.Builder	builder()
default List<String>	getMetricNames()	The names of the metrics to either include or exclude from the metric stream.
String	getNamespace()	The name of the metric namespace in the filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNamespace

@Stability(Stable)
@NotNull
String getNamespace()

The name of the metric namespace in the filter.

The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html#cfn-cloudwatch-metricstream-metricstreamfilter-namespace

getMetricNames

@Stability(Stable)
@Nullable
default List<String> getMetricNames()

The names of the metrics to either include or exclude from the metric stream.

If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.

Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html#cfn-cloudwatch-metricstream-metricstreamfilter-metricnames

builder

@Stability(Stable)
static CfnMetricStream.MetricStreamFilterProperty.Builder builder()

Returns:

a CfnMetricStream.MetricStreamFilterProperty.Builder of CfnMetricStream.MetricStreamFilterProperty