CloudWatchMetricsQueryBuilder🔗

Constructor🔗

new CloudWatchMetricsQueryBuilder()

Methods🔗

build🔗

Builds the object.

public CloudWatchMetricsQuery 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.

public CloudWatchMetricsQueryBuilder accountId(String accountId)

alias🔗

Deprecated: use label

@deprecated use label

public CloudWatchMetricsQueryBuilder 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

public CloudWatchMetricsQueryBuilder datasource(DataSourceRef datasource)

dimensions🔗

The dimensions of the metric

public CloudWatchMetricsQueryBuilder dimensions(Map<String, StringOrArrayOfString> dimensions)

expression🔗

Math expression query

public CloudWatchMetricsQueryBuilder 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.

public CloudWatchMetricsQueryBuilder hide(Boolean 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.

public CloudWatchMetricsQueryBuilder 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.

public CloudWatchMetricsQueryBuilder label(String label)

matchExact🔗

Only show metrics that exactly match all defined dimension names.

public CloudWatchMetricsQueryBuilder matchExact(Boolean matchExact)

metricEditorMode🔗

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

public CloudWatchMetricsQueryBuilder metricEditorMode(MetricEditorMode metricEditorMode)

metricName🔗

Name of the metric

public CloudWatchMetricsQueryBuilder metricName(String metricName)

metricQueryType🔗

Whether to use a metric search or metric insights query

public CloudWatchMetricsQueryBuilder metricQueryType(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.

public CloudWatchMetricsQueryBuilder 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

public CloudWatchMetricsQueryBuilder period(String period)

queryMode🔗

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

public CloudWatchMetricsQueryBuilder queryMode(CloudWatchQueryMode queryMode)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public CloudWatchMetricsQueryBuilder 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.

public CloudWatchMetricsQueryBuilder refId(String refId)

region🔗

AWS region to query for the metric

public CloudWatchMetricsQueryBuilder 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.

public CloudWatchMetricsQueryBuilder sql(com.grafana.foundation.cog.Builder<SQLExpression> sql)

sqlExpression🔗

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

public CloudWatchMetricsQueryBuilder 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.

public CloudWatchMetricsQueryBuilder statistic(String statistic)

statistics🔗

@deprecated use statistic

public CloudWatchMetricsQueryBuilder statistics(List<String> statistics)

See also🔗

• CloudWatchMetricsQuery