Class CfnMetricStreamMixinProps

Properties for CfnMetricStreamPropsMixin.

Inheritance

object

CfnMetricStreamMixinProps

Implements

ICfnMetricStreamMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.CloudWatch

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnMetricStreamMixinProps : ICfnMetricStreamMixinProps

Syntax (vb)

Public Class CfnMetricStreamMixinProps Implements ICfnMetricStreamMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.CloudWatch;

             var cfnMetricStreamMixinProps = new CfnMetricStreamMixinProps {
                 ExcludeFilters = new [] { new MetricStreamFilterProperty {
                     MetricNames = new [] { "metricNames" },
                     Namespace = "namespace"
                 } },
                 FirehoseArn = "firehoseArn",
                 IncludeFilters = new [] { new MetricStreamFilterProperty {
                     MetricNames = new [] { "metricNames" },
                     Namespace = "namespace"
                 } },
                 IncludeLinkedAccountsMetrics = false,
                 Name = "name",
                 OutputFormat = "outputFormat",
                 RoleArn = "roleArn",
                 StatisticsConfigurations = new [] { new MetricStreamStatisticsConfigurationProperty {
                     AdditionalStatistics = new [] { "additionalStatistics" },
                     IncludeMetrics = new [] { new MetricStreamStatisticsMetricProperty {
                         MetricName = "metricName",
                         Namespace = "namespace"
                     } }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnMetricStreamMixinProps()

Properties for CfnMetricStreamPropsMixin.

Properties

ExcludeFilters	If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
FirehoseArn	The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
IncludeFilters	If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
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.
Name	If you are creating a new metric stream, this is the name for the new stream.
OutputFormat	The output format for the stream.
RoleArn	The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
StatisticsConfigurations	By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
Tags	An array of key-value pairs to apply to the metric stream.

Constructors

CfnMetricStreamMixinProps()

Properties for CfnMetricStreamPropsMixin.

public CfnMetricStreamMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.CloudWatch;

             var cfnMetricStreamMixinProps = new CfnMetricStreamMixinProps {
                 ExcludeFilters = new [] { new MetricStreamFilterProperty {
                     MetricNames = new [] { "metricNames" },
                     Namespace = "namespace"
                 } },
                 FirehoseArn = "firehoseArn",
                 IncludeFilters = new [] { new MetricStreamFilterProperty {
                     MetricNames = new [] { "metricNames" },
                     Namespace = "namespace"
                 } },
                 IncludeLinkedAccountsMetrics = false,
                 Name = "name",
                 OutputFormat = "outputFormat",
                 RoleArn = "roleArn",
                 StatisticsConfigurations = new [] { new MetricStreamStatisticsConfigurationProperty {
                     AdditionalStatistics = new [] { "additionalStatistics" },
                     IncludeMetrics = new [] { new MetricStreamStatisticsMetricProperty {
                         MetricName = "metricName",
                         Namespace = "namespace"
                     } }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ExcludeFilters

If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

public object? ExcludeFilters { get; set; }

Property Value

object

Remarks

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.

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

Type union: either IResolvable or (either IResolvable or CfnMetricStreamPropsMixin.IMetricStreamFilterProperty)[]

FirehoseArn

The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.

public object? FirehoseArn { get; set; }

Property Value

object

Remarks

This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.

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

Type union: either string or IDeliveryStreamRef

IncludeFilters

If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

public object? IncludeFilters { get; set; }

Property Value

object

Remarks

You cannot specify both IncludeFilters and ExcludeFilters in the same metric stream.

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

Type union: either IResolvable or (either IResolvable or CfnMetricStreamPropsMixin.IMetricStreamFilterProperty)[]

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.

public object? IncludeLinkedAccountsMetrics { get; set; }

Property Value

object

Remarks

The default is false .

For more information about linking accounts, see CloudWatch cross-account observability

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

Type union: either bool or IResolvable

Name

If you are creating a new metric stream, this is the name for the new stream.

public string? Name { get; set; }

Property Value

string

Remarks

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.

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

OutputFormat

The output format for the stream.

public string? OutputFormat { get; set; }

Property Value

string

Remarks

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.

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

RoleArn

The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.

public object? RoleArn { get; set; }

Property Value

object

Remarks

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.

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

Type union: either string or IRoleRef

StatisticsConfigurations

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

public object? StatisticsConfigurations { get; set; }

Property Value

object

Remarks

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.

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

Type union: either IResolvable or (either IResolvable or CfnMetricStreamPropsMixin.IMetricStreamStatisticsConfigurationProperty)[]

Implements

ICfnMetricStreamMixinProps