MetricStreamArgs class
The set of arguments for MetricStream. The set of arguments for MetricStream.
Constructors
-
MetricStreamArgs({Input<
List< ? excludeFilters, required Input<MetricStreamExcludeFilter> ?>String> firehoseArn, Input<List< ? includeFilters, Input<MetricStreamIncludeFilter> ?>bool?> ? includeLinkedAccountsMetrics, Input<String?> ? name, Input<String?> ? namePrefix, required Input<String> outputFormat, Input<String?> ? region, required Input<String> roleArn, Input<List< ? statisticsConfigurations, Input<MetricStreamStatisticsConfiguration> ?>Map< ? tags})String, String> ?> -
Creates a new MetricStreamArgs.
excludeFiltersList 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 withincludeFilter.firehoseArnARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.includeFiltersList 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 withexcludeFilter.includeLinkedAccountsMetricsIf 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.nameFriendly name of the metric stream. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.namePrefixCreates a unique friendly name beginning with the specified prefix. Conflicts withname.outputFormatOutput format for the stream. Possible values arejson,opentelemetry0.7, andopentelemetry1.0. For more information about output formats, see Metric streams output formats.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnARN 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.statisticsConfigurationsFor 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'soutputFormat. If the OutputFormat isjson, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat isopentelemetry0.7oropentelemetry1.0, you can stream percentile statistics (p99 etc.). See details below.tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.const -
MetricStreamArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
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
-
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, andopentelemetry1.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
-
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 isjson, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat isopentelemetry0.7oropentelemetry1.0, you can stream percentile statistics (p99 etc.). See details below.final -
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.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