interface WidgetProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudTrail.CfnDashboard.WidgetProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudtrail#CfnDashboard_WidgetProperty`
Java	`software.amazon.awscdk.services.cloudtrail.CfnDashboard.WidgetProperty`
Python	`aws_cdk.aws_cloudtrail.CfnDashboard.WidgetProperty`
TypeScript	`aws-cdk-lib` » `aws_cloudtrail` » `CfnDashboard` » `WidgetProperty`

Contains information about a widget on a CloudTrail Lake dashboard.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudtrail as cloudtrail } from 'aws-cdk-lib';
const widgetProperty: cloudtrail.CfnDashboard.WidgetProperty = {
  queryStatement: 'queryStatement',

  // the properties below are optional
  queryParameters: ['queryParameters'],
  viewProperties: {
    viewPropertiesKey: 'viewProperties',
  },
};

Properties

Name	Type	Description
queryStatement	`string`	The query statement for the widget.
queryParameters?	`string[]`	The optional query parameters.
viewProperties?	`{ [string]: string } \|` `IResolvable`	The view properties for the widget.

queryStatement

Type: string

The query statement for the widget.

For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.

When a query uses ? with eventTime , ? must be surrounded by single quotes as follows: '?' .

queryParameters?

Type: string[] (optional)

The optional query parameters.

The following query parameters are valid: $StartTime$ , $EndTime$ , and $Period$ .

viewProperties?

Type: { [string]: string } | IResolvable (optional)

The view properties for the widget.

For more information about view properties, see View properties for widgets in the AWS CloudTrail User Guide .