Class LogQueryWidgetProps

Properties for a Query widget.

Inheritance

System.Object

LogQueryWidgetProps

Implements

ILogQueryWidgetProps

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.AWS.CloudWatch.dll

Syntax (csharp)

public class LogQueryWidgetProps : Object, ILogQueryWidgetProps

Syntax (vb)

Public Class LogQueryWidgetProps
    Inherits Object
    Implements ILogQueryWidgetProps

Remarks

ExampleMetadata: infused

Examples

Dashboard dashboard;


dashboard.AddWidgets(new LogQueryWidget(new LogQueryWidgetProps {
    LogGroupNames = new [] { "my-log-group" },
    View = LogQueryVisualizationType.TABLE,
    // The lines will be automatically combined using '\n|'.
    QueryLines = new [] { "fields @message", "filter @message like /Error/" }
}));

Synopsis

Constructors

LogQueryWidgetProps()

Properties

Height	Height of the widget.
LogGroupNames	Names of log groups to query.
QueryLines	A sequence of lines to use to build the query.
QueryString	Full query string for log insights.
Region	The region the metrics of this widget should be taken from.
Title	Title for the widget.
View	The type of view to use.
Width	Width of the widget, in a grid of 24 units wide.

Constructors

LogQueryWidgetProps()

public LogQueryWidgetProps()

Properties

Height

Height of the widget.

public Nullable<double> Height { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: 6

LogGroupNames

Names of log groups to query.

public string[] LogGroupNames { get; set; }

Property Value

System.String[]

QueryLines

A sequence of lines to use to build the query.

public string[] QueryLines { get; set; }

Property Value

System.String[]

Remarks

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

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

QueryString

Full query string for log insights.

public string QueryString { get; set; }

Property Value

System.String

Remarks

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

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

Region

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

public string Region { get; set; }

Property Value

System.String

Remarks

Default: Current region

Title

Title for the widget.

public string Title { get; set; }

Property Value

System.String

Remarks

Default: No title

View

The type of view to use.

public Nullable<LogQueryVisualizationType> View { get; set; }

Property Value

System.Nullable<LogQueryVisualizationType>

Remarks

Default: LogQueryVisualizationType.TABLE

Width

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

public Nullable<double> Width { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: 6

Implements

ILogQueryWidgetProps