Configure a workspace - Amazon Managed Grafana
Setting configuration with API or AWS CLI

Configure a workspace

Amazon Managed Grafana configuration can be separated into configuration of the Amazon Managed Grafana authentication and permissions, and configuration of the Grafana workspace. This section includes information regarding configuration of your Grafana workspace.

For more information about configuring Amazon Managed Grafana authentication and permissions, see the following topics.

You can modify the configuration of your Grafana workspace within Amazon Managed Grafana on the Workspace configuration options tab when viewing the properties of your workspace.

Making configuration changes to your Grafana instance may cause the instance to restart to reload the new settings. After configuration changes are made, your users may need to refresh any browser pages that show the Grafana workspace.

Note

The same options are available to you when you first create your workspace.

To change the configuration of a Grafana workspace using the Amazon Managed Grafana console

  1. Open the Amazon Managed Grafana console at https://console.aws.amazon.com/grafana/.

  2. In the left navigation pane, choose the menu icon.

  3. Choose All workspaces.

  4. Choose the name of the workspace that you want to configure. This opens the details for that workspace.

  5. Choose the Workspace configuration options tab to see the instance configuration options for your instance.

  6. Find the configuration group that you want to edit. In this case, Grafana alerting.

    Note

    Turning Grafana alerting on or off is currently the only Grafana instance configuration available to modify.

  7. If you want to view Prometheus alerts in your Grafana workspace, select the check box to Turn Grafana alerting on. Turning Grafana alerting on results in sending multiple notifications for your Grafana alerts. If you use alerts defined in Grafana, we do not recommend turning on Grafana alerting.

    If you don't want to view Prometheus alerts, and want to use Grafana managed alerts, uncheck the check box to Turn Grafana alerting on, which turns on the classic dashboard alerts. Even without turning Grafana alerting on, your existing Grafana alerts are evaluated.

Note

If you turn off Grafana alerting, to migrate back to the classic dashboard alerting, you lose all changes made to alerting configuration made while using Grafana alerting, including any new alert rules that you created.

For more information about using Grafana alerting, and the effects of turning it on or off, see Grafana alerting.

The next section shows how to make changes to the Grafana instance configuration using the Amazon Managed Grafana API or the AWS CLI.

Setting configuration with API or AWS CLI

You can set the Grafana workspace configuration using the Amazon Managed Grafana API or the AWS CLI.

In both the Amazon Managed Grafana API and the AWS CLI, the configuration is a JSON string. The only configuration that you can set is the unifiedAlerting, enabled setting. Setting this to true turns on the Grafana alerting feature, setting it to false turns it off. The format is JSON, to allow for future configuration settings which may be added later.

AWS CLI
To update Amazon Managed Grafana instance configuration using the AWS CLI

Run the following command to turn on the Grafana alerting feature for an instance. Replace the <region> and <workspace-id> strings with appropriate values for your instance.

aws grafana update-workspace-configuration \
    --region region \
    --workspace-id <workspace-id> \
    --configuration '{"unifiedAlerting": { "enabled": true }}'
Amazon Managed Grafana API
To update Amazon Managed Grafana instance configuration using the API

Use the following action to turn on the Grafana alerting feature for an instance. Replace the <workspace-id> string with an appropriate value for your instance.

PUT /workspaces/<workspace-id>/configuration HTTP/1.1
Content-type: application/json

{
   "configuration": '{"unifiedAlerting": { "enabled": true }}'
}