MetricStreamState class

Input properties used for looking up and filtering MetricStream resources.

Constructors

MetricStreamState({Input<String?>? arn, Input<String?>? creationDate, Input<List<MetricStreamExcludeFilter>?>? excludeFilters, Input<String?>? firehoseArn, Input<List<MetricStreamIncludeFilter>?>? includeFilters, Input<bool?>? includeLinkedAccountsMetrics, Input<String?>? lastUpdateDate, Input<String?>? name, Input<String?>? namePrefix, Input<String?>? outputFormat, Input<String?>? region, Input<String?>? roleArn, Input<String?>? state, Input<List<MetricStreamStatisticsConfiguration>?>? statisticsConfigurations, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll})
Creates a new MetricStreamState. arn ARN of the metric stream. creationDate Date and time in RFC3339 format that the metric stream was created. excludeFilters List of exclusive metric filters. If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces and the conditional metric names that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is excluded. Conflicts with includeFilter. firehoseArn ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. includeFilters List of inclusive metric filters. If you specify this parameter, the stream sends only the conditional metric names from the metric namespaces that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is included. Conflicts with excludeFilter. 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. lastUpdateDate Date and time in RFC3339 format that the metric stream was last updated. name Friendly name of the metric stream. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix. namePrefix Creates a unique friendly name beginning with the specified prefix. Conflicts with name. outputFormat Output format for the stream. Possible values are json, opentelemetry0.7, and opentelemetry1.0. For more information about output formats, see Metric streams output formats. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn ARN of the IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. For more information about role permissions, see Trust between CloudWatch and Kinesis Data Firehose. state State of the metric stream. Possible values are running and stopped. statisticsConfigurations 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 or opentelemetry1.0, you can stream percentile statistics (p99 etc.). See details below. tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
const
MetricStreamState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the metric stream.
final
creationDate → Input<String?>?
Date and time in RFC3339 format that the metric stream was created.
final
excludeFilters → Input<List<MetricStreamExcludeFilter>?>?
List of exclusive metric filters. If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces and the conditional metric names that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is excluded. Conflicts with includeFilter.
final
firehoseArn → Input<String?>?
ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
final
hashCode → int
The hash code for this object.
no setterinherited
includeFilters → Input<List<MetricStreamIncludeFilter>?>?
List of inclusive metric filters. If you specify this parameter, the stream sends only the conditional metric names from the metric namespaces that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is included. Conflicts with excludeFilter.
final
includeLinkedAccountsMetrics → Input<bool?>?
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.
final
lastUpdateDate → Input<String?>?
Date and time in RFC3339 format that the metric stream was last updated.
final
name → Input<String?>?
Friendly name of the metric stream. If omitted, the provider will assign a random, unique name. Conflicts with namePrefix.
final
namePrefix → Input<String?>?
Creates a unique friendly name beginning with the specified prefix. Conflicts with name.
final
outputFormat → Input<String?>?
Output format for the stream. Possible values are json, opentelemetry0.7, and opentelemetry1.0. For more information about output formats, see Metric streams output formats.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String?>?
ARN of the IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. For more information about role permissions, see Trust between CloudWatch and Kinesis Data Firehose.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → Input<String?>?
State of the metric stream. Possible values are running and stopped.
final
statisticsConfigurations → Input<List<MetricStreamStatisticsConfiguration>?>?
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 or opentelemetry1.0, you can stream percentile statistics (p99 etc.). See details below.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited