Package software.amazon.awscdk.services.cloudwatch

Interface LogQueryWidgetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LogQueryWidgetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-24T11:33:10.784Z")
@Stability(Stable)
public interface LogQueryWidgetProps
extends software.amazon.jsii.JsiiSerializable

Properties for a Query widget.

Example:

 Dashboard dashboard;
 dashboard.addWidgets(LogQueryWidget.Builder.create()
         .logGroupNames(List.of("my-log-group"))
         .view(LogQueryVisualizationType.TABLE)
         // The lines will be automatically combined using '\n|'.
         .queryLines(List.of("fields @message", "filter @message like /Error/"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LogQueryWidgetProps.Builder	A builder for LogQueryWidgetProps
static final class	LogQueryWidgetProps.Jsii$Proxy	An implementation for LogQueryWidgetProps

Method Summary

Modifier and Type	Method	Description
static LogQueryWidgetProps.Builder	builder()
default String	getAccountId()	The AWS account ID where the log groups are located.
default Number	getHeight()	Height of the widget.
List<String>	getLogGroupNames()	Names of log groups to query.
default LogQueryLanguage	getQueryLanguage()	The query language to use for the query.
default List<String>	getQueryLines()	A sequence of lines to use to build the query.
default String	getQueryString()	Full query string for log insights.
default String	getRegion()	The region the metrics of this widget should be taken from.
default String	getTitle()	Title for the widget.
default LogQueryVisualizationType	getView()	The type of view to use.
default Number	getWidth()	Width of the widget, in a grid of 24 units wide.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogGroupNames

@Stability(Stable)
@NotNull
List<String> getLogGroupNames()

Names of log groups to query.

getAccountId

@Stability(Stable)
@Nullable
default String getAccountId()

The AWS account ID where the log groups are located.

This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

Default: - Current account

getHeight

@Stability(Stable)
@Nullable
default Number getHeight()

Height of the widget.

Default: 6

getQueryLanguage

@Stability(Stable)
@Nullable
default LogQueryLanguage getQueryLanguage()

The query language to use for the query.

Default: LogQueryLanguage.LOGS_INSIGHTS

getQueryLines

@Stability(Stable)
@Nullable
default List<String> getQueryLines()

A sequence of lines to use to build the query.

The query will be built by joining the lines together using \n|.

Default: - Exactly one of `queryString`, `queryLines` is required.

getQueryString

@Stability(Stable)
@Nullable
default String getQueryString()

Full query string for log insights.

Be sure to prepend every new line with a newline and pipe character (\n|).

Default: - Exactly one of `queryString`, `queryLines` is required.

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

The region the metrics of this widget should be taken from.

Default: Current region

getTitle

@Stability(Stable)
@Nullable
default String getTitle()

Title for the widget.

Default: No title

getView

@Stability(Stable)
@Nullable
default LogQueryVisualizationType getView()

The type of view to use.

Default: LogQueryVisualizationType.TABLE

getWidth

@Stability(Stable)
@Nullable
default Number getWidth()

Width of the widget, in a grid of 24 units wide.

Default: 6

builder

@Stability(Stable)
static LogQueryWidgetProps.Builder builder()

Returns:

a LogQueryWidgetProps.Builder of LogQueryWidgetProps