AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CloudTrail::Dashboard

CfnDashboard

Creates a custom dashboard or the Highlights dashboard. - *Custom dashboards* - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule. - *Highlights dashboard* - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes the dashboard every 6 hours. To create the Highlights dashboard, you must set and enable a refresh schedule. CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudTrail must be granted permissions to run the `StartQuery` operation on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to each event data store. For more information, see [Example: Allow CloudTrail to run queries to populate a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-eds-dashboard) in the *AWS CloudTrail User Guide* . To set a refresh schedule, CloudTrail must be granted permissions to run the `StartDashboardRefresh` operation to refresh the dashboard on your behalf. To provide permissions, run the `PutResourcePolicy` operation to attach a resource-based policy to the dashboard. For more information, see [Resource-based policy example for a dashboard](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html#security_iam_resource-based-policy-examples-dashboards) in the *AWS CloudTrail User Guide* . For more information about dashboards, see [CloudTrail Lake dashboards](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-dashboard.html) in the *AWS CloudTrail User Guide* .

Import

import { CfnDashboard } from 'aws-cdk-lib/aws-cloudtrail';

Or use the module namespace:

import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail';
// cloudtrail.CfnDashboard

Properties

Configuration passed to the constructor as CfnDashboardProps.

nameOptional
string

The name of the dashboard. The name must be unique to your account. To create the Highlights dashboard, the name must be `AWSCloudTrail-Highlights` .

refreshScheduleOptional
IResolvable | RefreshScheduleProperty

The schedule for a dashboard refresh.

tagsOptional
CfnTag[]

A list of tags.

terminationProtectionEnabledOptional
boolean | IResolvable

Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

widgetsOptional
IResolvable | IResolvable | WidgetProperty[]

An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets. You do not need to specify widgets for the Highlights dashboard.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cloudtrail
CFN TypeAWS::CloudTrail::Dashboard
Properties5

External Links