CloudWatchAnnotationQuery🔗

Constructor🔗

CloudWatchAnnotationQuery()

Methods🔗

build🔗

Builds the object.

def build() -> cloudwatch.CloudWatchAnnotationQuery

account_id🔗

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.

def account_id(account_id: str) -> typing.Self

action_prefix🔗

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

def action_prefix(action_prefix: str) -> typing.Self

alarm_name_prefix🔗

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

def alarm_name_prefix(alarm_name_prefix: str) -> typing.Self

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

def datasource(datasource: dashboard.DataSourceRef) -> typing.Self

dimensions🔗

The dimensions of the metric

def dimensions(dimensions: cloudwatch.Dimensions) -> typing.Self

hide🔗

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

def hide(hide: bool) -> typing.Self

match_exact🔗

Only show metrics that exactly match all defined dimension names.

def match_exact(match_exact: bool) -> typing.Self

metric_name🔗

Name of the metric

def metric_name(metric_name: str) -> typing.Self

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.

def namespace(namespace: str) -> typing.Self

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

def period(period: str) -> typing.Self

prefix_matching🔗

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

def prefix_matching(prefix_matching: bool) -> typing.Self

query_mode🔗

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

def query_mode(query_mode: cloudwatch.CloudWatchQueryMode) -> typing.Self

query_type🔗

Specify the query flavor

TODO make this required and give it a default

def query_type(query_type: str) -> typing.Self

ref_id🔗

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.

def ref_id(ref_id: str) -> typing.Self

region🔗

AWS region to query for the metric

def region(region: str) -> typing.Self

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.

def statistic(statistic: str) -> typing.Self

statistics🔗

@deprecated use statistic

def statistics(statistics: list[str]) -> typing.Self