class CfnWorkspace (construct)

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

Implements IConstruct, IDependable, IInspectable

Specifies a workspace .

In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

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 cfnWorkspace = new grafana.CfnWorkspace(this, 'MyCfnWorkspace', {
  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'],
  },
});

Initializer

new CfnWorkspace(scope: Construct, id: string, props: CfnWorkspaceProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnWorkspaceProps — Resource properties.

Construct Props

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

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.
attrCreationTimestamp	`string`	The date that the workspace was created.
attrEndpoint	`string`	The URL that users can use to access the Grafana console in the workspace.
attrGrafanaVersion	`string`	Specifies the version of Grafana supported by this workspace.
attrId	`string`	The unique ID of this workspace.
attrModificationTimestamp	`string`	The most recent date that the workspace was modified.
attrSamlConfigurationStatus	`string`	Specifies whether the workspace's SAML configuration is complete.
attrSsoClientId	`string`	The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .
attrStatus	`string`	The current status of the workspace.
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 .
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
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.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
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.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

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.

attrCreationTimestamp

Type: string

The date that the workspace was created.

Type: Timestamp

attrEndpoint

Type: string

The URL that users can use to access the Grafana console in the workspace.

Type: String

attrGrafanaVersion

Type: string

Specifies the version of Grafana supported by this workspace.

Type: String

attrId

Type: string

The unique ID of this workspace.

Type: String

attrModificationTimestamp

Type: string

The most recent date that the workspace was modified.

Type: Timestamp

attrSamlConfigurationStatus

Type: string

Specifies whether the workspace's SAML configuration is complete.

Valid values: CONFIGURED | NOT_CONFIGURED

Type: String

attrSsoClientId

Type: string

The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana .

Type: String

attrStatus

Type: string

The current status of the workspace.

Type: String

authenticationProviders

Type: string[]

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

permissionType

Type: string

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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.

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.

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.

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.

roleArn?

Type: string (optional)

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

samlConfiguration?

Type: IResolvable | SamlConfigurationProperty (optional)

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }