CloudWatchMetricsQueryBuilder🔗

Constructor🔗

new CloudWatchMetricsQueryBuilder()

Methods🔗

build🔗

Builds the object.

build()

accountId🔗

The ID of the AWS account to query for the metric, specifying all will query all accounts that the monitoring account is permitted to query.

accountId(string $accountId)

alias🔗

Deprecated: use label

@deprecated use label

alias(string $alias)

datasource🔗

For mixed data sources the selected datasource is on the query level.

For non mixed scenarios this is undefined.

TODO find a better way to do this ^ that's friendly to schema

TODO this shouldn't be unknown but DataSourceRef | null

datasource(\Grafana\Foundation\Dashboard\DataSourceRef $datasource)

dimensions🔗

The dimensions of the metric

@param array> $dimensions

dimensions(array $dimensions)

expression🔗

Math expression query

expression(string $expression)

hide🔗

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

hide(bool $hide)

id🔗

ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.

id(string $id)

label🔗

Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.

label(string $label)

matchExact🔗

Only show metrics that exactly match all defined dimension names.

matchExact(bool $matchExact)

metricEditorMode🔗

Whether to use the query builder or code editor to create the query

metricEditorMode(\Grafana\Foundation\Cloudwatch\MetricEditorMode $metricEditorMode)

metricName🔗

Name of the metric

metricName(string $metricName)

metricQueryType🔗

Whether to use a metric search or metric insights query

metricQueryType(\Grafana\Foundation\Cloudwatch\MetricQueryType $metricQueryType)

namespace🔗

A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.

namespace(string $namespace)

period🔗

The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes

period(string $period)

queryMode🔗

Whether a query is a Metrics, Logs, or Annotations query

queryMode(\Grafana\Foundation\Cloudwatch\CloudWatchQueryMode $queryMode)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

queryType(string $queryType)

refId🔗

A unique identifier for the query within the list of targets.

In server side expressions, the refId is used as a variable name to identify results.

By default, the UI will assign A->Z; however setting meaningful names may be useful.

refId(string $refId)

region🔗

AWS region to query for the metric

region(string $region)

sql🔗

When the metric query type is set to Insights and the metricEditorMode is set to Builder, this field is used to build up an object representation of a SQL query.

@param \Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Cloudwatch\SQLExpression> $sql

sql(\Grafana\Foundation\Cog\Builder $sql)

sqlExpression🔗

When the metric query type is set to Insights, this field is used to specify the query string.

sqlExpression(string $sqlExpression)

statistic🔗

Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.

statistic(string $statistic)

statistics🔗

@deprecated use statistic

@param array $statistics

statistics(array $statistics)