@robhan-cdk-lib/aws_grafana 0.0.402 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/.compatignore +37 -0
  2. package/.jsii +1554 -341
  3. package/API.md +593 -196
  4. package/lib/workspace-base.d.ts +228 -24
  5. package/lib/workspace-base.js +14 -6
  6. package/lib/workspace.d.ts +134 -32
  7. package/lib/workspace.js +115 -83
  8. package/package.json +4 -6
  9. package/lib/validation/workspace-base.d.ts +0 -121
  10. package/lib/validation/workspace-base.js +0 -427
package/API.md CHANGED
@@ -50,6 +50,7 @@ new Workspace(scope: Construct, id: string, props: WorkspaceProps)
50
50
  | --- | --- |
51
51
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.toString">toString</a></code> | Returns a string representation of this construct. |
52
52
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.with">with</a></code> | Applies one or more mixins to this construct. |
53
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.applyCrossStackReferenceStrength">applyCrossStackReferenceStrength</a></code> | Override the cross-stack reference strength for this resource. |
53
54
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
54
55
 
55
56
  ---
@@ -81,6 +82,28 @@ constructs.
81
82
 
82
83
  ---
83
84
 
85
+ ##### `applyCrossStackReferenceStrength` <a name="applyCrossStackReferenceStrength" id="@robhan-cdk-lib/aws_grafana.Workspace.applyCrossStackReferenceStrength"></a>
86
+
87
+ ```typescript
88
+ public applyCrossStackReferenceStrength(strength: ReferenceStrength): void
89
+ ```
90
+
91
+ Override the cross-stack reference strength for this resource.
92
+
93
+ When set, any cross-stack reference to this resource will use the specified
94
+ mechanism instead of the global default determined by the
95
+ `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
96
+ selectively weakening specific references to avoid the "deadly embrace" problem
97
+ without changing the app-wide default.
98
+
99
+ ###### `strength`<sup>Required</sup> <a name="strength" id="@robhan-cdk-lib/aws_grafana.Workspace.applyCrossStackReferenceStrength.parameter.strength"></a>
100
+
101
+ - *Type:* aws-cdk-lib.ReferenceStrength
102
+
103
+ The reference strength to use for this resource.
104
+
105
+ ---
106
+
84
107
  ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_grafana.Workspace.applyRemovalPolicy"></a>
85
108
 
86
109
  ```typescript
@@ -110,6 +133,7 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
110
133
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
111
134
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
112
135
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
136
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceArn">fromWorkspaceArn</a></code> | Import an existing workspace from its ARN. |
113
137
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes">fromWorkspaceAttributes</a></code> | *No description.* |
114
138
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isWorkspace">isWorkspace</a></code> | *No description.* |
115
139
 
@@ -179,6 +203,45 @@ Check whether the given construct is a Resource.
179
203
 
180
204
  ---
181
205
 
206
+ ##### `fromWorkspaceArn` <a name="fromWorkspaceArn" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceArn"></a>
207
+
208
+ ```typescript
209
+ import { Workspace } from '@robhan-cdk-lib/aws_grafana'
210
+
211
+ Workspace.fromWorkspaceArn(scope: Construct, id: string, workspaceArn: string)
212
+ ```
213
+
214
+ Import an existing workspace from its ARN.
215
+
216
+ A single ARN is the most common handle for referencing an existing workspace. The imported
217
+ workspace only exposes identity information (`workspaceArn` and `workspaceId`); the create-time
218
+ configuration properties are not available on an ARN import. Use `fromWorkspaceAttributes` when
219
+ those properties are required.
220
+
221
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceArn.parameter.scope"></a>
222
+
223
+ - *Type:* constructs.Construct
224
+
225
+ The parent construct.
226
+
227
+ ---
228
+
229
+ ###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceArn.parameter.id"></a>
230
+
231
+ - *Type:* string
232
+
233
+ The construct id.
234
+
235
+ ---
236
+
237
+ ###### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceArn.parameter.workspaceArn"></a>
238
+
239
+ - *Type:* string
240
+
241
+ The ARN of the existing workspace.
242
+
243
+ ---
244
+
182
245
  ##### `fromWorkspaceAttributes` <a name="fromWorkspaceAttributes" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes"></a>
183
246
 
184
247
  ```typescript
@@ -226,31 +289,31 @@ Workspace.isWorkspace(x: any)
226
289
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
227
290
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
228
291
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
229
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | 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. |
230
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | 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. |
231
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | 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. |
232
292
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The arn of this workspace. |
233
293
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
294
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | 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. |
295
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | 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. |
234
296
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.clientToken">clientToken</a></code> | <code>string</code> | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
297
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | The date that the workspace was created. |
235
298
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.dataSources">dataSources</a></code> | <code>string[]</code> | 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. |
236
299
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
300
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint">endpoint</a></code> | <code>string</code> | The URL that users can use to access the Grafana console in the workspace. |
301
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Specifies the version of Grafana supported by this workspace. |
302
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp">modificationTimestamp</a></code> | <code>string</code> | The most recent date that the workspace was modified. |
237
303
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.name">name</a></code> | <code>string</code> | The name of the workspace. |
238
304
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.networkAccessControl">networkAccessControl</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a></code> | The configuration settings for network access to your workspace. |
239
305
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.notificationDestinations">notificationDestinations</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]</code> | 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. |
240
306
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.organizationalUnits">organizationalUnits</a></code> | <code>string[]</code> | 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. |
241
307
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.organizationRoleName">organizationRoleName</a></code> | <code>string</code> | The name of the IAM role that is used to access resources through Organizations. |
308
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | 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. |
242
309
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether plugin administration is enabled in the workspace. |
243
310
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The IAM role that grants permissions to the AWS resources that the workspace will view data from. |
244
311
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfiguration">samlConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a></code> | 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. |
312
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfigurationStatus">samlConfigurationStatus</a></code> | <code>string</code> | Specifies whether the workspace's SAML configuration is complete. |
313
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId">ssoClientId</a></code> | <code>string</code> | The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana. |
245
314
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.stackSetName">stackSetName</a></code> | <code>string</code> | The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. |
315
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.status">status</a></code> | <code>string</code> | The current status of the workspace. |
246
316
  | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.vpcConfiguration">vpcConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a></code> | The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
247
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | The date that the workspace was created. |
248
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint">endpoint</a></code> | <code>string</code> | The URL that users can use to access the Grafana console in the workspace. |
249
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Specifies the version of Grafana supported by this workspace. |
250
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp">modificationTimestamp</a></code> | <code>string</code> | The most recent date that the workspace was modified. |
251
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfigurationStatus">samlConfigurationStatus</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses">SamlConfigurationStatuses</a></code> | Specifies whether the workspace's SAML configuration is complete. |
252
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId">ssoClientId</a></code> | <code>string</code> | The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana. |
253
- | <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.status">status</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.Status">Status</a></code> | The current status of the workspace. |
254
317
 
255
318
  ---
256
319
 
@@ -298,85 +361,83 @@ The stack in which this resource is defined.
298
361
 
299
362
  ---
300
363
 
301
- ##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.accountAccessType"></a>
364
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceArn"></a>
302
365
 
303
366
  ```typescript
304
- public readonly accountAccessType: AccountAccessType;
367
+ public readonly workspaceArn: string;
305
368
  ```
306
369
 
307
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
308
-
309
- 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.
370
+ - *Type:* string
310
371
 
311
- If this is
312
- ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
313
- workspace can access.
372
+ The arn of this workspace.
314
373
 
315
374
  ---
316
375
 
317
- ##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders"></a>
376
+ ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceId"></a>
318
377
 
319
378
  ```typescript
320
- public readonly authenticationProviders: AuthenticationProviders[];
379
+ public readonly workspaceId: string;
321
380
  ```
322
381
 
323
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
382
+ - *Type:* string
324
383
 
325
- 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.
384
+ The unique ID of this workspace.
326
385
 
327
386
  ---
328
387
 
329
- ##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.permissionType"></a>
388
+ ##### `accountAccessType`<sup>Optional</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.accountAccessType"></a>
330
389
 
331
390
  ```typescript
332
- public readonly permissionType: PermissionTypes;
391
+ public readonly accountAccessType: AccountAccessType;
333
392
  ```
334
393
 
335
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
394
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
336
395
 
337
- 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.
396
+ 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.
338
397
 
339
- If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
398
+ If this is
399
+ ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
400
+ workspace can access.
340
401
 
341
- If you are working with a workspace in a member account of an organization and that account is
342
- not a delegated administrator account, and you want the workspace to access data sources in
343
- other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
402
+ Always populated for a workspace created through this construct (it is a required prop).
344
403
 
345
404
  ---
346
405
 
347
- ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceArn"></a>
406
+ ##### `authenticationProviders`<sup>Optional</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders"></a>
348
407
 
349
408
  ```typescript
