metric_stream

Gets an individual metric_stream resource

Overview

Name	metric_stream
Type	Resource
Description	metric_stream
Id	awscc.cloudwatch.metric_stream

Fields

Name	Datatype	Description
arn	string	Amazon Resource Name of the metric stream.
creation_date	string	The date of creation of the metric stream.
exclude_filters	array	Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
firehose_arn	string	The ARN of the Kinesis Firehose where to stream the data.
include_filters	array	Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.
last_update_date	string	The date of the last update of the metric stream.
name	string	Name of the metric stream.
role_arn	string	The ARN of the role that provides access to the Kinesis Firehose.
state	string	Displays the state of the Metric Stream.
output_format	string	The output format of the data streamed to the Kinesis Firehose.
statistics_configurations	array	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.
tags	array	A set of tags to assign to the delivery stream.
include_linked_accounts_metrics	boolean	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.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
creation_date,
exclude_filters,
firehose_arn,
include_filters,
last_update_date,
name,
role_arn,
state,
output_format,
statistics_configurations,
tags,
include_linked_accounts_metrics
FROM awscc.cloudwatch.metric_stream
WHERE data__Identifier = '<Name>';

Permissions

To operate on the metric_stream resource, the following permissions are required:

Update

cloudwatch:PutMetricStream,
cloudwatch:GetMetricStream,
cloudwatch:TagResource,
cloudwatch:UntagResource,
iam:PassRole

Delete

cloudwatch:DeleteMetricStream,
cloudwatch:GetMetricStream

Read

cloudwatch:GetMetricStream