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.98.0 (build 00b106d)", date="2024-05-08T21:35:04.083Z") @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());

  • Method Details

    • getLogGroupNames

      @Stability(Stable) @NotNull List<String> getLogGroupNames()
      Names of log groups to query.

    • getHeight

      @Stability(Stable) @Nullable default Number getHeight()
      Height of the widget.

      Default: 6

    • 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