350
- public readonly workspaceArn: string;
409
+ public readonly authenticationProviders: AuthenticationProviders[];
351
410
  ```
352
411
 
353
- - *Type:* string
412
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
354
413
 
355
- The arn of this workspace.
414
+ 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.
415
+
416
+ Always populated for a workspace created through this construct (it is a required prop).
356
417
 
357
418
  ---
358
419
 
359
- ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceId"></a>
420
+ ##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.Workspace.property.clientToken"></a>
360
421
 
361
422
  ```typescript
362
- public readonly workspaceId: string;
423
+ public readonly clientToken: string;
363
424
  ```
364
425
 
365
426
  - *Type:* string
366
427
 
367
- The unique ID of this workspace.
428
+ A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
368
429
 
369
430
  ---
370
431
 
371
- ##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.Workspace.property.clientToken"></a>
432
+ ##### `creationTimestamp`<sup>Optional</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp"></a>
372
433
 
373
434
  ```typescript
374
- public readonly clientToken: string;
435
+ public readonly creationTimestamp: string;
375
436
  ```
376
437
 
377
438
  - *Type:* string
378
439
 
379
- A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
440
+ The date that the workspace was created.
380
441
 
381
442
  ---
382
443
 
@@ -407,6 +468,42 @@ The user-defined description of the workspace.
407
468
 
408
469
  ---
409
470
 
471
+ ##### `endpoint`<sup>Optional</sup> <a name="endpoint" id="@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint"></a>
472
+
473
+ ```typescript
474
+ public readonly endpoint: string;
475
+ ```
476
+
477
+ - *Type:* string
478
+
479
+ The URL that users can use to access the Grafana console in the workspace.
480
+
481
+ ---
482
+
483
+ ##### `grafanaVersion`<sup>Optional</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion"></a>
484
+
485
+ ```typescript
486
+ public readonly grafanaVersion: string;
487
+ ```
488
+
489
+ - *Type:* string
490
+
491
+ Specifies the version of Grafana supported by this workspace.
492
+
493
+ ---
494
+
495
+ ##### `modificationTimestamp`<sup>Optional</sup> <a name="modificationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp"></a>
496
+
497
+ ```typescript
498
+ public readonly modificationTimestamp: string;
499
+ ```
500
+
501
+ - *Type:* string
502
+
503
+ The most recent date that the workspace was modified.
504
+
505
+ ---
506
+
410
507
  ##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.Workspace.property.name"></a>
411
508
 
412
509
  ```typescript
@@ -467,6 +564,26 @@ The name of the IAM role that is used to access resources through Organizations.
467
564
 
468
565
  ---
469
566
 
567
+ ##### `permissionType`<sup>Optional</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.permissionType"></a>
568
+
569
+ ```typescript
570
+ public readonly permissionType: PermissionTypes;
571
+ ```
572
+
573
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
574
+
575
+ 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.
576
+
577
+ If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
578
+
579
+ If you are working with a workspace in a member account of an organization and that account is
580
+ not a delegated administrator account, and you want the workspace to access data sources in
581
+ other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
582
+
583
+ Always populated for a workspace created through this construct (it is a required prop).
584
+
585
+ ---
586
+
470
587
  ##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.Workspace.property.pluginAdminEnabled"></a>
471
588
 
472
589
  ```typescript
@@ -508,111 +625,69 @@ If the workspace uses SAML, use this structure to map SAML assertion attributes
508
625
 
509
626
  ---
510
627
 
511
- ##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.Workspace.property.stackSetName"></a>
628
+ ##### `samlConfigurationStatus`<sup>Optional</sup> <a name="samlConfigurationStatus" id="@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfigurationStatus"></a>
512
629
 
513
630
  ```typescript
514
- public readonly stackSetName: string;
631
+ public readonly samlConfigurationStatus: string;
515
632
  ```
516
633
 
517
634
  - *Type:* string
518
635
 
519
- The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
520
-
521
- ---
522
-
523
- ##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.Workspace.property.vpcConfiguration"></a>
524
-
525
- ```typescript
526
- public readonly vpcConfiguration: VpcConfiguration;
527
- ```
528
-
529
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
530
-
531
- The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
532
-
533
- ---
534
-
535
- ##### `creationTimestamp`<sup>Required</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp"></a>
536
-
537
- ```typescript
538
- public readonly creationTimestamp: string;
539
- ```
636
+ Specifies whether the workspace's SAML configuration is complete.
540
637
 
541
- - *Type:* string
542
-
543
- The date that the workspace was created.
638
+ This is a deploy-time CloudFormation attribute resolved as an unresolved token at synth time,
639
+ so it is typed as `string`. See the `SamlConfigurationStatuses` enum for the possible values.
544
640
 
545
641
  ---
546
642
 
547
- ##### `endpoint`<sup>Required</sup> <a name="endpoint" id="@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint"></a>
643
+ ##### `ssoClientId`<sup>Optional</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId"></a>
548
644
 
549
645
  ```typescript
550
- public readonly endpoint: string;
646
+ public readonly ssoClientId: string;
551
647
  ```
552
648
 
553
649
  - *Type:* string
554
650
 
555
- The URL that users can use to access the Grafana console in the workspace.
651
+ The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
556
652
 
557
653
  ---
558
654
 
559
- ##### `grafanaVersion`<sup>Required</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion"></a>
655
+ ##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.Workspace.property.stackSetName"></a>
560
656
 
561
657
  ```typescript
562
- public readonly grafanaVersion: string;
658
+ public readonly stackSetName: string;
563
659
  ```
564
660
 
565
661
  - *Type:* string
566
662
 
567
- Specifies the version of Grafana supported by this workspace.
663
+ The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
568
664
 
569
665
  ---
570
666
 
571
- ##### `modificationTimestamp`<sup>Required</sup> <a name="modificationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp"></a>
667
+ ##### `status`<sup>Optional</sup> <a name="status" id="@robhan-cdk-lib/aws_grafana.Workspace.property.status"></a>
572
668
 
573
669
  ```typescript
574
- public readonly modificationTimestamp: string;
670
+ public readonly status: string;
575
671
  ```
576
672
 
577
673
  - *Type:* string
578
674
 
579
- The most recent date that the workspace was modified.
580
-
581
- ---
582
-
583
- ##### `samlConfigurationStatus`<sup>Required</sup> <a name="samlConfigurationStatus" id="@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfigurationStatus"></a>
584
-
585
- ```typescript
586
- public readonly samlConfigurationStatus: SamlConfigurationStatuses;
587
- ```
588
-
589
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses">SamlConfigurationStatuses</a>
590
-
591
- Specifies whether the workspace's SAML configuration is complete.
592
-
593
- ---
594
-
595
- ##### `ssoClientId`<sup>Required</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId"></a>
596
-
597
- ```typescript
598
- public readonly ssoClientId: string;
599
- ```
675
+ The current status of the workspace.
600
676
 
601
- - *Type:* string
602
-
603
- The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
677
+ This is a deploy-time CloudFormation attribute resolved as an unresolved token at synth time,
678
+ so it is typed as `string`. See the `Status` enum for the possible values.
604
679
 
605
680
  ---
606
681
 
607
- ##### `status`<sup>Required</sup> <a name="status" id="@robhan-cdk-lib/aws_grafana.Workspace.property.status"></a>
682
+ ##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.Workspace.property.vpcConfiguration"></a>
608
683
 
609
684
  ```typescript
610
- public readonly status: Status;
685
+ public readonly vpcConfiguration: VpcConfiguration;
611
686
  ```
612
687
 
613
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.Status">Status</a>
688
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
614
689
 
615
- The current status of the workspace.
690
+ The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
616
691
 
617
692
  ---
618
693
 
@@ -661,6 +736,7 @@ new WorkspaceBase(scope: Construct, id: string, props?: ResourceProps)
661
736
  | --- | --- |
662
737
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.toString">toString</a></code> | Returns a string representation of this construct. |
663
738
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.with">with</a></code> | Applies one or more mixins to this construct. |
739
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyCrossStackReferenceStrength">applyCrossStackReferenceStrength</a></code> | Override the cross-stack reference strength for this resource. |
664
740
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
665
741
 
666
742
  ---
@@ -692,6 +768,28 @@ constructs.
692
768
 
693
769
  ---
694
770
 
771
+ ##### `applyCrossStackReferenceStrength` <a name="applyCrossStackReferenceStrength" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyCrossStackReferenceStrength"></a>
772
+
773
+ ```typescript
774
+ public applyCrossStackReferenceStrength(strength: ReferenceStrength): void
775
+ ```
776
+
777
+ Override the cross-stack reference strength for this resource.
778
+
779
+ When set, any cross-stack reference to this resource will use the specified
780
+ mechanism instead of the global default determined by the
781
+ `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
782
+ selectively weakening specific references to avoid the "deadly embrace" problem
783
+ without changing the app-wide default.
784
+
785
+ ###### `strength`<sup>Required</sup> <a name="strength" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyCrossStackReferenceStrength.parameter.strength"></a>
786
+
787
+ - *Type:* aws-cdk-lib.ReferenceStrength
788
+
789
+ The reference strength to use for this resource.
790
+
791
+ ---
792
+
695
793
  ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyRemovalPolicy"></a>
