PutMetricStreamInput

AlarmsAwsDashboardsLogsMetricsMonitoringObservability

Properties

Name	Type	Description
Name	string	The name of the metric stream.
IncludeFilters	array	If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
ExcludeFilters	array	If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
FirehoseArn	string	The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream.
RoleArn	string	The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources.
OutputFormat	string	The output format for the stream.
Tags	array	A list of key-value pairs to associate with the metric stream.
IncludeLinkedAccountsMetrics	boolean	If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutMetricStreamInput",
  "title": "PutMetricStreamInput",
  "type": "object",
  "required": [
    "Name",
    "FirehoseArn",
    "RoleArn",
    "OutputFormat"
  ],
  "properties": {
    "Name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "The name of the metric stream.",
      "example": "Example Title"
    },
    "IncludeFilters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MetricStreamFilter"
      },
      "description": "If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.",
      "example": []
    },
    "ExcludeFilters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MetricStreamFilter"
      },
      "description": "If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.",
      "example": []
    },
    "FirehoseArn": {
      "type": "string",
      "description": "The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream.",
      "example": "example_value"
    },
    "RoleArn": {
      "type": "string",
      "description": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources.",
      "example": "example_value"
    },
    "OutputFormat": {
      "type": "string",
      "enum": [
        "json",
        "opentelemetry0.7",
        "opentelemetry1.0"
      ],
      "description": "The output format for the stream.",
      "example": "json"
    },
    "Tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Tag"
      },
      "description": "A list of key-value pairs to associate with the metric stream.",
      "example": []
    },
    "IncludeLinkedAccountsMetrics": {
      "type": "boolean",
      "description": "If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts.",
      "example": true
    }
  }
}