AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Grafana::Workspace

CfnWorkspace

Specifies a *workspace* . In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Import

import { CfnWorkspace } from 'aws-cdk-lib/aws-grafana';

Or use the module namespace:

import * as grafana from 'aws-cdk-lib/aws-grafana';
// grafana.CfnWorkspace

Properties

Configuration passed to the constructor as CfnWorkspaceProps.

accountAccessTypeRequired
string

Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this is `ORGANIZATION` , the `OrganizationalUnits` parameter specifies which organizational units the workspace can access.

authenticationProvidersRequired
string[]

Specifies whether this workspace uses SAML 2.0, SSOlong , or both to authenticate users for using the Grafana console within a workspace. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html) . *Allowed Values* : `AWS_SSO | SAML`

permissionTypeRequired
string

If this is `SERVICE_MANAGED` , and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels. If this is `CUSTOMER_MANAGED` , you must manage those roles and permissions yourself. If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to `CUSTOMER_MANAGED` . For more information about converting between customer and service managed, see [Managing permissions for data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html) . For more information about the roles and permissions that must be managed for customer managed workspaces, see [Amazon Managed Grafana permissions and policies for AWS data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html)

clientTokenOptional
string

A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

dataSourcesOptional
string[]

Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources. This list is only used when the workspace was created through the AWS console, and the `permissionType` is `SERVICE_MANAGED` .

descriptionOptional
string

The user-defined description of the workspace.

grafanaVersionOptional
string

Specifies the version of Grafana to support in the workspace. Defaults to the latest version on create (for example, 9.4), or the current version of the workspace on update. Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4). To know what versions are available to upgrade to for a specific workspace, see the [ListVersions](https://docs.aws.amazon.com/grafana/latest/APIReference/API_ListVersions.html) operation.

nameOptional
string

The name of the workspace.

networkAccessControlOptional
IResolvable | NetworkAccessControlProperty

The configuration settings for network access to your workspace.

notificationDestinationsOptional
string[]

The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels. *AllowedValues* : `SNS`

organizationalUnitsOptional
string[]

Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization.

organizationRoleNameOptional
string

The name of the IAM role that is used to access resources through Organizations.

pluginAdminEnabledOptional
boolean | IResolvable

Whether plugin administration is enabled in the workspace. Setting to `true` allows workspace admins to install, uninstall, and update plugins from within the Grafana workspace. > This option is only valid for workspaces that support Grafana version 9 or newer.

roleArnOptional
string | IRoleRef

The IAM role that grants permissions to the AWS resources that the workspace will view data from. This role must already exist.

samlConfigurationOptional
IResolvable | SamlConfigurationProperty

If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the `Admin` and `Editor` roles in the workspace.

stackSetNameOptional
string

The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.

vpcConfigurationOptional
IResolvable | VpcConfigurationProperty

The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. > Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-grafana
CFN TypeAWS::Grafana::Workspace
Properties17

External Links