Skip to content

CloudWatchLogsQuery🔗

Shape of a CloudWatch Logs query

Definition🔗

export interface CloudWatchLogsQuery {
    // Whether a query is a Metrics, Logs, or Annotations query
    queryMode: cloudwatch.CloudWatchQueryMode;
    id: string;
    // AWS region to query for the logs
    region: string;
    // The CloudWatch Logs Insights query to execute
    expression?: string;
    // Fields to group the results by, this field is automatically populated whenever the query is updated
    statsGroups?: string[];
    // Log groups to query
    logGroups?: cloudwatch.LogGroup[];
    // 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;
    // If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
    hide?: boolean;
    // Specify the query flavor
    // TODO make this required and give it a default
    queryType?: string;
    // @deprecated use logGroups
    logGroupNames?: string[];
    // 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?: dashboard.DataSourceRef;
    _implementsDataqueryVariant(): void;
}

Methods🔗

No methods.

See also🔗