696
794
 
697
795
  ```typescript
@@ -795,23 +893,30 @@ Check whether the given construct is a Resource.
795
893
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
796
894
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
797
895
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
798
- | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | The account access type for the workspace. |
799
- | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | The authentication providers for the workspace. |
800
- | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | The permission type for the workspace. |
801
896
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of this workspace. |
802
897
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
898
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | The account access type for the workspace. |
899
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | The authentication providers for the workspace. |
803
900
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.clientToken">clientToken</a></code> | <code>string</code> | The client token for the workspace. |
901
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | The date that the workspace was created. |
804
902
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.dataSources">dataSources</a></code> | <code>string[]</code> | The data sources of this workspace. |
805
903
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.description">description</a></code> | <code>string</code> | The description of this workspace. |
904
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.endpoint">endpoint</a></code> | <code>string</code> | The URL that users can use to access the Grafana console in the workspace. |
905
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Specifies the version of Grafana supported by this workspace. |
906
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.modificationTimestamp">modificationTimestamp</a></code> | <code>string</code> | The most recent date that the workspace was modified. |
806
907
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.name">name</a></code> | <code>string</code> | The name of this workspace. |
807
908
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.networkAccessControl">networkAccessControl</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a></code> | The configuration settings for network access to your workspace. |
808
909
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.notificationDestinations">notificationDestinations</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]</code> | The notification destinations for the workspace. |
809
910
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.organizationalUnits">organizationalUnits</a></code> | <code>string[]</code> | 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. |
810
911
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.organizationRoleName">organizationRoleName</a></code> | <code>string</code> | The name of the IAM role that is used to access resources through Organizations. |
912
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | The permission type for the workspace. |
811
913
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether plugin administration is enabled in the workspace. |
812
914
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The IAM role that grants permissions to the AWS resources that the workspace will view data from. |
813
915
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.samlConfiguration">samlConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a></code> | 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. |
916
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.samlConfigurationStatus">samlConfigurationStatus</a></code> | <code>string</code> | Specifies whether the workspace's SAML configuration is complete. |
917
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.ssoClientId">ssoClientId</a></code> | <code>string</code> | The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana. |
814
918
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.stackSetName">stackSetName</a></code> | <code>string</code> | The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. |
919
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.status">status</a></code> | <code>string</code> | The current status of the workspace. |
815
920
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.vpcConfiguration">vpcConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a></code> | The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
816
921
 
817
922
  ---
@@ -860,75 +965,79 @@ The stack in which this resource is defined.
860
965
 
861
966
  ---
862
967
 
863
- ##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.accountAccessType"></a>
968
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceArn"></a>
864
969
 
865
970
  ```typescript
866
- public readonly accountAccessType: AccountAccessType;
971
+ public readonly workspaceArn: string;
867
972
  ```
868
973
 
869
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
974
+ - *Type:* string
870
975
 
871
- The account access type for the workspace.
976
+ The ARN of this workspace.
872
977
 
873
978
  ---
874
979
 
875
- ##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.authenticationProviders"></a>
980
+ ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceId"></a>
876
981
 
877
982
  ```typescript
878
- public readonly authenticationProviders: AuthenticationProviders[];
983
+ public readonly workspaceId: string;
879
984
  ```
880
985
 
881
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
986
+ - *Type:* string
882
987
 
883
- The authentication providers for the workspace.
988
+ The unique ID of this workspace.
884
989
 
885
990
  ---
886
991
 
887
- ##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.permissionType"></a>
992
+ ##### `accountAccessType`<sup>Optional</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.accountAccessType"></a>
888
993
 
889
994
  ```typescript
890
- public readonly permissionType: PermissionTypes;
995
+ public readonly accountAccessType: AccountAccessType;
891
996
  ```
892
997
 
893
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
998
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
999
+ - *Default:* not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
894
1000
 
895
- The permission type for the workspace.
1001
+ The account access type for the workspace.
896
1002
 
897
1003
  ---
898
1004
 
899
- ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceArn"></a>
1005
+ ##### `authenticationProviders`<sup>Optional</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.authenticationProviders"></a>
900
1006
 
901
1007
  ```typescript
902
- public readonly workspaceArn: string;
1008
+ public readonly authenticationProviders: AuthenticationProviders[];
903
1009
  ```
904
1010
 
905
- - *Type:* string
1011
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
1012
+ - *Default:* not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
906
1013
 
907
- The ARN of this workspace.
1014
+ The authentication providers for the workspace.
908
1015
 
909
1016
  ---
910
1017
 
911
- ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceId"></a>
1018
+ ##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.clientToken"></a>
912
1019
 
913
1020
  ```typescript
914
- public readonly workspaceId: string;
1021
+ public readonly clientToken: string;
915
1022
  ```
916
1023
 
917
1024
  - *Type:* string
1025
+ - *Default:* not available on imported workspaces
918
1026
 
919
- The unique ID of this workspace.
1027
+ The client token for the workspace.
920
1028
 
921
1029
  ---
922
1030
 
923
- ##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.clientToken"></a>
1031
+ ##### `creationTimestamp`<sup>Optional</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.creationTimestamp"></a>
924
1032
 
925
1033
  ```typescript
926
- public readonly clientToken: string;
1034
+ public readonly creationTimestamp: string;
927
1035
  ```
928
1036
 
929
1037
  - *Type:* string
1038
+ - *Default:* not available on imported workspaces
930
1039
 
931
- The client token for the workspace.
1040
+ The date that the workspace was created.
932
1041
 
933
1042
  ---
934
1043
 
@@ -939,6 +1048,7 @@ public readonly dataSources: string[];
939
1048
  ```
940
1049
 
941
1050
  - *Type:* string[]
1051
+ - *Default:* no data sources
942
1052
 
943
1053
  The data sources of this workspace.
944
1054
 
@@ -951,11 +1061,51 @@ public readonly description: string;
951
1061
  ```
952
1062
 
953
1063
  - *Type:* string
1064
+ - *Default:* no description
954
1065
 
955
1066
  The description of this workspace.
956
1067
 
957
1068
  ---
958
1069
 
1070
+ ##### `endpoint`<sup>Optional</sup> <a name="endpoint" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.endpoint"></a>
1071
+
1072
+ ```typescript
1073
+ public readonly endpoint: string;
1074
+ ```
1075
+
1076
+ - *Type:* string
1077
+ - *Default:* not available on imported workspaces
1078
+
1079
+ The URL that users can use to access the Grafana console in the workspace.
1080
+
1081
+ ---
1082
+
1083
+ ##### `grafanaVersion`<sup>Optional</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.grafanaVersion"></a>
1084
+
1085
+ ```typescript
1086
+ public readonly grafanaVersion: string;
1087
+ ```
1088
+
1089
+ - *Type:* string
1090
+ - *Default:* not available on imported workspaces
1091
+
1092
+ Specifies the version of Grafana supported by this workspace.
1093
+
1094
+ ---
1095
+
1096
+ ##### `modificationTimestamp`<sup>Optional</sup> <a name="modificationTimestamp" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.modificationTimestamp"></a>
1097
+
1098
+ ```typescript
1099
+ public readonly modificationTimestamp: string;
1100
+ ```
1101
+
1102
+ - *Type:* string
1103
+ - *Default:* not available on imported workspaces
1104
+
1105
+ The most recent date that the workspace was modified.
1106
+
1107
+ ---
1108
+
959
1109
  ##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.name"></a>
960
1110
 
961
1111
  ```typescript
@@ -963,6 +1113,7 @@ public readonly name: string;
963
1113
  ```
964
1114
 
965
1115
  - *Type:* string
1116
+ - *Default:* a name is generated by CloudFormation
966
1117
 
967
1118
  The name of this workspace.
968
1119
 
@@ -975,6 +1126,7 @@ public readonly networkAccessControl: NetworkAccessControl;
975
1126
  ```
976
1127
 
