AnnotationQueryBuilder🔗

Shape of a CloudWatch Annotation query

TS type is CloudWatchDefaultQuery = Omit & CloudWatchMetricsQuery, declared in veneer

CloudWatchDefaultQuery: #CloudWatchLogsQuery & #CloudWatchMetricsQuery @cuetsy(kind="type")🔗

Constructor🔗

new AnnotationQueryBuilder()

Methods🔗

build🔗

Builds the object.

public AnnotationQuery 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 AnnotationQueryBuilder accountId(String accountId)

actionPrefix🔗

Use this parameter to filter the results of the operation to only those alarms

that use a certain alarm action. For example, you could specify the ARN of

an SNS topic to find all alarms that send notifications to that topic.

e.g. arn:aws:sns:us-east-1:123456789012:my-app- would match arn:aws:sns:us-east-1:123456789012:my-app-action

but not match arn:aws:sns:us-east-1:123456789012:your-app-action

public AnnotationQueryBuilder actionPrefix(String actionPrefix)

alarmNamePrefix🔗

An alarm name prefix. If you specify this parameter, you receive information

about all alarms that have names that start with this prefix.

e.g. my-team-service- would match my-team-service-high-cpu but not match your-team-service-high-cpu

public AnnotationQueryBuilder alarmNamePrefix(String alarmNamePrefix)

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 AnnotationQueryBuilder datasource(DataSourceRef datasource)

dimensions🔗

The dimensions of the metric

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

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 AnnotationQueryBuilder hide(Boolean hide)

matchExact🔗

Only show metrics that exactly match all defined dimension names.

public AnnotationQueryBuilder matchExact(Boolean matchExact)

metricName🔗

Name of the metric

public AnnotationQueryBuilder metricName(String metricName)

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 AnnotationQueryBuilder 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 AnnotationQueryBuilder period(String period)

prefixMatching🔗

Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix

public AnnotationQueryBuilder prefixMatching(Boolean prefixMatching)

queryMode🔗

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

public AnnotationQueryBuilder queryMode(QueryMode queryMode)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public AnnotationQueryBuilder 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 AnnotationQueryBuilder refId(String refId)

region🔗

AWS region to query for the metric

public AnnotationQueryBuilder region(String region)

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 AnnotationQueryBuilder statistic(String statistic)

statistics🔗

@deprecated use statistic

public AnnotationQueryBuilder statistics(List<String> statistics)