class CfnDashboardPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudTrail.Mixins.CfnDashboardPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudtrail/mixins#CfnDashboardPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cloudtrail.mixins.CfnDashboardPropsMixin
Python	aws_cdk.mixins_preview.aws_cloudtrail.mixins.CfnDashboardPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cloudtrail » mixins » CfnDashboardPropsMixin

Implements IMixin

Extends Mixin

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 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 in the AWS CloudTrail User Guide .

For more information about dashboards, see CloudTrail Lake dashboards in the AWS CloudTrail User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cloudtrail_mixins } from '@aws-cdk/mixins-preview/aws-cloudtrail';
const cfnDashboardPropsMixin = new cloudtrail_mixins.CfnDashboardPropsMixin({
  name: 'name',
  refreshSchedule: {
    frequency: {
      unit: 'unit',
      value: 123,
    },
    status: 'status',
    timeOfDay: 'timeOfDay',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  terminationProtectionEnabled: false,
  widgets: [{
    queryParameters: ['queryParameters'],
    queryStatement: 'queryStatement',
    viewProperties: {
      viewPropertiesKey: 'viewProperties',
    },
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDashboardPropsMixin(props: CfnDashboardMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDashboardMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CloudTrail::Dashboard.

Properties

Name	Type	Description
props	CfnDashboardMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDashboardMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.