977
1128
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
1129
+ - *Default:* no network access control, the workspace is open to all traffic
978
1130
 
979
1131
  The configuration settings for network access to your workspace.
980
1132
 
@@ -987,6 +1139,7 @@ public readonly notificationDestinations: NotificationDestinations[];
987
1139
  ```
988
1140
 
989
1141
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
1142
+ - *Default:* no notification destinations
990
1143
 
991
1144
  The notification destinations for the workspace.
992
1145
 
@@ -999,6 +1152,7 @@ public readonly organizationalUnits: string[];
999
1152
  ```
1000
1153
 
1001
1154
  - *Type:* string[]
1155
+ - *Default:* no organizational units
1002
1156
 
1003
1157
  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.
1004
1158
 
@@ -1011,11 +1165,25 @@ public readonly organizationRoleName: string;
1011
1165
  ```
1012
1166
 
1013
1167
  - *Type:* string
1168
+ - *Default:* no organization role name
1014
1169
 
1015
1170
  The name of the IAM role that is used to access resources through Organizations.
1016
1171
 
1017
1172
  ---
1018
1173
 
1174
+ ##### `permissionType`<sup>Optional</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.permissionType"></a>
1175
+
1176
+ ```typescript
1177
+ public readonly permissionType: PermissionTypes;
1178
+ ```
1179
+
1180
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
1181
+ - *Default:* not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
1182
+
1183
+ The permission type for the workspace.
1184
+
1185
+ ---
1186
+
1019
1187
  ##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.pluginAdminEnabled"></a>
1020
1188
 
1021
1189
  ```typescript
@@ -1023,6 +1191,7 @@ public readonly pluginAdminEnabled: boolean;
1023
1191
  ```
1024
1192
 
1025
1193
  - *Type:* boolean
1194
+ - *Default:* false
1026
1195
 
1027
1196
  Whether plugin administration is enabled in the workspace.
1028
1197
 
@@ -1040,6 +1209,7 @@ public readonly role: IRole;
1040
1209
  ```
1041
1210
 
1042
1211
  - *Type:* aws-cdk-lib.aws_iam.IRole
1212
+ - *Default:* no role is attached
1043
1213
 
1044
1214
  The IAM role that grants permissions to the AWS resources that the workspace will view data from.
1045
1215
 
@@ -1052,11 +1222,38 @@ public readonly samlConfiguration: SamlConfiguration;
1052
1222
  ```
1053
1223
 
1054
1224
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
1225
+ - *Default:* no SAML configuration
1055
1226
 
1056
1227
  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.
1057
1228
 
1058
1229
  ---
1059
1230
 
1231
+ ##### `samlConfigurationStatus`<sup>Optional</sup> <a name="samlConfigurationStatus" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.samlConfigurationStatus"></a>
1232
+
1233
+ ```typescript
1234
+ public readonly samlConfigurationStatus: string;
1235
+ ```
1236
+
1237
+ - *Type:* string
1238
+ - *Default:* not available on imported workspaces
1239
+
1240
+ Specifies whether the workspace's SAML configuration is complete.
1241
+
1242
+ ---
1243
+
1244
+ ##### `ssoClientId`<sup>Optional</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.ssoClientId"></a>
1245
+
1246
+ ```typescript
1247
+ public readonly ssoClientId: string;
1248
+ ```
1249
+
1250
+ - *Type:* string
1251
+ - *Default:* not available on imported workspaces
1252
+
1253
+ The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
1254
+
1255
+ ---
1256
+
1060
1257
  ##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.stackSetName"></a>
1061
1258
 
1062
1259
  ```typescript
@@ -1064,11 +1261,25 @@ public readonly stackSetName: string;
1064
1261
  ```
1065
1262
 
1066
1263
  - *Type:* string
1264
+ - *Default:* no stack set name
1067
1265
 
1068
1266
  The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
1069
1267
 
1070
1268
  ---
1071
1269
 
1270
+ ##### `status`<sup>Optional</sup> <a name="status" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.status"></a>
1271
+
1272
+ ```typescript
1273
+ public readonly status: string;
1274
+ ```
1275
+
1276
+ - *Type:* string
1277
+ - *Default:* not available on imported workspaces
1278
+
1279
+ The current status of the workspace.
1280
+
1281
+ ---
1282
+
1072
1283
  ##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.vpcConfiguration"></a>
1073
1284
 
1074
1285
  ```typescript
@@ -1076,6 +1287,7 @@ public readonly vpcConfiguration: VpcConfiguration;
1076
1287
  ```
1077
1288
 
1078
1289
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
1290
+ - *Default:* no VPC connection
1079
1291
 
1080
1292
  The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
1081
1293
 
@@ -1112,6 +1324,7 @@ public readonly prefixLists: IPrefixList[];
1112
1324
  ```
1113
1325
 
1114
1326
  - *Type:* aws-cdk-lib.aws_ec2.IPrefixList[]
1327
+ - *Default:* no prefix lists; combined with an empty `vpcEndpoints`, all traffic is denied
1115
1328
 
1116
1329
  An array of prefix list IDs.
1117
1330
 
@@ -1120,7 +1333,7 @@ addresses specified are allowed to access your workspace. If the list is not inc
1120
1333
  configuration (passed an empty array) then no IP addresses are allowed to access the
1121
1334
  workspace.
1122
1335
 
1123
- Maximum of 5 prefix lists allowed.
1336
+ A maximum of 5 prefix lists is allowed (validated by CloudFormation at deploy time).
1124
1337
 
1125
1338
  ---
1126
1339
 
@@ -1131,6 +1344,7 @@ public readonly vpcEndpoints: IVpcEndpoint[];
1131
1344
  ```
1132
1345
 
1133
1346
  - *Type:* aws-cdk-lib.aws_ec2.IVpcEndpoint[]
1347
+ - *Default:* no VPC endpoints; combined with an empty `prefixLists`, all traffic is denied
1134
1348
 
1135
1349
  An array of Amazon VPC endpoint IDs for the workspace.
1136
1350
 
@@ -1139,7 +1353,7 @@ Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAcces
1139
1353
  is specified then only VPC endpoints specified here are allowed to access the workspace. If
1140
1354
  you pass in an empty array of strings, then no VPCs are allowed to access the workspace.
1141
1355
 
1142
- Maximum of 5 VPC endpoints allowed.
1356
+ A maximum of 5 VPC endpoints is allowed (validated by CloudFormation at deploy time).
1143
1357
 
1144
1358
  ---
1145
1359
 
@@ -1177,10 +1391,11 @@ public readonly email: string;
1177
1391
  ```
1178
1392
 
1179
1393
  - *Type:* string
1394
+ - *Default:* no email attribute mapping
1180
1395
 
1181
1396
  The name of the attribute within the SAML assertion to use as the email names for SAML users.
1182
1397
 
1183
- Must be between 1 and 256 characters long.
1398
+ Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
1184
1399
 
1185
1400
  ---
1186
1401
 
@@ -1191,10 +1406,11 @@ public readonly groups: string;
1191
1406
  ```
1192
1407
 
1193
1408
  - *Type:* string
1409
+ - *Default:* no groups attribute mapping
1194
1410
 
1195
1411
  The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
1196
1412
 
1197
- Must be between 1 and 256 characters long.
1413
+ Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
1198
1414
 
1199
1415
  ---
1200
1416
 
@@ -1205,10 +1421,11 @@ public readonly login: string;
1205
1421
  ```
1206
1422
 
1207
1423
  - *Type:* string
1424
+ - *Default:* no login attribute mapping
1208
1425
 
1209
1426
  The name of the attribute within the SAML assertion to use as the login names for SAML users.
1210
1427
 
1211
- Must be between 1 and 256 characters long.
1428
+ Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
1212
1429
 
1213
1430
  ---
1214
1431
 
@@ -1219,10 +1436,11 @@ public readonly name: string;
1219
1436
  ```
1220
1437
 
1221
1438
  - *Type:* string
1439
+ - *Default:* no name attribute mapping
1222
1440
 
1223
1441
  The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
1224
1442
 
1225
- Must be between 1 and 256 characters long.
1443
+ Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
1226
1444
 
1227
1445
  ---
1228
1446
 
@@ -1233,10 +1451,11 @@ public readonly org: string;
1233
1451
  ```
1234
1452
 
1235
1453
  - *Type:* string
1454
+ - *Default:* no org attribute mapping
1236
1455
 
1237
1456
  The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
1238
1457
 
1239
- Must be between 1 and 256 characters long.
1458
+ Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
1240
1459
 
1241
1460
  ---
1242
1461
 
