Package software.amazon.awscdk.cfnpropertymixins.services.cloudtrail

Class CfnDashboardPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cloudtrail.CfnDashboardPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.142Z") @Stability(Stable) public class CfnDashboardPropsMixin extends Mixin implements software.constructs.IMixin
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudtrail.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDashboardPropsMixin cfnDashboardPropsMixin = CfnDashboardPropsMixin.Builder.create(CfnDashboardMixinProps.builder()
         .name("name")
         .refreshSchedule(RefreshScheduleProperty.builder()
                 .frequency(FrequencyProperty.builder()
                         .unit("unit")
                         .value(123)
                         .build())
                 .status("status")
                 .timeOfDay("timeOfDay")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .terminationProtectionEnabled(false)
         .widgets(List.of(WidgetProperty.builder()
                 .queryParameters(List.of("queryParameters"))
                 .queryStatement("queryStatement")
                 .viewProperties(Map.of(
                         "viewPropertiesKey", "viewProperties"))
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDashboardPropsMixin

      protected CfnDashboardPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDashboardPropsMixin

      protected CfnDashboardPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDashboardPropsMixin

      @Stability(Stable) public CfnDashboardPropsMixin(@NotNull CfnDashboardMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudTrail::Dashboard.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDashboardPropsMixin

      @Stability(Stable) public CfnDashboardPropsMixin(@NotNull CfnDashboardMixinProps props)
      Create a mixin to apply properties to AWS::CloudTrail::Dashboard.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDashboardMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()