interface CfnWorkspaceProps

Language	Type name
.NET	`Amazon.CDK.AWS.Grafana.CfnWorkspaceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgrafana#CfnWorkspaceProps`
Java	`software.amazon.awscdk.services.grafana.CfnWorkspaceProps`
Python	`aws_cdk.aws_grafana.CfnWorkspaceProps`
TypeScript	`aws-cdk-lib` » `aws_grafana` » `CfnWorkspaceProps`

Properties for defining a CfnWorkspace.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_grafana as grafana } from 'aws-cdk-lib';
const cfnWorkspaceProps: grafana.CfnWorkspaceProps = {
  accountAccessType: 'accountAccessType',
  authenticationProviders: ['authenticationProviders'],
  permissionType: 'permissionType',

  // the properties below are optional
  clientToken: 'clientToken',
  dataSources: ['dataSources'],
  description: 'description',
  grafanaVersion: 'grafanaVersion',
  name: 'name',
  networkAccessControl: {
    prefixListIds: ['prefixListIds'],
    vpceIds: ['vpceIds'],
  },
  notificationDestinations: ['notificationDestinations'],
  organizationalUnits: ['organizationalUnits'],
  organizationRoleName: 'organizationRoleName',
  pluginAdminEnabled: false,
  roleArn: 'roleArn',
  samlConfiguration: {
    idpMetadata: {
      url: 'url',
      xml: 'xml',
    },

    // the properties below are optional
    allowedOrganizations: ['allowedOrganizations'],
    assertionAttributes: {
      email: 'email',
      groups: 'groups',
      login: 'login',
      name: 'name',
      org: 'org',
      role: 'role',
    },
    loginValidityDuration: 123,
    roleValues: {
      admin: ['admin'],
      editor: ['editor'],
    },
  },
  stackSetName: 'stackSetName',
  vpcConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

Name	Type	Description
accountAccessType	`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.
authenticationProviders	`string[]`	Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .
permissionType	`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.
clientToken?	`string`	A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
dataSources?	`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.
description?	`string`	The user-defined description of the workspace.
grafanaVersion?	`string`	Specifies the version of Grafana to support in the workspace.
name?	`string`	The name of the workspace.
networkAccessControl?	`IResolvable` `\|` `NetworkAccessControlProperty`	The configuration settings for network access to your workspace.
notificationDestinations?	`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.
organizationRoleName?	`string`	The name of the IAM role that is used to access resources through Organizations.
organizationalUnits?	`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.
pluginAdminEnabled?	`boolean \|` `IResolvable`	Whether plugin administration is enabled in the workspace.
roleArn?	`string`	The IAM role that grants permissions to the AWS resources that the workspace will view data from.
samlConfiguration?	`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.
stackSetName?	`string`	The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
vpcConfiguration?	`IResolvable` `\|` `VpcConfigurationProperty`	The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.

accountAccessType

Type: 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.

authenticationProviders

Type: string[]

Specifies whether this workspace uses SAML 2.0, AWS IAM Identity Center , or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana .

Allowed Values : AWS_SSO | SAML

permissionType

Type: 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 . 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

clientToken?

Type: string (optional)

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

dataSources?

Type: string[] (optional)

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 .

description?

Type: string (optional)

The user-defined description of the workspace.

grafanaVersion?

Type: string (optional)

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 operation.

name?

Type: string (optional)

The name of the workspace.

networkAccessControl?

Type: IResolvable | NetworkAccessControlProperty (optional)

The configuration settings for network access to your workspace.

notificationDestinations?

Type: string[] (optional)

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

organizationRoleName?

Type: string (optional)

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

organizationalUnits?

Type: string[] (optional)

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.

pluginAdminEnabled?

Type: boolean | IResolvable (optional)

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.

roleArn?

Type: string (optional)

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

This role must already exist.

samlConfiguration?

Type: IResolvable | SamlConfigurationProperty (optional)

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.

stackSetName?

Type: string (optional)

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

vpcConfiguration?

Type: IResolvable | VpcConfigurationProperty (optional)

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).