@@ -1247,10 +1466,11 @@ public readonly role: string;
1247
1466
  ```
1248
1467
 
1249
1468
  - *Type:* string
1469
+ - *Default:* no role attribute mapping
1250
1470
 
1251
1471
  The name of the attribute within the SAML assertion to use as the user roles.
1252
1472
 
1253
- Must be between 1 and 256 characters long.
1473
+ Must be between 1 and 256 characters long (validated by CloudFormation at deploy time).
1254
1474
 
1255
1475
  ---
1256
1476
 
@@ -1272,7 +1492,7 @@ const samlConfiguration: SamlConfiguration = { ... }
1272
1492
  | --- | --- | --- |
1273
1493
  | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.idpMetadata">idpMetadata</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata">SamlIdpMetadata</a></code> | A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. |
1274
1494
  | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.allowedOrganizations">allowedOrganizations</a></code> | <code>string[]</code> | Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. |
1275
- | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.assertionAtrributes">assertionAtrributes</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes">SamlAssertionAttributes</a></code> | A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace. |
1495
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.assertionAttributes">assertionAttributes</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes">SamlAssertionAttributes</a></code> | A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace. |
1276
1496
  | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.loginValidityDuration">loginValidityDuration</a></code> | <code>number</code> | How long a sign-on session by a SAML user is valid, before the user has to sign on again. |
1277
1497
  | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.roleValues">roleValues</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlRoleValues">SamlRoleValues</a></code> | A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace. |
1278
1498
 
@@ -1299,22 +1519,24 @@ public readonly allowedOrganizations: string[];
1299
1519
  ```
1300
1520
 
1301
1521
  - *Type:* string[]
1522
+ - *Default:* all organizations in the assertion attribute have access
1302
1523
 
1303
1524
  Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
1304
1525
 
1305
1526
  If this is empty, all organizations in the assertion attribute have access.
1306
1527
 
1307
- Must have between 1 and 256 elements.
1528
+ Must have between 1 and 256 elements (validated by CloudFormation at deploy time).
1308
1529
 
1309
1530
  ---
1310
1531
 
1311
- ##### `assertionAtrributes`<sup>Optional</sup> <a name="assertionAtrributes" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.assertionAtrributes"></a>
1532
+ ##### `assertionAttributes`<sup>Optional</sup> <a name="assertionAttributes" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.assertionAttributes"></a>
1312
1533
 
1313
1534
  ```typescript
1314
- public readonly assertionAtrributes: SamlAssertionAttributes;
1535
+ public readonly assertionAttributes: SamlAssertionAttributes;
1315
1536
  ```
1316
1537
 
1317
1538
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes">SamlAssertionAttributes</a>
1539
+ - *Default:* no assertion attribute mapping
1318
1540
 
1319
1541
  A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.
1320
1542
 
@@ -1327,10 +1549,11 @@ public readonly loginValidityDuration: number;
1327
1549
  ```
1328
1550
 
1329
1551
  - *Type:* number
1552
+ - *Default:* the service default session validity applies
1330
1553
 
1331
1554
  How long a sign-on session by a SAML user is valid, before the user has to sign on again.
1332
1555
 
1333
- Must be a positive number.
1556
+ Must be a positive number (validated by CloudFormation at deploy time).
1334
1557
 
1335
1558
  ---
1336
1559
 
@@ -1341,6 +1564,7 @@ public readonly roleValues: SamlRoleValues;
1341
1564
  ```
1342
1565
 
1343
1566
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlRoleValues">SamlRoleValues</a>
1567
+ - *Default:* no role mapping
1344
1568
 
1345
1569
  A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
1346
1570
 
@@ -1374,10 +1598,12 @@ public readonly url: string;
1374
1598
  ```
1375
1599
 
1376
1600
  - *Type:* string
1601
+ - *Default:* no metadata URL; supply `xml` instead
1377
1602
 
1378
1603
  The URL of the location containing the IdP metadata.
1379
1604
 
1380
- Must be a string with length between 1 and 2048 characters.
1605
+ Must be a string with length between 1 and 2048 characters (validated by CloudFormation at
1606
+ deploy time).
1381
1607
 
1382
1608
  ---
1383
1609
 
@@ -1388,6 +1614,7 @@ public readonly xml: string;
1388
1614
  ```
1389
1615
 
1390
1616
  - *Type:* string
1617
+ - *Default:* no inline metadata; supply `url` instead
1391
1618
 
1392
1619
  The full IdP metadata, in XML format.
1393
1620
 
@@ -1421,10 +1648,11 @@ public readonly admin: string[];
1421
1648
  ```
1422
1649
 
1423
1650
  - *Type:* string[]
1651
+ - *Default:* no groups are granted the Admin role
1424
1652
 
1425
1653
  A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
1426
1654
 
1427
- Maximum of 256 elements.
1655
+ A maximum of 256 elements is allowed (validated by CloudFormation at deploy time).
1428
1656
 
1429
1657
  ---
1430
1658
 
@@ -1435,10 +1663,11 @@ public readonly editor: string[];
1435
1663
  ```
1436
1664
 
1437
1665
  - *Type:* string[]
1666
+ - *Default:* no groups are granted the Editor role
1438
1667
 
1439
1668
  A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
1440
1669
 
1441
- Maximum of 256 elements.
1670
+ A maximum of 256 elements is allowed (validated by CloudFormation at deploy time).
1442
1671
 
1443
1672
  ---
1444
1673
 
@@ -1475,7 +1704,8 @@ The list of Amazon EC2 security groups attached to the Amazon VPC for your Grafa
1475
1704
 
1476
1705
  Duplicates not allowed.
1477
1706
 
1478
- Array Members: Minimum number of 1 items. Maximum number of 5 items.
1707
+ Array members: minimum of 1 item, maximum of 5 items (validated by CloudFormation at deploy
1708
+ time).
1479
1709
 
1480
1710
  Required for VPC configuration.
1481
1711
 
@@ -1491,7 +1721,8 @@ public readonly subnets: ISubnet[];
1491
1721
 
1492
1722
  The list of Amazon EC2 subnets created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
1493
1723
 
1494
- Array Members: Minimum number of 2 items. Maximum number of 6 items.
1724
+ Array members: minimum of 2 items, maximum of 6 items (validated by CloudFormation at deploy
1725
+ time).
1495
1726
 
1496
1727
  Required for VPC configuration.
1497
1728
 
@@ -1602,10 +1833,13 @@ public readonly clientToken: string;
1602
1833
  ```
1603
1834
 
1604
1835
  - *Type:* string
1836
+ - *Default:* no client token
1605
1837
 
1606
1838
  A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
1607
1839
 
1608
- Must be 1-64 characters long and contain only printable ASCII characters.
1840
+ Must be 1-64 characters long and contain only printable ASCII characters (validated by
1841
+ CloudFormation at deploy time). Note that an idempotency token has no practical effect in the
1842
+ declarative CloudFormation/CDK deployment model.
1609
1843
 
1610
1844
  ---
1611
1845
 
@@ -1616,11 +1850,13 @@ public readonly dataSources: string[];
1616
1850
  ```
1617
1851
 
1618
1852
  - *Type:* string[]
1853
+ - *Default:* no data sources
1619
1854
 
1620
1855
  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.
1621
1856
 
1622
1857
  This list is only used when the workspace was created through the AWS console, and the
1623
- permissionType is SERVICE_MANAGED.
1858
+ permissionType is SERVICE_MANAGED. The Amazon Managed Grafana API marks this parameter as for
1859
+ internal use only and recommends against setting it.
1624
1860
 
1625
1861
  ---
1626
1862
 
@@ -1631,10 +1867,11 @@ public readonly description: string;
1631
1867
  ```
1632
1868
 
1633
1869
  - *Type:* string
1870
+ - *Default:* no description
1634
1871
 
1635
1872
  The user-defined description of the workspace.
1636
1873
 
1637
- Maximum length of 2048 characters.
1874
+ Maximum length of 2048 characters (validated by CloudFormation at deploy time).
1638
1875
 
1639
1876
  ---
1640
1877
 
@@ -1645,11 +1882,12 @@ public readonly name: string;
1645
1882
  ```
1646
1883
 
1647
1884
  - *Type:* string
1885
+ - *Default:* a name is generated by CloudFormation
1648
1886
 
1649
1887
  The name of the workspace.
1650
1888
 
1651
1889
  Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots,
1652
- underscores, and tildes.
1890
+ underscores, and tildes (validated by CloudFormation at deploy time).
1653
1891
 
1654
1892
  ---
1655
1893
 
@@ -1660,6 +1898,7 @@ public readonly networkAccessControl: NetworkAccessControl;
1660
1898
  ```
1661
1899
 
1662
1900
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
1901
+ - *Default:* no network access control, the workspace is open to all traffic
1663
1902
 
1664
1903
  The configuration settings for network access to your workspace.
1665
1904
 
@@ -1672,6 +1911,7 @@ public readonly notificationDestinations: NotificationDestinations[];
1672
1911
  ```
