aws-cdk-lib.aws_cloudwatch.LogQueryWidget

class LogQueryWidget

LanguageType name
.NETAmazon.CDK.AWS.CloudWatch.LogQueryWidget
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#LogQueryWidget
Javasoftware.amazon.awscdk.services.cloudwatch.LogQueryWidget
Pythonaws_cdk.aws_cloudwatch.LogQueryWidget
TypeScript (source)aws-cdk-lib » aws_cloudwatch » LogQueryWidget

Implements IWidget

Extends ConcreteWidget

Display query results from Logs Insights.

Example

declare const dashboard: cloudwatch.Dashboard;

dashboard.addWidgets(new cloudwatch.LogQueryWidget({
  logGroupNames: ['my-log-group'],
  view: cloudwatch.LogQueryVisualizationType.TABLE,
  // The lines will be automatically combined using '\n|'.
  queryLines: [
    'fields @message',
    'filter @message like /Error/',
  ]
}));

Initializer

new LogQueryWidget(props: LogQueryWidgetProps)

Parameters

  • props LogQueryWidgetProps

Properties

NameTypeDescription
heightnumberThe amount of vertical grid units the widget will take up.
widthnumberThe amount of horizontal grid units the widget will take up.
warnings?string[]Any warnings that are produced as a result of putting together this widget.

height

Type: number

The amount of vertical grid units the widget will take up.


width

Type: number

The amount of horizontal grid units the widget will take up.


warnings?

Type: string[] (optional)

Any warnings that are produced as a result of putting together this widget.

Methods

NameDescription
position(x, y)Place the widget at a given position.
toJson()Return the widget JSON for use in the dashboard.

position(x, y)

public position(x: number, y: number): void

Parameters

  • x number
  • y number

Place the widget at a given position.


toJson()

public toJson(): any[]

Returns

  • any[]

Return the widget JSON for use in the dashboard.