software.amazon.awscdk.services.cloudwatch

Class CfnMetricStream

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cloudwatch.CfnMetricStream

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.255Z")
 @Stability(value=Stable)
public class CfnMetricStream
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudWatch::MetricStream`.

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.services.cloudwatch.*;
 CfnMetricStream cfnMetricStream = CfnMetricStream.Builder.create(this, "MyCfnMetricStream")
         .firehoseArn("firehoseArn")
         .outputFormat("outputFormat")
         .roleArn("roleArn")
         // the properties below are optional
         .excludeFilters(List.of(MetricStreamFilterProperty.builder()
                 .namespace("namespace")
                 .build()))
         .includeFilters(List.of(MetricStreamFilterProperty.builder()
                 .namespace("namespace")
                 .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	Class and Description
static class	CfnMetricStream.Builder A fluent builder for CfnMetricStream.
static interface	CfnMetricStream.MetricStreamFilterProperty This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.
static interface	CfnMetricStream.MetricStreamStatisticsConfigurationProperty This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for.
static interface	CfnMetricStream.MetricStreamStatisticsMetricProperty A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMetricStream(Construct scope, String id, CfnMetricStreamProps props) Create a new `AWS::CloudWatch::MetricStream`.
protected	CfnMetricStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMetricStream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the metric stream.
String	getAttrCreationDate() The date that the metric stream was originally created.
String	getAttrLastUpdateDate() The date that the metric stream was most recently updated.
String	getAttrState() The state of the metric stream, either `running` or `stopped` .
protected Map<String,Object>	getCfnProperties()
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.
Object	getIncludeFilters() If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
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.
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.
Object	getStatisticsConfigurations() By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
TagManager	getTags() An array of key-value pairs to apply to the metric stream.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setExcludeFilters(IResolvable value) If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
void	setExcludeFilters(List<Object> value) If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
void	setFirehoseArn(String value) The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
void	setIncludeFilters(IResolvable value) If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
void	setIncludeFilters(List<Object> value) If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
void	setIncludeLinkedAccountsMetrics(Boolean value) 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.
void	setIncludeLinkedAccountsMetrics(IResolvable value) 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.
void	setName(String value) If you are creating a new metric stream, this is the name for the new stream.
void	setOutputFormat(String value) The output format for the stream.
void	setRoleArn(String value) The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
void	setStatisticsConfigurations(IResolvable value) By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
void	setStatisticsConfigurations(List<Object> value) By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMetricStream

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

CfnMetricStream

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

CfnMetricStream

@Stability(value=Stable)
public CfnMetricStream(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnMetricStreamProps props)

Create a new `AWS::CloudWatch::MetricStream`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the metric stream.

getAttrCreationDate

@Stability(value=Stable)
 @NotNull
public String getAttrCreationDate()

The date that the metric stream was originally created.

getAttrLastUpdateDate

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdateDate()

The date that the metric stream was most recently updated.

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

The state of the metric stream, either `running` or `stopped` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getFirehoseArn

@Stability(value=Stable)
 @NotNull
public 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.

setFirehoseArn

@Stability(value=Stable)
public void setFirehoseArn(@NotNull
                                                    String value)

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(value=Stable)
 @NotNull
public 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.

setOutputFormat

@Stability(value=Stable)
public void setOutputFormat(@NotNull
                                                     String value)

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(value=Stable)
 @NotNull
public 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.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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(value=Stable)
 @Nullable
public 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.

setExcludeFilters

@Stability(value=Stable)
public void setExcludeFilters(@Nullable
                                                       IResolvable value)

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.

setExcludeFilters

@Stability(value=Stable)
public void setExcludeFilters(@Nullable
                                                       List<Object> value)

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(value=Stable)
 @Nullable
public 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.

setIncludeFilters

@Stability(value=Stable)
public void setIncludeFilters(@Nullable
                                                       IResolvable value)

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.

setIncludeFilters

@Stability(value=Stable)
public void setIncludeFilters(@Nullable
                                                       List<Object> value)

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(value=Stable)
 @Nullable
public 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

setIncludeLinkedAccountsMetrics

@Stability(value=Stable)
public void setIncludeLinkedAccountsMetrics(@Nullable
                                                                     Boolean value)

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

setIncludeLinkedAccountsMetrics

@Stability(value=Stable)
public void setIncludeLinkedAccountsMetrics(@Nullable
                                                                     IResolvable value)

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(value=Stable)
 @Nullable
public 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.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

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(value=Stable)
 @Nullable
public 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??) .

setStatisticsConfigurations

@Stability(value=Stable)
public void setStatisticsConfigurations(@Nullable
                                                                 IResolvable value)

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??) .

setStatisticsConfigurations

@Stability(value=Stable)
public void setStatisticsConfigurations(@Nullable
                                                                 List<Object> value)

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??) .