1673
1912
 
1674
1913
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
1914
+ - *Default:* no notification destinations
1675
1915
 
1676
1916
  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.
1677
1917
 
@@ -1684,6 +1924,7 @@ public readonly organizationalUnits: string[];
1684
1924
  ```
1685
1925
 
1686
1926
  - *Type:* string[]
1927
+ - *Default:* no organizational units
1687
1928
 
1688
1929
  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.
1689
1930
 
@@ -1696,10 +1937,11 @@ public readonly organizationRoleName: string;
1696
1937
  ```
1697
1938
 
1698
1939
  - *Type:* string
1940
+ - *Default:* no organization role name
1699
1941
 
1700
1942
  Name of the IAM role to use for the organization.
1701
1943
 
1702
- Maximum length of 2048 characters.
1944
+ Maximum length of 2048 characters (validated by CloudFormation at deploy time).
1703
1945
 
1704
1946
  ---
1705
1947
 
@@ -1710,6 +1952,7 @@ public readonly pluginAdminEnabled: boolean;
1710
1952
  ```
1711
1953
 
1712
1954
  - *Type:* boolean
1955
+ - *Default:* false
1713
1956
 
1714
1957
  Whether plugin administration is enabled in the workspace.
1715
1958
 
@@ -1718,8 +1961,6 @@ admins to install, uninstall, and update plugins from within the Grafana workspa
1718
1961
 
1719
1962
  This option is only valid for workspaces that support Grafana version 9 or newer.
1720
1963
 
1721
- Default: false
1722
-
1723
1964
  ---
1724
1965
 
1725
1966
  ##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.role"></a>
@@ -1729,6 +1970,7 @@ public readonly role: IRole;
1729
1970
  ```
1730
1971
 
1731
1972
  - *Type:* aws-cdk-lib.aws_iam.IRole
1973
+ - *Default:* no role is attached
1732
1974
 
1733
1975
  The IAM role that grants permissions to the AWS resources that the workspace will view data from.
1734
1976
 
@@ -1741,6 +1983,7 @@ public readonly samlConfiguration: SamlConfiguration;
1741
1983
  ```
1742
1984
 
1743
1985
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
1986
+ - *Default:* no SAML configuration
1744
1987
 
1745
1988
  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.
1746
1989
 
@@ -1753,6 +1996,7 @@ public readonly stackSetName: string;
1753
1996
  ```
1754
1997
 
1755
1998
  - *Type:* string
1999
+ - *Default:* no stack set name
1756
2000
 
1757
2001
  The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
1758
2002
 
@@ -1765,6 +2009,7 @@ public readonly vpcConfiguration: VpcConfiguration;
1765
2009
  ```
1766
2010
 
1767
2011
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
2012
+ - *Default:* no VPC connection
1768
2013
 
1769
2014
  The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
1770
2015
 
@@ -1802,6 +2047,7 @@ const workspaceProps: WorkspaceProps = { ... }
1802
2047
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The IAM role that grants permissions to the AWS resources that the workspace will view data from. |
1803
2048
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.samlConfiguration">samlConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a></code> | 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. |
1804
2049
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.stackSetName">stackSetName</a></code> | <code>string</code> | The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. |
2050
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.tags">tags</a></code> | <code>{[ key: string ]: string}</code> | A map of tags to assign to the workspace. Tags can also be applied after creation using `Tags.of(workspace).add(key, value)`. |
1805
2051
  | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.vpcConfiguration">vpcConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a></code> | The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
1806
2052
 
1807
2053
  ---
@@ -1865,10 +2111,13 @@ public readonly clientToken: string;
1865
2111
  ```
1866
2112
 
1867
2113
  - *Type:* string
2114
+ - *Default:* no client token
1868
2115
 
1869
2116
  A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
1870
2117
 
1871
- Must be 1-64 characters long and contain only printable ASCII characters.
2118
+ Must be 1-64 characters long and contain only printable ASCII characters (validated by
2119
+ CloudFormation at deploy time). Note that an idempotency token has no practical effect in the
2120
+ declarative CloudFormation/CDK deployment model.
1872
2121
 
1873
2122
  ---
1874
2123
 
@@ -1879,11 +2128,13 @@ public readonly dataSources: string[];
1879
2128
  ```
1880
2129
 
1881
2130
  - *Type:* string[]
2131
+ - *Default:* no data sources
1882
2132
 
1883
2133
  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.
1884
2134
 
1885
2135
  This list is only used when the workspace was created through the AWS console, and the
1886
- permissionType is SERVICE_MANAGED.
2136
+ permissionType is SERVICE_MANAGED. The Amazon Managed Grafana API marks this parameter as for
2137
+ internal use only and recommends against setting it.
1887
2138
 
1888
2139
  ---
1889
2140
 
@@ -1894,10 +2145,11 @@ public readonly description: string;
1894
2145
  ```
1895
2146
 
1896
2147
  - *Type:* string
2148
+ - *Default:* no description
1897
2149
 
1898
2150
  The user-defined description of the workspace.
1899
2151
 
1900
- Maximum length of 2048 characters.
2152
+ Maximum length of 2048 characters (validated by CloudFormation at deploy time).
1901
2153
 
1902
2154
  ---
1903
2155
 
@@ -1908,15 +2160,16 @@ public readonly grafanaVersion: string;
1908
2160
  ```
1909
2161
 
1910
2162
  - *Type:* string
2163
+ - *Default:* the service assigns the latest Grafana version
1911
2164
 
1912
2165
  Specifies the version of Grafana to support in the workspace.
1913
2166
 
1914
2167
  Defaults to the latest version
1915
- on create (for example, 9.4), or the current version of the workspace on update.
2168
+ on create (for example, 10.4), or the current version of the workspace on update.
1916
2169
  Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from
1917
2170
  9.4 to 8.4).
1918
2171
 
1919
- Must be 1-255 characters long.
2172
+ Must be 1-255 characters long (validated by CloudFormation at deploy time).
1920
2173
 
1921
2174
  ---
1922
2175
 
@@ -1927,11 +2180,12 @@ public readonly name: string;
1927
2180
  ```
1928
2181
 
1929
2182
  - *Type:* string
2183
+ - *Default:* a name is generated by CloudFormation
1930
2184
 
1931
2185
  The name of the workspace.
1932
2186
 
1933
2187
  Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots,
1934
- underscores, and tildes.
2188
+ underscores, and tildes (validated by CloudFormation at deploy time).
1935
2189
 
1936
2190
  ---
1937
2191
 
@@ -1942,6 +2196,7 @@ public readonly networkAccessControl: NetworkAccessControl;
1942
2196
  ```
1943
2197
 
1944
2198
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
2199
+ - *Default:* no network access control, the workspace is open to all traffic
1945
2200
 
1946
2201
  The configuration settings for network access to your workspace.
1947
2202
 
@@ -1954,6 +2209,7 @@ public readonly notificationDestinations: NotificationDestinations[];
1954
2209
  ```
1955
2210
 
1956
2211
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
2212
+ - *Default:* no notification destinations
1957
2213
 
1958
2214
  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.
1959
2215
 
@@ -1966,6 +2222,7 @@ public readonly organizationalUnits: string[];
1966
2222
  ```
1967
2223
 
1968
2224
  - *Type:* string[]
2225
+ - *Default:* no organizational units
1969
2226
 
1970
2227
  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.
1971
2228
 
@@ -1978,10 +2235,11 @@ public readonly organizationRoleName: string;
1978
2235
  ```
1979
2236
 
1980
2237
  - *Type:* string
2238
+ - *Default:* no organization role name
1981
2239
 
1982
2240
  Name of the IAM role to use for the organization.
1983
2241
 
1984
- Maximum length of 2048 characters.
2242
+ Maximum length of 2048 characters (validated by CloudFormation at deploy time).
1985
2243
 
1986
2244
  ---
1987
2245
 
@@ -1992,6 +2250,7 @@ public readonly pluginAdminEnabled: boolean;
1992
2250
  ```
1993
2251
 
1994
2252
  - *Type:* boolean
2253
+ - *Default:* false
1995
2254
 
1996
2255
  Whether plugin administration is enabled in the workspace.
1997
2256
 
@@ -2000,8 +2259,6 @@ admins to install, uninstall, and update plugins from within the Grafana workspa
2000
2259
 
2001
2260
  This option is only valid for workspaces that support Grafana version 9 or newer.
2002
2261
 
2003
- Default: false
2004
-
2005
2262
  ---
2006
2263
 
2007
2264
  ##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.role"></a>
@@ -2011,6 +2268,7 @@ public readonly role: IRole;
2011
2268
  ```
