Skip to main content

@swamp/aws/grafana

v2026.04.23.3

AWS GRAFANA infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsgrafanacloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/grafana

@swamp/aws/grafana/workspacev2026.04.23.2workspace.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AuthenticationProvidersarrayList of authentication providers to enable.
SamlConfiguration?objectSAML configuration data associated with an AMG workspace.
NetworkAccessControl?objectThe configuration settings for Network Access Control.
VpcConfiguration?objectThe configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
ClientToken?stringA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
GrafanaVersion?stringThe version of Grafana to support in your workspace.
AccountAccessTypeenumThese enums represent valid account access types. Specifically these enums determine whether the workspace can access AWS resources in the AWS account only, or whether it can also access resources in other accounts in the same organization. If the value CURRENT_ACCOUNT is used, a workspace role ARN must be provided. If the value is ORGANIZATION, a list of organizational units must be provided.
OrganizationRoleName?stringThe name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
PermissionTypeenumThese enums represent valid permission types to use when creating or configuring a Grafana workspace. The SERVICE_MANAGED permission type means the Managed Grafana service will create a workspace IAM role on your behalf. The CUSTOMER_MANAGED permission type means that the customer is expected to provide an IAM role that the Grafana workspace can use to query data sources.
StackSetName?stringThe name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
DataSources?arrayList of data sources on the service managed IAM role.
Description?stringDescription of a workspace.
Name?stringThe user friendly name of a workspace.
NotificationDestinations?arrayList of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
OrganizationalUnits?arrayList of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
RoleArn?stringIAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
PluginAdminEnabled?booleanAllow workspace admins to install plugins
createCreate a Grafana Workspace
getGet a Grafana Workspace
ArgumentTypeDescription
identifierstringThe primary identifier of the Grafana Workspace
updateUpdate a Grafana Workspace
deleteDelete a Grafana Workspace
ArgumentTypeDescription
identifierstringThe primary identifier of the Grafana Workspace
syncSync Grafana Workspace state from AWS

Resources

state(infinite)— Grafana Workspace resource state