interface CfnDashboardProps

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

Properties for defining a CfnDashboard.

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 cfnDashboardProps: cloudtrail.CfnDashboardProps = {
  name: 'name',
  refreshSchedule: {
    frequency: {
      unit: 'unit',
      value: 123,
    },
    status: 'status',
    timeOfDay: 'timeOfDay',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  terminationProtectionEnabled: false,
  widgets: [{
    queryStatement: 'queryStatement',

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

Properties

Name	Type	Description
name?	`string`	The name of the dashboard. The name must be unique to your account.
refreshSchedule?	`IResolvable` `\|` `RefreshScheduleProperty`	The schedule for a dashboard refresh.
tags?	`CfnTag[]`	A list of tags.
terminationProtectionEnabled?	`boolean \|` `IResolvable`	Specifies whether termination protection is enabled for the dashboard.
widgets?	`IResolvable` `\| (IResolvable` `\|` `WidgetProperty)[]`	An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

name?

Type: string (optional)

The name of the dashboard. The name must be unique to your account.

To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights .

refreshSchedule?

Type: IResolvable | RefreshScheduleProperty (optional)

The schedule for a dashboard refresh.

tags?

Type: CfnTag[] (optional)

A list of tags.

terminationProtectionEnabled?

Type: boolean | IResolvable (optional)

Specifies whether termination protection is enabled for the dashboard.

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

widgets?

Type: IResolvable | (IResolvable | WidgetProperty)[] (optional)

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.