AWS::Grafana::Workspace

Grafana Workspace

Definition of AWS::Grafana::Workspace Resource Type

Properties

17 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`AccountAccessType`	`string`	Required
`AuthenticationProviders`	`Array<string>`	Required
`PermissionType`	`string`	Required
`ClientToken`	`string`	Create-onlyWrite-only
`DataSources`	`Array<string>`
`Description`	`string`
`GrafanaVersion`	`string`
`Name`	`string`
`NetworkAccessControl`	`NetworkAccessControl`
`NotificationDestinations`	`Array<string>`
`OrganizationalUnits`	`Array<string>`
`OrganizationRoleName`	`string`
`PluginAdminEnabled`	`boolean`
`RoleArn`	`string`
`SamlConfiguration`	`SamlConfiguration`
`StackSetName`	`string`
`VpcConfiguration`	`VpcConfiguration`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreationTimestamp`	`string`	Timestamp when the workspace was created.
`Endpoint`	`string`	Endpoint for the Grafana workspace.
`Id`	`string`	The id that uniquely identifies a Grafana workspace.
`ModificationTimestamp`	`string`	Timestamp when the workspace was last modified
`SamlConfigurationStatus`	`string`	-
`SsoClientId`	`string`	The client ID of the AWS SSO Managed Application.
`Status`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Grafana::Workspace

Resources:
  MyResource:
    Type: AWS::Grafana::Workspace
    Properties:
      AuthenticationProviders: "my-authenticationproviders"
      PermissionType: "value"
      AccountAccessType: "value"
      Description: !Ref "AWS::StackName"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

grafana:CreateWorkspacegrafana:DescribeWorkspacegrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfigurationgrafana:UpdateWorkspaceAuthenticationsso:DescribeRegisteredRegionssso:CreateManagedApplicationInstanceorganizations:DescribeOrganization

read

grafana:DescribeWorkspacegrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfiguration

update

grafana:DescribeWorkspacegrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfigurationgrafana:UpdateWorkspacegrafana:UpdateWorkspaceAuthenticationgrafana:UpdateWorkspaceConfigurationsso:DescribeRegisteredRegionssso:CreateManagedApplicationInstance

delete

grafana:DeleteWorkspacegrafana:DescribeWorkspacegrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfigurationsso:DeleteManagedApplicationInstancesso:DescribeRegisteredRegions

list

grafana:ListWorkspacesgrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfiguration

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

ServiceGrafana

Properties24

Required3

TaggingNot supported

Primary IDId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ClientToken

External Links

AWS Documentation