Aws/grafana
@swamp/aws/grafanav2026.06.08.2
01README
AWS GRAFANA infrastructure models
02Release Notes
- Updated: workspace
03Models
@swamp/aws/grafana/workspacev2026.06.08.1workspace.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1. |
| AuthenticationProviders | array | List of authentication providers to enable. |
| SamlConfiguration? | object | SAML configuration data associated with an AMG workspace. |
| NetworkAccessControl? | object | The configuration settings for Network Access Control. |
| VpcConfiguration? | object | The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
| ClientToken? | string | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
| GrafanaVersion? | string | The version of Grafana to support in your workspace. |
| AccountAccessType | enum | These 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? | string | The 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. |
| PermissionType | enum | These 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? | string | The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace. |
| DataSources? | array | List of data sources on the service managed IAM role. |
| Description? | string | Description of a workspace. |
| Name? | string | The user friendly name of a workspace. |
| NotificationDestinations? | array | List of notification destinations on the customers service managed IAM role that the Grafana workspace can query. |
| OrganizationalUnits? | array | List of Organizational Units containing AWS accounts the Grafana workspace can pull data from. |
| RoleArn? | string | IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources. |
| PluginAdminEnabled? | boolean | Allow workspace admins to install plugins |
fn create()
Create a Grafana Workspace
fn get(identifier: string)
Get a Grafana Workspace
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Grafana Workspace |
fn update()
Update a Grafana Workspace
fn delete(identifier: string)
Delete a Grafana Workspace
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Grafana Workspace |
fn sync()
Sync Grafana Workspace state from AWS
Resources
state(infinite)— Grafana Workspace resource state
04Previous Versions
2026.06.06.1Jun 6, 2026
- Updated: workspace
2026.04.23.3Apr 23, 2026
2026.04.23.2Apr 23, 2026
- Updated: workspace
2026.04.03.2Apr 3, 2026
- Updated: workspace
2026.03.19.1Mar 19, 2026
- Updated: workspace
2026.03.16.1Mar 16, 2026
- Updated: workspace
2026.03.10.5Mar 10, 2026
05Stats
B
85 / 100
Downloads
0
Archive size
246.1 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit0/2missing
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels