Skip to content

Create Dashboard

cloudtrail_create_dashboard R Documentation

Creates a custom dashboard or the Highlights dashboard

Description

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 start_query operation on your behalf. To provide permissions, run the put_resource_policy 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 CloudTrail User Guide.

To set a refresh schedule, CloudTrail must be granted permissions to run the start_dashboard_refresh operation to refresh the dashboard on your behalf. To provide permissions, run the put_resource_policy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide.

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

Usage

cloudtrail_create_dashboard(Name, RefreshSchedule, TagsList,
  TerminationProtectionEnabled, Widgets)

Arguments

Name

[required] 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

The refresh schedule configuration for the dashboard.

To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

TagsList
TerminationProtectionEnabled

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

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.

Value

A list with the following syntax: 

list(
  DashboardArn = "string",
  Name = "string",
  Type = "MANAGED"|"CUSTOM",
  Widgets = list(
    list(
      QueryAlias = "string",
      QueryStatement = "string",
      QueryParameters = list(
        "string"
      ),
      ViewProperties = list(
        "string"
      )
    )
  ),
  TagsList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  RefreshSchedule = list(
    Frequency = list(
      Unit = "HOURS"|"DAYS",
      Value = 123
    ),
    Status = "ENABLED"|"DISABLED",
    TimeOfDay = "string"
  ),
  TerminationProtectionEnabled = TRUE|FALSE
)

Request syntax

svc$create_dashboard(
  Name = "string",
  RefreshSchedule = list(
    Frequency = list(
      Unit = "HOURS"|"DAYS",
      Value = 123
    ),
    Status = "ENABLED"|"DISABLED",
    TimeOfDay = "string"
  ),
  TagsList = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  TerminationProtectionEnabled = TRUE|FALSE,
  Widgets = list(
    list(
      QueryStatement = "string",
      QueryParameters = list(
        "string"
      ),
      ViewProperties = list(
        "string"
      )
    )
  )
)