Update Dashboard

cloudtrail_update_dashboard

R Documentation

Updates the specified dashboard

Description

Updates the specified dashboard.

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.

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.

Usage

cloudtrail_update_dashboard(DashboardId, Widgets, RefreshSchedule,
  TerminationProtectionEnabled)

Arguments

DashboardId

[required] The name or ARN of the dashboard.

Widgets

An array of widgets for the dashboard. A custom dashboard can have a maximum of 10 widgets.

To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the get_dashboard operation to get the list of widgets for the dashboard.

To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

RefreshSchedule

The refresh schedule configuration for the dashboard.

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.

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"
      )
    )
  ),
  RefreshSchedule = list(
    Frequency = list(
      Unit = "HOURS"|"DAYS",
      Value = 123
    ),
    Status = "ENABLED"|"DISABLED",
    TimeOfDay = "string"
  ),
  TerminationProtectionEnabled = TRUE|FALSE,
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

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