class Aws::CloudWatch::Types::PutMetricStreamInput
@note When making an API call, you may pass PutMetricStreamInput
data as a hash: { name: "MetricStreamName", # required include_filters: [ { namespace: "Namespace", }, ], exclude_filters: [ { namespace: "Namespace", }, ], firehose_arn: "AmazonResourceName", # required role_arn: "AmazonResourceName", # required output_format: "json", # required, accepts json, opentelemetry0.7 tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], }
@!attribute [rw] 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. Valid characters are A-Z, a-z, 0-9, "-" and "\_". @return [String]
@!attribute [rw] include_filters
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot include `IncludeFilters` and `ExcludeFilters` in the same operation. @return [Array<Types::MetricStreamFilter>]
@!attribute [rw] exclude_filters
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot include `ExcludeFilters` and `IncludeFilters` in the same operation. @return [Array<Types::MetricStreamFilter>]
@!attribute [rw] firehose_arn
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. @return [String]
@!attribute [rw] role_arn
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 following permissions: * firehose:PutRecord * firehose:PutRecordBatch @return [String]
@!attribute [rw] output_format
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][1]. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html @return [String]
@!attribute [rw] tags
A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use [TagResource][1] or [UntagResource][2]. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStreamInput AWS API Documentation
Constants
- SENSITIVE