Package software.amazon.awscdk.services.cloudwatch

Class CfnMetricStream.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.CfnMetricStream.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMetricStream>

Enclosing class:

CfnMetricStream

@Stability(Stable)
public static final class CfnMetricStream.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMetricStream>

A fluent builder for CfnMetricStream.

Method Summary

Modifier and Type	Method	Description
CfnMetricStream	build()
static CfnMetricStream.Builder	create(software.constructs.Construct scope, String id)
CfnMetricStream.Builder	excludeFilters(List<? extends Object> excludeFilters)	If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
CfnMetricStream.Builder	excludeFilters(IResolvable excludeFilters)	If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
CfnMetricStream.Builder	firehoseArn(String firehoseArn)	The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
CfnMetricStream.Builder	includeFilters(List<? extends Object> includeFilters)	If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
CfnMetricStream.Builder	includeFilters(IResolvable includeFilters)	If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
CfnMetricStream.Builder	includeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics)	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.
CfnMetricStream.Builder	includeLinkedAccountsMetrics(IResolvable includeLinkedAccountsMetrics)	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.
CfnMetricStream.Builder	name(String name)	If you are creating a new metric stream, this is the name for the new stream.
CfnMetricStream.Builder	outputFormat(String outputFormat)	The output format for the stream.
CfnMetricStream.Builder	roleArn(String roleArn)	The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
CfnMetricStream.Builder	statisticsConfigurations(List<? extends Object> statisticsConfigurations)	By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
CfnMetricStream.Builder	statisticsConfigurations(IResolvable statisticsConfigurations)	By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
CfnMetricStream.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to the metric stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnMetricStream.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnMetricStream.Builder.

firehoseArn

@Stability(Stable)
public CfnMetricStream.Builder firehoseArn(String firehoseArn)

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.

Parameters:

firehoseArn - The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This parameter is required.

Returns:

this

See Also:

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

outputFormat

@Stability(Stable)
public CfnMetricStream.Builder outputFormat(String outputFormat)

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.

Parameters:

outputFormat - The output format for the stream. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnMetricStream.Builder roleArn(String roleArn)

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.

Parameters:

roleArn - The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This parameter is required.

Returns:

this

See Also:

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

excludeFilters

@Stability(Stable)
public CfnMetricStream.Builder excludeFilters(IResolvable excludeFilters)

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.

Parameters:

excludeFilters - If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. This parameter is required.

Returns:

this

See Also:

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

excludeFilters

@Stability(Stable)
public CfnMetricStream.Builder excludeFilters(List<? extends Object> excludeFilters)

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.

Parameters:

excludeFilters - If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. This parameter is required.

Returns:

this

See Also:

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

includeFilters

@Stability(Stable)
public CfnMetricStream.Builder includeFilters(IResolvable includeFilters)

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.

Parameters:

includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. This parameter is required.

Returns:

this

See Also:

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

includeFilters

@Stability(Stable)
public CfnMetricStream.Builder includeFilters(List<? extends Object> includeFilters)

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.

Parameters:

includeFilters - If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. This parameter is required.

Returns:

this

See Also:

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

includeLinkedAccountsMetrics

@Stability(Stable)
public CfnMetricStream.Builder includeLinkedAccountsMetrics(Boolean includeLinkedAccountsMetrics)

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

Parameters:

includeLinkedAccountsMetrics - 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. This parameter is required.

Returns:

this

See Also:

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

includeLinkedAccountsMetrics

@Stability(Stable)
public CfnMetricStream.Builder includeLinkedAccountsMetrics(IResolvable includeLinkedAccountsMetrics)

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

Parameters:

includeLinkedAccountsMetrics - 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. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnMetricStream.Builder name(String name)

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.

Parameters:

name - If you are creating a new metric stream, this is the name for the new stream. This parameter is required.

Returns:

this

See Also:

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

statisticsConfigurations

@Stability(Stable)
public CfnMetricStream.Builder statisticsConfigurations(IResolvable statisticsConfigurations)

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.

Parameters:

statisticsConfigurations - By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. This parameter is required.

Returns:

this

See Also:

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

statisticsConfigurations

@Stability(Stable)
public CfnMetricStream.Builder statisticsConfigurations(List<? extends Object> statisticsConfigurations)

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.

Parameters:

statisticsConfigurations - By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnMetricStream.Builder tags(List<? extends CfnTag> tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to the metric stream. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnMetricStream build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnMetricStream>

Returns:

a newly built instance of CfnMetricStream.