2012
2269
 
2013
2270
  - *Type:* aws-cdk-lib.aws_iam.IRole
2271
+ - *Default:* no role is attached
2014
2272
 
2015
2273
  The IAM role that grants permissions to the AWS resources that the workspace will view data from.
2016
2274
 
@@ -2023,6 +2281,7 @@ public readonly samlConfiguration: SamlConfiguration;
2023
2281
  ```
2024
2282
 
2025
2283
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
2284
+ - *Default:* no SAML configuration
2026
2285
 
2027
2286
  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.
2028
2287
 
@@ -2035,11 +2294,29 @@ public readonly stackSetName: string;
2035
2294
  ```
2036
2295
 
2037
2296
  - *Type:* string
2297
+ - *Default:* no stack set name
2038
2298
 
2039
2299
  The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
2040
2300
 
2041
2301
  ---
2042
2302
 
2303
+ ##### `tags`<sup>Optional</sup> <a name="tags" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.tags"></a>
2304
+
2305
+ ```typescript
2306
+ public readonly tags: {[ key: string ]: string};
2307
+ ```
2308
+
2309
+ - *Type:* {[ key: string ]: string}
2310
+ - *Default:* no tags
2311
+
2312
+ A map of tags to assign to the workspace. Tags can also be applied after creation using `Tags.of(workspace).add(key, value)`.
2313
+
2314
+ Constraints (from the Amazon Managed Grafana API): a maximum of 50 tags, each key must be
2315
+ 1-128 characters long and each value 0-256 characters long (validated by CloudFormation at
2316
+ deploy time).
2317
+
2318
+ ---
2319
+
2043
2320
  ##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.vpcConfiguration"></a>
2044
2321
 
2045
2322
  ```typescript
@@ -2047,6 +2324,7 @@ public readonly vpcConfiguration: VpcConfiguration;
2047
2324
  ```
2048
2325
 
2049
2326
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
2327
+ - *Default:* no VPC connection
2050
2328
 
2051
2329
  The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
2052
2330
 
@@ -2071,23 +2349,30 @@ Represents an Amazon Managed Service for Grafana workspace.
2071
2349
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
2072
2350
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
2073
2351
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
2074
- | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | 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. |
2075
- | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | 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. |
2076
- | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | 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. |
2077
2352
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of this workspace. |
2078
2353
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
2354
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | 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. |
2355
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | 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. |
2079
2356
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.clientToken">clientToken</a></code> | <code>string</code> | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
2357
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | The date that the workspace was created. |
2080
2358
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.dataSources">dataSources</a></code> | <code>string[]</code> | 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. |
2081
2359
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
2360
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.endpoint">endpoint</a></code> | <code>string</code> | The URL that users can use to access the Grafana console in the workspace. |
2361
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Specifies the version of Grafana supported by this workspace. |
2362
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.modificationTimestamp">modificationTimestamp</a></code> | <code>string</code> | The most recent date that the workspace was modified. |
2082
2363
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.name">name</a></code> | <code>string</code> | The name of the workspace. |
2083
2364
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.networkAccessControl">networkAccessControl</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a></code> | The configuration settings for network access to your workspace. |
2084
2365
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.notificationDestinations">notificationDestinations</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]</code> | 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. |
2085
2366
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.organizationalUnits">organizationalUnits</a></code> | <code>string[]</code> | 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. |
2086
2367
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.organizationRoleName">organizationRoleName</a></code> | <code>string</code> | The name of the IAM role that is used to access resources through Organizations. |
2368
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | 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. |
2087
2369
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether plugin administration is enabled in the workspace. |
2088
2370
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The IAM role that grants permissions to the AWS resources that the workspace will view data from. |
2089
2371
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.samlConfiguration">samlConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a></code> | 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. |
2372
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.samlConfigurationStatus">samlConfigurationStatus</a></code> | <code>string</code> | Specifies whether the workspace's SAML configuration is complete. |
2373
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.ssoClientId">ssoClientId</a></code> | <code>string</code> | The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana. |
2090
2374
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.stackSetName">stackSetName</a></code> | <code>string</code> | The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. |
2375
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.status">status</a></code> | <code>string</code> | The current status of the workspace. |
2091
2376
  | <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.vpcConfiguration">vpcConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a></code> | The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. |
2092
2377
 
2093
2378
  ---
@@ -2136,13 +2421,38 @@ The stack in which this resource is defined.
2136
2421
 
2137
2422
  ---
2138
2423
 
2139
- ##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.accountAccessType"></a>
2424
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceArn"></a>
2425
+
2426
+ ```typescript
2427
+ public readonly workspaceArn: string;
2428
+ ```
2429
+
2430
+ - *Type:* string
2431
+
2432
+ The ARN of this workspace.
2433
+
2434
+ ---
2435
+
2436
+ ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceId"></a>
2437
+
2438
+ ```typescript
2439
+ public readonly workspaceId: string;
2440
+ ```
2441
+
2442
+ - *Type:* string
2443
+
2444
+ The unique ID of this workspace.
2445
+
2446
+ ---
2447
+
2448
+ ##### `accountAccessType`<sup>Optional</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.accountAccessType"></a>
2140
2449
 
2141
2450
  ```typescript
2142
2451
  public readonly accountAccessType: AccountAccessType;
2143
2452
  ```
2144
2453
 
2145
2454
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
2455
+ - *Default:* not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
2146
2456
 
2147
2457
  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.
2148
2458
 
@@ -2152,96 +2462,111 @@ workspace can access.
2152
2462
 
2153
2463
  ---
2154
2464
 
2155
- ##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.authenticationProviders"></a>
2465
+ ##### `authenticationProviders`<sup>Optional</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.authenticationProviders"></a>
2156
2466
 
2157
2467
  ```typescript
2158
2468
  public readonly authenticationProviders: AuthenticationProviders[];
2159
2469
  ```
2160
2470
 
2161
2471
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
2472
+ - *Default:* not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
2162
2473
 
2163
2474
  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.
2164
2475
 
2165
2476
  ---
2166
2477
 
2167
- ##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.permissionType"></a>
2478
+ ##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.clientToken"></a>
2168
2479
 
2169
2480
  ```typescript
2170
- public readonly permissionType: PermissionTypes;
2481
+ public readonly clientToken: string;
2171
2482
  ```
2172
2483
 
2173
- - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
2484
+ - *Type:* string
2485
+ - *Default:* not available on imported workspaces
2174
2486
 
2175
- 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.
2487
+ A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
2176
2488
 
2177
- If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
2489
+ ---
2178
2490
 
2179
- If you are working with a workspace in a member account of an organization and that account is
2180
- not a delegated administrator account, and you want the workspace to access data sources in
2181
- other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
2491
+ ##### `creationTimestamp`<sup>Optional</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.creationTimestamp"></a>
2492
+
2493
+ ```typescript
2494
+ public readonly creationTimestamp: string;
2495
+ ```
2496
+
2497
+ - *Type:* string
2498
+ - *Default:* not available on imported workspaces
2499
+
2500
+ The date that the workspace was created.
2182
2501
 
2183
2502
  ---
2184
2503
 
2185
- ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceArn"></a>
2504
+ ##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.dataSources"></a>
2186
2505
 
2187
2506
  ```typescript
2188
- public readonly workspaceArn: string;
2507
+ public readonly dataSources: string[];
2189
2508
  ```
2190
2509
 
2191
- - *Type:* string
2510
+ - *Type:* string[]
2511
+ - *Default:* no data sources
2192
2512
 
2193
- The ARN of this workspace.
2513
+ 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.
2514
+
2515
+ This list is only used when the workspace was created through the AWS console, and the
2516
+ permissionType is SERVICE_MANAGED. The Amazon Managed Grafana API marks this parameter as for
2517
+ internal use only and recommends against setting it.
2194
2518
 
2195
2519
  ---
2196
2520
 
2197
- ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceId"></a>
2521
+ ##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.description"></a>
2198
2522
 
2199
2523
  ```typescript
2200
- public readonly workspaceId: string;
2524
+ public readonly description: string;
2201
2525
  ```
2202
2526
 
2203
2527
  - *Type:* string
2528
+ - *Default:* no description
2204
2529
 
2205
- The unique ID of this workspace.
2530
+ The user-defined description of the workspace.
2206
2531
 
2207
2532
  ---
2208
2533
 
2209
- ##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.clientToken"></a>
2534
+ ##### `endpoint`<sup>Optional</sup> <a name="endpoint" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.endpoint"></a>
2210
2535
 
