MetricStream

cloudwatch.services.k8s.aws/v1alpha1

Metadata#

Spec#

excludeFilters:
  metricNames:
  - string
  namespace: string
firehoseARN: string
includeFilters:
  metricNames:
  - string
  namespace: string
includeLinkedAccountsMetrics: boolean
name: string
outputFormat: string
roleARN: string
statisticsConfigurations:
  additionalStatistics:
  - string
  includeMetrics:
  - metricName: string
    namespace: string
tags:
- key: string
  value: string

A metric stream’s filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter. || excludeFilters.[].metricNames
Optional | array
| | excludeFilters.[].metricNames.[]
Required | string
|| excludeFilters.[].namespace
Optional | string
| | firehoseARN
Required | string
The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this
metric stream. This Amazon Kinesis Data Firehose delivery stream must already
exist and must be in the same account as the metric stream. | | includeFilters
Optional | array
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. | | includeFilters.[]
Required | object
This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric stream or exclude from a metric stream.

A metric stream’s filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter. || includeFilters.[].metricNames
Optional | array
| | includeFilters.[].metricNames.[]
Required | string
|| includeFilters.[].namespace
Optional | string
| | includeLinkedAccountsMetrics
Optional | boolean
If you are creating a metric stream in a monitoring account, specify true
to include metrics from source accounts in the metric stream. | | name
Required | string
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 “_”. | | outputFormat
Required | string
The output format for the stream. Valid values are json, opentelemetry1.0,
and opentelemetry0.7. For more information about metric stream output formats,
see Metric streams output formats (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html). | | roleARN
Required | string
The ARN of an IAM role that this metric stream will use to access Amazon
Kinesis Data 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 | | statisticsConfigurations
Optional | 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.

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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html).
If the OutputFormat is opentelemetry1.0 or opentelemetry0.7, you can stream
percentile statistics such as p95, p99.9, and so on. | | statisticsConfigurations.[]
Required | object
By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in CloudWatch statistics definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html). || statisticsConfigurations.[].additionalStatistics
Optional | array
| | statisticsConfigurations.[].additionalStatistics.[]
Required | string
|| statisticsConfigurations.[].includeMetrics
Optional | array
| | statisticsConfigurations.[].includeMetrics.[]
Required | object
This object contains the information for one metric that is to be streamed with additional statistics. || statisticsConfigurations.[].includeMetrics.[].metricName
Optional | string
| | statisticsConfigurations.[].includeMetrics.[].namespace
Optional | string
| | tags
Optional | array
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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html)
or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). | | tags.[]
Required | object
A key-value pair associated with a CloudWatch resource. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string