AWS::Grafana::Workspace

Grafana Workspace

Definition of AWS::Grafana::Workspace Resource Type

Properties

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

Filter:
PropertyTypeFlags
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
Tags
Array<object>
VpcConfiguration
VpcConfiguration

Return Values

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

AttributeTypeDescription
CreationTimestampstringTimestamp when the workspace was created.
EndpointstringEndpoint for the Grafana workspace.
IdstringThe id that uniquely identifies a Grafana workspace.
ModificationTimestampstringTimestamp when the workspace was last modified
SamlConfigurationStatusstring-
SsoClientIdstringThe client ID of the AWS SSO Managed Application.
Statusstring-

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"
      Tags:
        - Key: Environment
          Value: Production
      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:UpdateWorkspaceAuthenticationgrafana:ListTagsForResourcegrafana:TagResourcesso:DescribeRegisteredRegionssso:CreateManagedApplicationInstanceorganizations:DescribeOrganizationsso:GetSharedSsoConfigurationiam:PassRoleec2:GetManagedPrefixListEntriesec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeDhcpOptionsec2:DescribeNetworkInterfacesiam:CreateServiceLinkedRolesso:ListApplicationInstancessso:GetApplicationInstance

read

grafana:DescribeWorkspacegrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfigurationgrafana:ListTagsForResource

update

grafana:DescribeWorkspacegrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfigurationgrafana:UpdateWorkspacegrafana:UpdateWorkspaceAuthenticationgrafana:UpdateWorkspaceConfigurationgrafana:TagResourcegrafana:UntagResourcegrafana:ListTagsForResourcesso:DescribeRegisteredRegionssso:CreateManagedApplicationInstanceec2:GetManagedPrefixListEntriesiam:PassRoleec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeDhcpOptionsec2:DescribeNetworkInterfacesiam:CreateServiceLinkedRolesso:ListApplicationInstancessso:GetApplicationInstance

delete

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

list

grafana:ListWorkspacesgrafana:DescribeWorkspaceAuthenticationgrafana:DescribeWorkspaceConfigurationgrafana:ListTagsForResource

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
Properties25
Required3
TaggingSupported
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