2211
2536
  ```typescript
2212
- public readonly clientToken: string;
2537
+ public readonly endpoint: string;
2213
2538
  ```
2214
2539
 
2215
2540
  - *Type:* string
2541
+ - *Default:* not available on imported workspaces
2216
2542
 
2217
- A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
2543
+ The URL that users can use to access the Grafana console in the workspace.
2218
2544
 
2219
2545
  ---
2220
2546
 
2221
- ##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.dataSources"></a>
2547
+ ##### `grafanaVersion`<sup>Optional</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.grafanaVersion"></a>
2222
2548
 
2223
2549
  ```typescript
2224
- public readonly dataSources: string[];
2550
+ public readonly grafanaVersion: string;
2225
2551
  ```
2226
2552
 
2227
- - *Type:* string[]
2228
-
2229
- 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.
2553
+ - *Type:* string
2554
+ - *Default:* not available on imported workspaces
2230
2555
 
2231
- This list is only used when the workspace was created through the AWS console, and the
2232
- permissionType is SERVICE_MANAGED.
2556
+ Specifies the version of Grafana supported by this workspace.
2233
2557
 
2234
2558
  ---
2235
2559
 
2236
- ##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.description"></a>
2560
+ ##### `modificationTimestamp`<sup>Optional</sup> <a name="modificationTimestamp" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.modificationTimestamp"></a>
2237
2561
 
2238
2562
  ```typescript
2239
- public readonly description: string;
2563
+ public readonly modificationTimestamp: string;
2240
2564
  ```
2241
2565
 
2242
2566
  - *Type:* string
2567
+ - *Default:* not available on imported workspaces
2243
2568
 
2244
- The user-defined description of the workspace.
2569
+ The most recent date that the workspace was modified.
2245
2570
 
2246
2571
  ---
2247
2572
 
@@ -2252,6 +2577,7 @@ public readonly name: string;
2252
2577
  ```
2253
2578
 
2254
2579
  - *Type:* string
2580
+ - *Default:* a name is generated by CloudFormation
2255
2581
 
2256
2582
  The name of the workspace.
2257
2583
 
@@ -2264,6 +2590,7 @@ public readonly networkAccessControl: NetworkAccessControl;
2264
2590
  ```
2265
2591
 
2266
2592
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
2593
+ - *Default:* no network access control, the workspace is open to all traffic
2267
2594
 
2268
2595
  The configuration settings for network access to your workspace.
2269
2596
 
@@ -2276,6 +2603,7 @@ public readonly notificationDestinations: NotificationDestinations[];
2276
2603
  ```
2277
2604
 
2278
2605
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
2606
+ - *Default:* no notification destinations
2279
2607
 
2280
2608
  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.
2281
2609
 
@@ -2288,6 +2616,7 @@ public readonly organizationalUnits: string[];
2288
2616
  ```
2289
2617
 
2290
2618
  - *Type:* string[]
2619
+ - *Default:* no organizational units
2291
2620
 
2292
2621
  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.
2293
2622
 
@@ -2300,11 +2629,31 @@ public readonly organizationRoleName: string;
2300
2629
  ```
2301
2630
 
2302
2631
  - *Type:* string
2632
+ - *Default:* no organization role name
2303
2633
 
2304
2634
  The name of the IAM role that is used to access resources through Organizations.
2305
2635
 
2306
2636
  ---
2307
2637
 
2638
+ ##### `permissionType`<sup>Optional</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.permissionType"></a>
2639
+
2640
+ ```typescript
2641
+ public readonly permissionType: PermissionTypes;
2642
+ ```
2643
+
2644
+ - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
2645
+ - *Default:* not available on workspaces imported from an ARN via `Workspace.fromWorkspaceArn`
2646
+
2647
+ 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.
2648
+
2649
+ If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
2650
+
2651
+ If you are working with a workspace in a member account of an organization and that account is
2652
+ not a delegated administrator account, and you want the workspace to access data sources in
2653
+ other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
2654
+
2655
+ ---
2656
+
2308
2657
  ##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.pluginAdminEnabled"></a>
2309
2658
 
2310
2659
  ```typescript
@@ -2312,6 +2661,7 @@ public readonly pluginAdminEnabled: boolean;
2312
2661
  ```
2313
2662
 
2314
2663
  - *Type:* boolean
2664
+ - *Default:* false
2315
2665
 
2316
2666
  Whether plugin administration is enabled in the workspace.
2317
2667
 
@@ -2329,6 +2679,7 @@ public readonly role: IRole;
2329
2679
  ```
2330
2680
 
2331
2681
  - *Type:* aws-cdk-lib.aws_iam.IRole
2682
+ - *Default:* no role is attached
2332
2683
 
2333
2684
  The IAM role that grants permissions to the AWS resources that the workspace will view data from.
2334
2685
 
@@ -2341,11 +2692,38 @@ public readonly samlConfiguration: SamlConfiguration;
2341
2692
  ```
2342
2693
 
2343
2694
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
2695
+ - *Default:* no SAML configuration
2344
2696
 
2345
2697
  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.
2346
2698
 
2347
2699
  ---
2348
2700
 
2701
+ ##### `samlConfigurationStatus`<sup>Optional</sup> <a name="samlConfigurationStatus" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.samlConfigurationStatus"></a>
2702
+
2703
+ ```typescript
2704
+ public readonly samlConfigurationStatus: string;
2705
+ ```
2706
+
2707
+ - *Type:* string
2708
+ - *Default:* not available on imported workspaces
2709
+
2710
+ Specifies whether the workspace's SAML configuration is complete.
2711
+
2712
+ ---
2713
+
2714
+ ##### `ssoClientId`<sup>Optional</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.ssoClientId"></a>
2715
+
2716
+ ```typescript
2717
+ public readonly ssoClientId: string;
2718
+ ```
2719
+
2720
+ - *Type:* string
2721
+ - *Default:* not available on imported workspaces
2722
+
2723
+ The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
2724
+
2725
+ ---
2726
+
2349
2727
  ##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.stackSetName"></a>
2350
2728
 
2351
2729
  ```typescript
@@ -2353,11 +2731,25 @@ public readonly stackSetName: string;
2353
2731
  ```
2354
2732
 
2355
2733
  - *Type:* string
2734
+ - *Default:* no stack set name
2356
2735
 
2357
2736
  The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
2358
2737
 
2359
2738
  ---
2360
2739
 
2740
+ ##### `status`<sup>Optional</sup> <a name="status" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.status"></a>
2741
+
2742
+ ```typescript
2743
+ public readonly status: string;
2744
+ ```
2745
+
2746
+ - *Type:* string
2747
+ - *Default:* not available on imported workspaces
2748
+
2749
+ The current status of the workspace.
2750
+
2751
+ ---
2752
+
2361
2753
  ##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.vpcConfiguration"></a>
2362
2754
 
2363
2755
  ```typescript
@@ -2365,6 +2757,7 @@ public readonly vpcConfiguration: VpcConfiguration;
2365
2757
  ```
2366
2758
 
2367
2759
  - *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
2760
+ - *Default:* no VPC connection
2368
2761
 
2369
2762
  The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
2370
2763
 
@@ -2466,7 +2859,7 @@ other AWS accounts in the organization, this parameter must be set to CUSTOMER_M
2466
2859
  | **Name** | **Description** |
2467
2860
  | --- | --- |
2468
2861
  | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes.CUSTOMER_MANAGED">CUSTOMER_MANAGED</a></code> | Customer-managed permissions where you manage user access to Grafana. |
2469
- | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes.SERVICE_MANAGED">SERVICE_MANAGED</a></code> | Service-managed permissions where AWS manages user access to Grafana. |
2862
+ | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes.SERVICE_MANAGED">SERVICE_MANAGED</a></code> | Service-managed permissions, where Amazon Managed Grafana creates and manages the IAM roles. |
2470
2863
 
2471
2864
  ---
2472
2865
 
@@ -2479,7 +2872,11 @@ Customer-managed permissions where you manage user access to Grafana.
2479
2872
 
2480
2873
  ##### `SERVICE_MANAGED` <a name="SERVICE_MANAGED" id="@robhan-cdk-lib/aws_grafana.PermissionTypes.SERVICE_MANAGED"></a>
2481
2874
 
2482
- Service-managed permissions where AWS manages user access to Grafana.
2875
+ Service-managed permissions, where Amazon Managed Grafana creates and manages the IAM roles.
2876
+
2877
+ Per the Amazon Managed Grafana API, this value is valid only for workspaces created through the
2878
+ console; workspaces created via the API, CLI, or CloudFormation (including this construct) must
2879
+ use `CUSTOMER_MANAGED`.
2483
2880
 
2484
2881
  ---
2485
2882