@robhan-cdk-lib/aws_grafana 0.0.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.
- package/.jsii +5505 -0
- package/API.md +1340 -0
- package/LICENSE +19 -0
- package/README.md +47 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.js +12 -0
- package/lib/workspace.d.ts +624 -0
- package/lib/workspace.js +694 -0
- package/package.json +128 -0
package/API.md
ADDED
|
@@ -0,0 +1,1340 @@
|
|
|
1
|
+
# API Reference <a name="API Reference" id="api-reference"></a>
|
|
2
|
+
|
|
3
|
+
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
|
+
|
|
5
|
+
### Workspace <a name="Workspace" id="@robhan-cdk-lib/aws_grafana.Workspace"></a>
|
|
6
|
+
|
|
7
|
+
Represents an Amazon Managed Grafana workspace.
|
|
8
|
+
|
|
9
|
+
This class provides a high-level abstraction for creating and managing
|
|
10
|
+
Amazon Managed Grafana workspaces using AWS CDK.
|
|
11
|
+
|
|
12
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_grafana.Workspace.Initializer"></a>
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { Workspace } from '@robhan-cdk-lib/aws_grafana'
|
|
16
|
+
|
|
17
|
+
new Workspace(scope: Construct, id: string, props: WorkspaceProps)
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| **Name** | **Type** | **Description** |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | - The scope in which to define this construct. |
|
|
23
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.Initializer.parameter.id">id</a></code> | <code>string</code> | - The scoped construct ID. |
|
|
24
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps">WorkspaceProps</a></code> | - Configuration properties for the workspace. |
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_grafana.Workspace.Initializer.parameter.scope"></a>
|
|
29
|
+
|
|
30
|
+
- *Type:* constructs.Construct
|
|
31
|
+
|
|
32
|
+
The scope in which to define this construct.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_grafana.Workspace.Initializer.parameter.id"></a>
|
|
37
|
+
|
|
38
|
+
- *Type:* string
|
|
39
|
+
|
|
40
|
+
The scoped construct ID.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_grafana.Workspace.Initializer.parameter.props"></a>
|
|
45
|
+
|
|
46
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps">WorkspaceProps</a>
|
|
47
|
+
|
|
48
|
+
Configuration properties for the workspace.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
53
|
+
|
|
54
|
+
| **Name** | **Description** |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_grafana.Workspace.toString"></a>
|
|
61
|
+
|
|
62
|
+
```typescript
|
|
63
|
+
public toString(): string
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Returns a string representation of this construct.
|
|
67
|
+
|
|
68
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
69
|
+
|
|
70
|
+
| **Name** | **Description** |
|
|
71
|
+
| --- | --- |
|
|
72
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_grafana.Workspace.isConstruct"></a>
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
import { Workspace } from '@robhan-cdk-lib/aws_grafana'
|
|
80
|
+
|
|
81
|
+
Workspace.isConstruct(x: any)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Checks if `x` is a construct.
|
|
85
|
+
|
|
86
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_grafana.Workspace.isConstruct.parameter.x"></a>
|
|
87
|
+
|
|
88
|
+
- *Type:* any
|
|
89
|
+
|
|
90
|
+
Any object.
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
95
|
+
|
|
96
|
+
| **Name** | **Type** | **Description** |
|
|
97
|
+
| --- | --- | --- |
|
|
98
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
99
|
+
| <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> | The type of account access for the workspace. |
|
|
100
|
+
| <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> | Authentication providers enabled for the workspace. |
|
|
101
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | Timestamp when the workspace was created. |
|
|
102
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint">endpoint</a></code> | <code>string</code> | Endpoint URL for the Grafana workspace. |
|
|
103
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Grafana version running in the workspace. |
|
|
104
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.id">id</a></code> | <code>string</code> | Unique identifier for the workspace. |
|
|
105
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp">modificationTimestamp</a></code> | <code>string</code> | Timestamp when the workspace was last modified. |
|
|
106
|
+
| <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> | Permission type for the workspace. |
|
|
107
|
+
| <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> | Status of SAML configuration for the workspace. |
|
|
108
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId">ssoClientId</a></code> | <code>string</code> | SSO client ID for the workspace. |
|
|
109
|
+
| <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> | Current status of the workspace. |
|
|
110
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.clientToken">clientToken</a></code> | <code>string</code> | Client token used for idempotent workspace creation. |
|
|
111
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.dataSources">dataSources</a></code> | <code>string[]</code> | Data sources enabled for the workspace. |
|
|
112
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.description">description</a></code> | <code>string</code> | Description of the workspace. |
|
|
113
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.name">name</a></code> | <code>string</code> | Name of the workspace. |
|
|
114
|
+
| <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> | Network access control configuration for the workspace. |
|
|
115
|
+
| <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> | Notification destinations enabled for the workspace. |
|
|
116
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.organizationalUnits">organizationalUnits</a></code> | <code>string[]</code> | Organizational units included in the workspace. |
|
|
117
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.organizationRoleName">organizationRoleName</a></code> | <code>string</code> | Name of the IAM role used for the organization. |
|
|
118
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether the Grafana plugin admin page is enabled. |
|
|
119
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | IAM role used for the workspace. |
|
|
120
|
+
| <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> | SAML configuration for the workspace. |
|
|
121
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.stackSetName">stackSetName</a></code> | <code>string</code> | Name of the CloudFormation stack set used. |
|
|
122
|
+
| <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> | VPC configuration for the workspace. |
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_grafana.Workspace.property.node"></a>
|
|
127
|
+
|
|
128
|
+
```typescript
|
|
129
|
+
public readonly node: Node;
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
- *Type:* constructs.Node
|
|
133
|
+
|
|
134
|
+
The tree node.
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.accountAccessType"></a>
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
public readonly accountAccessType: AccountAccessType;
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
145
|
+
|
|
146
|
+
The type of account access for the workspace.
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders"></a>
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
public readonly authenticationProviders: AuthenticationProviders[];
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
|
|
157
|
+
|
|
158
|
+
Authentication providers enabled for the workspace.
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
##### `creationTimestamp`<sup>Required</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp"></a>
|
|
163
|
+
|
|
164
|
+
```typescript
|
|
165
|
+
public readonly creationTimestamp: string;
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
- *Type:* string
|
|
169
|
+
|
|
170
|
+
Timestamp when the workspace was created.
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
##### `endpoint`<sup>Required</sup> <a name="endpoint" id="@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint"></a>
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
public readonly endpoint: string;
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
- *Type:* string
|
|
181
|
+
|
|
182
|
+
Endpoint URL for the Grafana workspace.
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
##### `grafanaVersion`<sup>Required</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion"></a>
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
public readonly grafanaVersion: string;
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
- *Type:* string
|
|
193
|
+
|
|
194
|
+
Grafana version running in the workspace.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_grafana.Workspace.property.id"></a>
|
|
199
|
+
|
|
200
|
+
```typescript
|
|
201
|
+
public readonly id: string;
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
- *Type:* string
|
|
205
|
+
|
|
206
|
+
Unique identifier for the workspace.
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
##### `modificationTimestamp`<sup>Required</sup> <a name="modificationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp"></a>
|
|
211
|
+
|
|
212
|
+
```typescript
|
|
213
|
+
public readonly modificationTimestamp: string;
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
- *Type:* string
|
|
217
|
+
|
|
218
|
+
Timestamp when the workspace was last modified.
|
|
219
|
+
|
|
220
|
+
---
|
|
221
|
+
|
|
222
|
+
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.permissionType"></a>
|
|
223
|
+
|
|
224
|
+
```typescript
|
|
225
|
+
public readonly permissionType: PermissionTypes;
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
|
|
229
|
+
|
|
230
|
+
Permission type for the workspace.
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
##### `samlConfigurationStatus`<sup>Required</sup> <a name="samlConfigurationStatus" id="@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfigurationStatus"></a>
|
|
235
|
+
|
|
236
|
+
```typescript
|
|
237
|
+
public readonly samlConfigurationStatus: SamlConfigurationStatuses;
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses">SamlConfigurationStatuses</a>
|
|
241
|
+
|
|
242
|
+
Status of SAML configuration for the workspace.
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
##### `ssoClientId`<sup>Required</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId"></a>
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
public readonly ssoClientId: string;
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
- *Type:* string
|
|
253
|
+
|
|
254
|
+
SSO client ID for the workspace.
|
|
255
|
+
|
|
256
|
+
---
|
|
257
|
+
|
|
258
|
+
##### `status`<sup>Required</sup> <a name="status" id="@robhan-cdk-lib/aws_grafana.Workspace.property.status"></a>
|
|
259
|
+
|
|
260
|
+
```typescript
|
|
261
|
+
public readonly status: Status;
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.Status">Status</a>
|
|
265
|
+
|
|
266
|
+
Current status of the workspace.
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.Workspace.property.clientToken"></a>
|
|
271
|
+
|
|
272
|
+
```typescript
|
|
273
|
+
public readonly clientToken: string;
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
- *Type:* string
|
|
277
|
+
|
|
278
|
+
Client token used for idempotent workspace creation.
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.Workspace.property.dataSources"></a>
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
public readonly dataSources: string[];
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
- *Type:* string[]
|
|
289
|
+
|
|
290
|
+
Data sources enabled for the workspace.
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.Workspace.property.description"></a>
|
|
295
|
+
|
|
296
|
+
```typescript
|
|
297
|
+
public readonly description: string;
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
- *Type:* string
|
|
301
|
+
|
|
302
|
+
Description of the workspace.
|
|
303
|
+
|
|
304
|
+
---
|
|
305
|
+
|
|
306
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.Workspace.property.name"></a>
|
|
307
|
+
|
|
308
|
+
```typescript
|
|
309
|
+
public readonly name: string;
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
- *Type:* string
|
|
313
|
+
|
|
314
|
+
Name of the workspace.
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.Workspace.property.networkAccessControl"></a>
|
|
319
|
+
|
|
320
|
+
```typescript
|
|
321
|
+
public readonly networkAccessControl: NetworkAccessControl;
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
|
|
325
|
+
|
|
326
|
+
Network access control configuration for the workspace.
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.Workspace.property.notificationDestinations"></a>
|
|
331
|
+
|
|
332
|
+
```typescript
|
|
333
|
+
public readonly notificationDestinations: NotificationDestinations[];
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
|
|
337
|
+
|
|
338
|
+
Notification destinations enabled for the workspace.
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.Workspace.property.organizationalUnits"></a>
|
|
343
|
+
|
|
344
|
+
```typescript
|
|
345
|
+
public readonly organizationalUnits: string[];
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
- *Type:* string[]
|
|
349
|
+
|
|
350
|
+
Organizational units included in the workspace.
|
|
351
|
+
|
|
352
|
+
---
|
|
353
|
+
|
|
354
|
+
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.Workspace.property.organizationRoleName"></a>
|
|
355
|
+
|
|
356
|
+
```typescript
|
|
357
|
+
public readonly organizationRoleName: string;
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
- *Type:* string
|
|
361
|
+
|
|
362
|
+
Name of the IAM role used for the organization.
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.Workspace.property.pluginAdminEnabled"></a>
|
|
367
|
+
|
|
368
|
+
```typescript
|
|
369
|
+
public readonly pluginAdminEnabled: boolean;
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
- *Type:* boolean
|
|
373
|
+
|
|
374
|
+
Whether the Grafana plugin admin page is enabled.
|
|
375
|
+
|
|
376
|
+
---
|
|
377
|
+
|
|
378
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.Workspace.property.role"></a>
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
public readonly role: IRole;
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
385
|
+
|
|
386
|
+
IAM role used for the workspace.
|
|
387
|
+
|
|
388
|
+
---
|
|
389
|
+
|
|
390
|
+
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfiguration"></a>
|
|
391
|
+
|
|
392
|
+
```typescript
|
|
393
|
+
public readonly samlConfiguration: SamlConfiguration;
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
|
|
397
|
+
|
|
398
|
+
SAML configuration for the workspace.
|
|
399
|
+
|
|
400
|
+
---
|
|
401
|
+
|
|
402
|
+
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.Workspace.property.stackSetName"></a>
|
|
403
|
+
|
|
404
|
+
```typescript
|
|
405
|
+
public readonly stackSetName: string;
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
- *Type:* string
|
|
409
|
+
|
|
410
|
+
Name of the CloudFormation stack set used.
|
|
411
|
+
|
|
412
|
+
---
|
|
413
|
+
|
|
414
|
+
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.Workspace.property.vpcConfiguration"></a>
|
|
415
|
+
|
|
416
|
+
```typescript
|
|
417
|
+
public readonly vpcConfiguration: VpcConfiguration;
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
|
|
421
|
+
|
|
422
|
+
VPC configuration for the workspace.
|
|
423
|
+
|
|
424
|
+
---
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
428
|
+
|
|
429
|
+
### NetworkAccessControl <a name="NetworkAccessControl" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl"></a>
|
|
430
|
+
|
|
431
|
+
The configuration settings for network access to your workspace.
|
|
432
|
+
|
|
433
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.Initializer"></a>
|
|
434
|
+
|
|
435
|
+
```typescript
|
|
436
|
+
import { NetworkAccessControl } from '@robhan-cdk-lib/aws_grafana'
|
|
437
|
+
|
|
438
|
+
const networkAccessControl: NetworkAccessControl = { ... }
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
442
|
+
|
|
443
|
+
| **Name** | **Type** | **Description** |
|
|
444
|
+
| --- | --- | --- |
|
|
445
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl.property.prefixLists">prefixLists</a></code> | <code>aws-cdk-lib.aws_ec2.IPrefixList[]</code> | An array of prefix list IDs. |
|
|
446
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl.property.vpcEndpoints">vpcEndpoints</a></code> | <code>aws-cdk-lib.aws_ec2.IVpcEndpoint[]</code> | An array of Amazon VPC endpoint IDs for the workspace. |
|
|
447
|
+
|
|
448
|
+
---
|
|
449
|
+
|
|
450
|
+
##### `prefixLists`<sup>Optional</sup> <a name="prefixLists" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.property.prefixLists"></a>
|
|
451
|
+
|
|
452
|
+
```typescript
|
|
453
|
+
public readonly prefixLists: IPrefixList[];
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
- *Type:* aws-cdk-lib.aws_ec2.IPrefixList[]
|
|
457
|
+
|
|
458
|
+
An array of prefix list IDs.
|
|
459
|
+
|
|
460
|
+
A prefix list is a list of CIDR ranges of IP addresses. The IP
|
|
461
|
+
addresses specified are allowed to access your workspace. If the list is not included in the
|
|
462
|
+
configuration (passed an empty array) then no IP addresses are allowed to access the
|
|
463
|
+
workspace.
|
|
464
|
+
|
|
465
|
+
Maximum of 5 prefix lists allowed.
|
|
466
|
+
|
|
467
|
+
---
|
|
468
|
+
|
|
469
|
+
##### `vpcEndpoints`<sup>Optional</sup> <a name="vpcEndpoints" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.property.vpcEndpoints"></a>
|
|
470
|
+
|
|
471
|
+
```typescript
|
|
472
|
+
public readonly vpcEndpoints: IVpcEndpoint[];
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
- *Type:* aws-cdk-lib.aws_ec2.IVpcEndpoint[]
|
|
476
|
+
|
|
477
|
+
An array of Amazon VPC endpoint IDs for the workspace.
|
|
478
|
+
|
|
479
|
+
You can create VPC endpoints to your
|
|
480
|
+
Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration
|
|
481
|
+
is specified then only VPC endpoints specified here are allowed to access the workspace. If
|
|
482
|
+
you pass in an empty array of strings, then no VPCs are allowed to access the workspace.
|
|
483
|
+
|
|
484
|
+
Maximum of 5 VPC endpoints allowed.
|
|
485
|
+
|
|
486
|
+
---
|
|
487
|
+
|
|
488
|
+
### SamlAssertionAttributes <a name="SamlAssertionAttributes" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes"></a>
|
|
489
|
+
|
|
490
|
+
A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.
|
|
491
|
+
|
|
492
|
+
Each attribute must be a string with length between 1 and 256 characters.
|
|
493
|
+
|
|
494
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.Initializer"></a>
|
|
495
|
+
|
|
496
|
+
```typescript
|
|
497
|
+
import { SamlAssertionAttributes } from '@robhan-cdk-lib/aws_grafana'
|
|
498
|
+
|
|
499
|
+
const samlAssertionAttributes: SamlAssertionAttributes = { ... }
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
503
|
+
|
|
504
|
+
| **Name** | **Type** | **Description** |
|
|
505
|
+
| --- | --- | --- |
|
|
506
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.email">email</a></code> | <code>string</code> | The name of the attribute within the SAML assertion to use as the email names for SAML users. |
|
|
507
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.groups">groups</a></code> | <code>string</code> | The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups. |
|
|
508
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.login">login</a></code> | <code>string</code> | The name of the attribute within the SAML assertion to use as the login names for SAML users. |
|
|
509
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.name">name</a></code> | <code>string</code> | The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users. |
|
|
510
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.org">org</a></code> | <code>string</code> | The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations. |
|
|
511
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.role">role</a></code> | <code>string</code> | The name of the attribute within the SAML assertion to use as the user roles. |
|
|
512
|
+
|
|
513
|
+
---
|
|
514
|
+
|
|
515
|
+
##### `email`<sup>Required</sup> <a name="email" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.email"></a>
|
|
516
|
+
|
|
517
|
+
```typescript
|
|
518
|
+
public readonly email: string;
|
|
519
|
+
```
|
|
520
|
+
|
|
521
|
+
- *Type:* string
|
|
522
|
+
|
|
523
|
+
The name of the attribute within the SAML assertion to use as the email names for SAML users.
|
|
524
|
+
|
|
525
|
+
Must be between 1 and 256 characters long.
|
|
526
|
+
|
|
527
|
+
---
|
|
528
|
+
|
|
529
|
+
##### `groups`<sup>Required</sup> <a name="groups" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.groups"></a>
|
|
530
|
+
|
|
531
|
+
```typescript
|
|
532
|
+
public readonly groups: string;
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
- *Type:* string
|
|
536
|
+
|
|
537
|
+
The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
|
|
538
|
+
|
|
539
|
+
Must be between 1 and 256 characters long.
|
|
540
|
+
|
|
541
|
+
---
|
|
542
|
+
|
|
543
|
+
##### `login`<sup>Required</sup> <a name="login" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.login"></a>
|
|
544
|
+
|
|
545
|
+
```typescript
|
|
546
|
+
public readonly login: string;
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
- *Type:* string
|
|
550
|
+
|
|
551
|
+
The name of the attribute within the SAML assertion to use as the login names for SAML users.
|
|
552
|
+
|
|
553
|
+
Must be between 1 and 256 characters long.
|
|
554
|
+
|
|
555
|
+
---
|
|
556
|
+
|
|
557
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.name"></a>
|
|
558
|
+
|
|
559
|
+
```typescript
|
|
560
|
+
public readonly name: string;
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
- *Type:* string
|
|
564
|
+
|
|
565
|
+
The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
|
|
566
|
+
|
|
567
|
+
Must be between 1 and 256 characters long.
|
|
568
|
+
|
|
569
|
+
---
|
|
570
|
+
|
|
571
|
+
##### `org`<sup>Required</sup> <a name="org" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.org"></a>
|
|
572
|
+
|
|
573
|
+
```typescript
|
|
574
|
+
public readonly org: string;
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
- *Type:* string
|
|
578
|
+
|
|
579
|
+
The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
|
|
580
|
+
|
|
581
|
+
Must be between 1 and 256 characters long.
|
|
582
|
+
|
|
583
|
+
---
|
|
584
|
+
|
|
585
|
+
##### `role`<sup>Required</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.role"></a>
|
|
586
|
+
|
|
587
|
+
```typescript
|
|
588
|
+
public readonly role: string;
|
|
589
|
+
```
|
|
590
|
+
|
|
591
|
+
- *Type:* string
|
|
592
|
+
|
|
593
|
+
The name of the attribute within the SAML assertion to use as the user roles.
|
|
594
|
+
|
|
595
|
+
Must be between 1 and 256 characters long.
|
|
596
|
+
|
|
597
|
+
---
|
|
598
|
+
|
|
599
|
+
### SamlConfiguration <a name="SamlConfiguration" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration"></a>
|
|
600
|
+
|
|
601
|
+
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.
|
|
602
|
+
|
|
603
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.Initializer"></a>
|
|
604
|
+
|
|
605
|
+
```typescript
|
|
606
|
+
import { SamlConfiguration } from '@robhan-cdk-lib/aws_grafana'
|
|
607
|
+
|
|
608
|
+
const samlConfiguration: SamlConfiguration = { ... }
|
|
609
|
+
```
|
|
610
|
+
|
|
611
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
612
|
+
|
|
613
|
+
| **Name** | **Type** | **Description** |
|
|
614
|
+
| --- | --- | --- |
|
|
615
|
+
| <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. |
|
|
616
|
+
| <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. |
|
|
617
|
+
| <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. |
|
|
618
|
+
| <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. |
|
|
619
|
+
| <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. |
|
|
620
|
+
|
|
621
|
+
---
|
|
622
|
+
|
|
623
|
+
##### `idpMetadata`<sup>Required</sup> <a name="idpMetadata" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.idpMetadata"></a>
|
|
624
|
+
|
|
625
|
+
```typescript
|
|
626
|
+
public readonly idpMetadata: SamlIdpMetadata;
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata">SamlIdpMetadata</a>
|
|
630
|
+
|
|
631
|
+
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
|
|
632
|
+
|
|
633
|
+
Required field for SAML configuration.
|
|
634
|
+
|
|
635
|
+
---
|
|
636
|
+
|
|
637
|
+
##### `allowedOrganizations`<sup>Optional</sup> <a name="allowedOrganizations" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.allowedOrganizations"></a>
|
|
638
|
+
|
|
639
|
+
```typescript
|
|
640
|
+
public readonly allowedOrganizations: string[];
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
- *Type:* string[]
|
|
644
|
+
|
|
645
|
+
Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
|
|
646
|
+
|
|
647
|
+
If this is empty, all organizations in the assertion attribute have access.
|
|
648
|
+
|
|
649
|
+
Must have between 1 and 256 elements.
|
|
650
|
+
|
|
651
|
+
---
|
|
652
|
+
|
|
653
|
+
##### `assertionAtrributes`<sup>Optional</sup> <a name="assertionAtrributes" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.assertionAtrributes"></a>
|
|
654
|
+
|
|
655
|
+
```typescript
|
|
656
|
+
public readonly assertionAtrributes: SamlAssertionAttributes;
|
|
657
|
+
```
|
|
658
|
+
|
|
659
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes">SamlAssertionAttributes</a>
|
|
660
|
+
|
|
661
|
+
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.
|
|
662
|
+
|
|
663
|
+
---
|
|
664
|
+
|
|
665
|
+
##### `loginValidityDuration`<sup>Optional</sup> <a name="loginValidityDuration" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.loginValidityDuration"></a>
|
|
666
|
+
|
|
667
|
+
```typescript
|
|
668
|
+
public readonly loginValidityDuration: number;
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
- *Type:* number
|
|
672
|
+
|
|
673
|
+
How long a sign-on session by a SAML user is valid, before the user has to sign on again.
|
|
674
|
+
|
|
675
|
+
Must be a positive number.
|
|
676
|
+
|
|
677
|
+
---
|
|
678
|
+
|
|
679
|
+
##### `roleValues`<sup>Optional</sup> <a name="roleValues" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.roleValues"></a>
|
|
680
|
+
|
|
681
|
+
```typescript
|
|
682
|
+
public readonly roleValues: SamlRoleValues;
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlRoleValues">SamlRoleValues</a>
|
|
686
|
+
|
|
687
|
+
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
|
|
688
|
+
|
|
689
|
+
---
|
|
690
|
+
|
|
691
|
+
### SamlIdpMetadata <a name="SamlIdpMetadata" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata"></a>
|
|
692
|
+
|
|
693
|
+
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
|
|
694
|
+
|
|
695
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.Initializer"></a>
|
|
696
|
+
|
|
697
|
+
```typescript
|
|
698
|
+
import { SamlIdpMetadata } from '@robhan-cdk-lib/aws_grafana'
|
|
699
|
+
|
|
700
|
+
const samlIdpMetadata: SamlIdpMetadata = { ... }
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
704
|
+
|
|
705
|
+
| **Name** | **Type** | **Description** |
|
|
706
|
+
| --- | --- | --- |
|
|
707
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.url">url</a></code> | <code>string</code> | The URL of the location containing the IdP metadata. |
|
|
708
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.xml">xml</a></code> | <code>string</code> | The full IdP metadata, in XML format. |
|
|
709
|
+
|
|
710
|
+
---
|
|
711
|
+
|
|
712
|
+
##### `url`<sup>Optional</sup> <a name="url" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.url"></a>
|
|
713
|
+
|
|
714
|
+
```typescript
|
|
715
|
+
public readonly url: string;
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
- *Type:* string
|
|
719
|
+
|
|
720
|
+
The URL of the location containing the IdP metadata.
|
|
721
|
+
|
|
722
|
+
Must be a string with length between 1 and 2048 characters.
|
|
723
|
+
|
|
724
|
+
---
|
|
725
|
+
|
|
726
|
+
##### `xml`<sup>Optional</sup> <a name="xml" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.xml"></a>
|
|
727
|
+
|
|
728
|
+
```typescript
|
|
729
|
+
public readonly xml: string;
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
- *Type:* string
|
|
733
|
+
|
|
734
|
+
The full IdP metadata, in XML format.
|
|
735
|
+
|
|
736
|
+
---
|
|
737
|
+
|
|
738
|
+
### SamlRoleValues <a name="SamlRoleValues" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues"></a>
|
|
739
|
+
|
|
740
|
+
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
|
|
741
|
+
|
|
742
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.Initializer"></a>
|
|
743
|
+
|
|
744
|
+
```typescript
|
|
745
|
+
import { SamlRoleValues } from '@robhan-cdk-lib/aws_grafana'
|
|
746
|
+
|
|
747
|
+
const samlRoleValues: SamlRoleValues = { ... }
|
|
748
|
+
```
|
|
749
|
+
|
|
750
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
751
|
+
|
|
752
|
+
| **Name** | **Type** | **Description** |
|
|
753
|
+
| --- | --- | --- |
|
|
754
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlRoleValues.property.admin">admin</a></code> | <code>string[]</code> | A list of groups from the SAML assertion attribute to grant the Grafana Admin role to. |
|
|
755
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlRoleValues.property.editor">editor</a></code> | <code>string[]</code> | A list of groups from the SAML assertion attribute to grant the Grafana Editor role to. |
|
|
756
|
+
|
|
757
|
+
---
|
|
758
|
+
|
|
759
|
+
##### `admin`<sup>Optional</sup> <a name="admin" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.property.admin"></a>
|
|
760
|
+
|
|
761
|
+
```typescript
|
|
762
|
+
public readonly admin: string[];
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
- *Type:* string[]
|
|
766
|
+
|
|
767
|
+
A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
|
|
768
|
+
|
|
769
|
+
Maximum of 256 elements.
|
|
770
|
+
|
|
771
|
+
---
|
|
772
|
+
|
|
773
|
+
##### `editor`<sup>Optional</sup> <a name="editor" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.property.editor"></a>
|
|
774
|
+
|
|
775
|
+
```typescript
|
|
776
|
+
public readonly editor: string[];
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
- *Type:* string[]
|
|
780
|
+
|
|
781
|
+
A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
|
|
782
|
+
|
|
783
|
+
Maximum of 256 elements.
|
|
784
|
+
|
|
785
|
+
---
|
|
786
|
+
|
|
787
|
+
### VpcConfiguration <a name="VpcConfiguration" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration"></a>
|
|
788
|
+
|
|
789
|
+
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
|
|
790
|
+
|
|
791
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration.Initializer"></a>
|
|
792
|
+
|
|
793
|
+
```typescript
|
|
794
|
+
import { VpcConfiguration } from '@robhan-cdk-lib/aws_grafana'
|
|
795
|
+
|
|
796
|
+
const vpcConfiguration: VpcConfiguration = { ... }
|
|
797
|
+
```
|
|
798
|
+
|
|
799
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
800
|
+
|
|
801
|
+
| **Name** | **Type** | **Description** |
|
|
802
|
+
| --- | --- | --- |
|
|
803
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | The list of Amazon EC2 security groups attached to the Amazon VPC for your Grafana workspace to connect. |
|
|
804
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration.property.subnets">subnets</a></code> | <code>aws-cdk-lib.aws_ec2.ISubnet[]</code> | The list of Amazon EC2 subnets created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed. |
|
|
805
|
+
|
|
806
|
+
---
|
|
807
|
+
|
|
808
|
+
##### `securityGroups`<sup>Required</sup> <a name="securityGroups" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration.property.securityGroups"></a>
|
|
809
|
+
|
|
810
|
+
```typescript
|
|
811
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
812
|
+
```
|
|
813
|
+
|
|
814
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
815
|
+
|
|
816
|
+
The list of Amazon EC2 security groups attached to the Amazon VPC for your Grafana workspace to connect.
|
|
817
|
+
|
|
818
|
+
Duplicates not allowed.
|
|
819
|
+
|
|
820
|
+
Array Members: Minimum number of 1 items. Maximum number of 5 items.
|
|
821
|
+
|
|
822
|
+
Required for VPC configuration.
|
|
823
|
+
|
|
824
|
+
---
|
|
825
|
+
|
|
826
|
+
##### `subnets`<sup>Required</sup> <a name="subnets" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration.property.subnets"></a>
|
|
827
|
+
|
|
828
|
+
```typescript
|
|
829
|
+
public readonly subnets: ISubnet[];
|
|
830
|
+
```
|
|
831
|
+
|
|
832
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISubnet[]
|
|
833
|
+
|
|
834
|
+
The list of Amazon EC2 subnets created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
|
|
835
|
+
|
|
836
|
+
Array Members: Minimum number of 2 items. Maximum number of 6 items.
|
|
837
|
+
|
|
838
|
+
Required for VPC configuration.
|
|
839
|
+
|
|
840
|
+
---
|
|
841
|
+
|
|
842
|
+
### WorkspaceProps <a name="WorkspaceProps" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps"></a>
|
|
843
|
+
|
|
844
|
+
Properties for creating an Amazon Managed Grafana workspace.
|
|
845
|
+
|
|
846
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.Initializer"></a>
|
|
847
|
+
|
|
848
|
+
```typescript
|
|
849
|
+
import { WorkspaceProps } from '@robhan-cdk-lib/aws_grafana'
|
|
850
|
+
|
|
851
|
+
const workspaceProps: WorkspaceProps = { ... }
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
855
|
+
|
|
856
|
+
| **Name** | **Type** | **Description** |
|
|
857
|
+
| --- | --- | --- |
|
|
858
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.accountAccessType">accountAccessType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a></code> | Type of account access for the workspace. |
|
|
859
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.authenticationProviders">authenticationProviders</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]</code> | Authentication providers to enable for the workspace. |
|
|
860
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.permissionType">permissionType</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a></code> | Permission type for the workspace. |
|
|
861
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.clientToken">clientToken</a></code> | <code>string</code> | Client token for idempotent workspace creation. |
|
|
862
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.dataSources">dataSources</a></code> | <code>string[]</code> | List of data sources to enable for the workspace. |
|
|
863
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.description">description</a></code> | <code>string</code> | Description of the workspace. |
|
|
864
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Grafana version for the workspace. |
|
|
865
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.name">name</a></code> | <code>string</code> | Name of the workspace. |
|
|
866
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.networkAccessControl">networkAccessControl</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a></code> | Network access control configuration for the workspace. |
|
|
867
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.notificationDestinations">notificationDestinations</a></code> | <code><a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]</code> | Notification destinations to enable for the workspace. |
|
|
868
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.organizationalUnits">organizationalUnits</a></code> | <code>string[]</code> | List of organizational units to include in the workspace. |
|
|
869
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.organizationRoleName">organizationRoleName</a></code> | <code>string</code> | Name of the IAM role to use for the organization. |
|
|
870
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether to enable the Grafana plugin admin page. |
|
|
871
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.role">role</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | IAM role to use for the workspace. |
|
|
872
|
+
| <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> | SAML configuration for the workspace. |
|
|
873
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.stackSetName">stackSetName</a></code> | <code>string</code> | Name of the CloudFormation stack set to use. |
|
|
874
|
+
| <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> | VPC configuration for the workspace. |
|
|
875
|
+
|
|
876
|
+
---
|
|
877
|
+
|
|
878
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.accountAccessType"></a>
|
|
879
|
+
|
|
880
|
+
```typescript
|
|
881
|
+
public readonly accountAccessType: AccountAccessType;
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
885
|
+
|
|
886
|
+
Type of account access for the workspace.
|
|
887
|
+
|
|
888
|
+
Required field.
|
|
889
|
+
|
|
890
|
+
---
|
|
891
|
+
|
|
892
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.authenticationProviders"></a>
|
|
893
|
+
|
|
894
|
+
```typescript
|
|
895
|
+
public readonly authenticationProviders: AuthenticationProviders[];
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
|
|
899
|
+
|
|
900
|
+
Authentication providers to enable for the workspace.
|
|
901
|
+
|
|
902
|
+
Required field.
|
|
903
|
+
|
|
904
|
+
---
|
|
905
|
+
|
|
906
|
+
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.permissionType"></a>
|
|
907
|
+
|
|
908
|
+
```typescript
|
|
909
|
+
public readonly permissionType: PermissionTypes;
|
|
910
|
+
```
|
|
911
|
+
|
|
912
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
|
|
913
|
+
|
|
914
|
+
Permission type for the workspace.
|
|
915
|
+
|
|
916
|
+
Required field.
|
|
917
|
+
|
|
918
|
+
---
|
|
919
|
+
|
|
920
|
+
##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.clientToken"></a>
|
|
921
|
+
|
|
922
|
+
```typescript
|
|
923
|
+
public readonly clientToken: string;
|
|
924
|
+
```
|
|
925
|
+
|
|
926
|
+
- *Type:* string
|
|
927
|
+
|
|
928
|
+
Client token for idempotent workspace creation.
|
|
929
|
+
|
|
930
|
+
Must be 1-64 characters long and contain only printable ASCII characters.
|
|
931
|
+
|
|
932
|
+
---
|
|
933
|
+
|
|
934
|
+
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.dataSources"></a>
|
|
935
|
+
|
|
936
|
+
```typescript
|
|
937
|
+
public readonly dataSources: string[];
|
|
938
|
+
```
|
|
939
|
+
|
|
940
|
+
- *Type:* string[]
|
|
941
|
+
|
|
942
|
+
List of data sources to enable for the workspace.
|
|
943
|
+
|
|
944
|
+
---
|
|
945
|
+
|
|
946
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.description"></a>
|
|
947
|
+
|
|
948
|
+
```typescript
|
|
949
|
+
public readonly description: string;
|
|
950
|
+
```
|
|
951
|
+
|
|
952
|
+
- *Type:* string
|
|
953
|
+
|
|
954
|
+
Description of the workspace.
|
|
955
|
+
|
|
956
|
+
Maximum length of 2048 characters.
|
|
957
|
+
|
|
958
|
+
---
|
|
959
|
+
|
|
960
|
+
##### `grafanaVersion`<sup>Optional</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.grafanaVersion"></a>
|
|
961
|
+
|
|
962
|
+
```typescript
|
|
963
|
+
public readonly grafanaVersion: string;
|
|
964
|
+
```
|
|
965
|
+
|
|
966
|
+
- *Type:* string
|
|
967
|
+
|
|
968
|
+
Grafana version for the workspace.
|
|
969
|
+
|
|
970
|
+
Must be 1-255 characters long.
|
|
971
|
+
|
|
972
|
+
---
|
|
973
|
+
|
|
974
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.name"></a>
|
|
975
|
+
|
|
976
|
+
```typescript
|
|
977
|
+
public readonly name: string;
|
|
978
|
+
```
|
|
979
|
+
|
|
980
|
+
- *Type:* string
|
|
981
|
+
|
|
982
|
+
Name of the workspace.
|
|
983
|
+
|
|
984
|
+
Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots, underscores, and tildes.
|
|
985
|
+
|
|
986
|
+
---
|
|
987
|
+
|
|
988
|
+
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.networkAccessControl"></a>
|
|
989
|
+
|
|
990
|
+
```typescript
|
|
991
|
+
public readonly networkAccessControl: NetworkAccessControl;
|
|
992
|
+
```
|
|
993
|
+
|
|
994
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
|
|
995
|
+
|
|
996
|
+
Network access control configuration for the workspace.
|
|
997
|
+
|
|
998
|
+
---
|
|
999
|
+
|
|
1000
|
+
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.notificationDestinations"></a>
|
|
1001
|
+
|
|
1002
|
+
```typescript
|
|
1003
|
+
public readonly notificationDestinations: NotificationDestinations[];
|
|
1004
|
+
```
|
|
1005
|
+
|
|
1006
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
|
|
1007
|
+
|
|
1008
|
+
Notification destinations to enable for the workspace.
|
|
1009
|
+
|
|
1010
|
+
---
|
|
1011
|
+
|
|
1012
|
+
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.organizationalUnits"></a>
|
|
1013
|
+
|
|
1014
|
+
```typescript
|
|
1015
|
+
public readonly organizationalUnits: string[];
|
|
1016
|
+
```
|
|
1017
|
+
|
|
1018
|
+
- *Type:* string[]
|
|
1019
|
+
|
|
1020
|
+
List of organizational units to include in the workspace.
|
|
1021
|
+
|
|
1022
|
+
---
|
|
1023
|
+
|
|
1024
|
+
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.organizationRoleName"></a>
|
|
1025
|
+
|
|
1026
|
+
```typescript
|
|
1027
|
+
public readonly organizationRoleName: string;
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
- *Type:* string
|
|
1031
|
+
|
|
1032
|
+
Name of the IAM role to use for the organization.
|
|
1033
|
+
|
|
1034
|
+
Maximum length of 2048 characters.
|
|
1035
|
+
|
|
1036
|
+
---
|
|
1037
|
+
|
|
1038
|
+
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.pluginAdminEnabled"></a>
|
|
1039
|
+
|
|
1040
|
+
```typescript
|
|
1041
|
+
public readonly pluginAdminEnabled: boolean;
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1044
|
+
- *Type:* boolean
|
|
1045
|
+
|
|
1046
|
+
Whether to enable the Grafana plugin admin page.
|
|
1047
|
+
|
|
1048
|
+
Default: false
|
|
1049
|
+
|
|
1050
|
+
---
|
|
1051
|
+
|
|
1052
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.role"></a>
|
|
1053
|
+
|
|
1054
|
+
```typescript
|
|
1055
|
+
public readonly role: IRole;
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1059
|
+
|
|
1060
|
+
IAM role to use for the workspace.
|
|
1061
|
+
|
|
1062
|
+
---
|
|
1063
|
+
|
|
1064
|
+
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.samlConfiguration"></a>
|
|
1065
|
+
|
|
1066
|
+
```typescript
|
|
1067
|
+
public readonly samlConfiguration: SamlConfiguration;
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
|
|
1071
|
+
|
|
1072
|
+
SAML configuration for the workspace.
|
|
1073
|
+
|
|
1074
|
+
---
|
|
1075
|
+
|
|
1076
|
+
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.stackSetName"></a>
|
|
1077
|
+
|
|
1078
|
+
```typescript
|
|
1079
|
+
public readonly stackSetName: string;
|
|
1080
|
+
```
|
|
1081
|
+
|
|
1082
|
+
- *Type:* string
|
|
1083
|
+
|
|
1084
|
+
Name of the CloudFormation stack set to use.
|
|
1085
|
+
|
|
1086
|
+
---
|
|
1087
|
+
|
|
1088
|
+
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.vpcConfiguration"></a>
|
|
1089
|
+
|
|
1090
|
+
```typescript
|
|
1091
|
+
public readonly vpcConfiguration: VpcConfiguration;
|
|
1092
|
+
```
|
|
1093
|
+
|
|
1094
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
|
|
1095
|
+
|
|
1096
|
+
VPC configuration for the workspace.
|
|
1097
|
+
|
|
1098
|
+
---
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
## Enums <a name="Enums" id="Enums"></a>
|
|
1103
|
+
|
|
1104
|
+
### AccountAccessType <a name="AccountAccessType" id="@robhan-cdk-lib/aws_grafana.AccountAccessType"></a>
|
|
1105
|
+
|
|
1106
|
+
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.
|
|
1107
|
+
|
|
1108
|
+
If this is
|
|
1109
|
+
ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
|
|
1110
|
+
workspace can access.
|
|
1111
|
+
|
|
1112
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1113
|
+
|
|
1114
|
+
| **Name** | **Description** |
|
|
1115
|
+
| --- | --- |
|
|
1116
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType.CURRENT_ACCOUNT">CURRENT_ACCOUNT</a></code> | Access is limited to the current AWS account only. |
|
|
1117
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType.ORGANIZATION">ORGANIZATION</a></code> | Access is extended to the entire AWS organization. |
|
|
1118
|
+
|
|
1119
|
+
---
|
|
1120
|
+
|
|
1121
|
+
##### `CURRENT_ACCOUNT` <a name="CURRENT_ACCOUNT" id="@robhan-cdk-lib/aws_grafana.AccountAccessType.CURRENT_ACCOUNT"></a>
|
|
1122
|
+
|
|
1123
|
+
Access is limited to the current AWS account only.
|
|
1124
|
+
|
|
1125
|
+
---
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
##### `ORGANIZATION` <a name="ORGANIZATION" id="@robhan-cdk-lib/aws_grafana.AccountAccessType.ORGANIZATION"></a>
|
|
1129
|
+
|
|
1130
|
+
Access is extended to the entire AWS organization.
|
|
1131
|
+
|
|
1132
|
+
---
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
### AuthenticationProviders <a name="AuthenticationProviders" id="@robhan-cdk-lib/aws_grafana.AuthenticationProviders"></a>
|
|
1136
|
+
|
|
1137
|
+
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.
|
|
1138
|
+
|
|
1139
|
+
> [https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspace.html](https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspace.html)
|
|
1140
|
+
|
|
1141
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1142
|
+
|
|
1143
|
+
| **Name** | **Description** |
|
|
1144
|
+
| --- | --- |
|
|
1145
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders.AWS_SSO">AWS_SSO</a></code> | AWS Single Sign-On authentication provider. |
|
|
1146
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders.SAML">SAML</a></code> | Security Assertion Markup Language (SAML) authentication provider. |
|
|
1147
|
+
|
|
1148
|
+
---
|
|
1149
|
+
|
|
1150
|
+
##### `AWS_SSO` <a name="AWS_SSO" id="@robhan-cdk-lib/aws_grafana.AuthenticationProviders.AWS_SSO"></a>
|
|
1151
|
+
|
|
1152
|
+
AWS Single Sign-On authentication provider.
|
|
1153
|
+
|
|
1154
|
+
---
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
##### `SAML` <a name="SAML" id="@robhan-cdk-lib/aws_grafana.AuthenticationProviders.SAML"></a>
|
|
1158
|
+
|
|
1159
|
+
Security Assertion Markup Language (SAML) authentication provider.
|
|
1160
|
+
|
|
1161
|
+
---
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
### NotificationDestinations <a name="NotificationDestinations" id="@robhan-cdk-lib/aws_grafana.NotificationDestinations"></a>
|
|
1165
|
+
|
|
1166
|
+
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.
|
|
1167
|
+
|
|
1168
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1169
|
+
|
|
1170
|
+
| **Name** | **Description** |
|
|
1171
|
+
| --- | --- |
|
|
1172
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations.SNS">SNS</a></code> | Amazon Simple Notification Service (SNS) as notification destination. |
|
|
1173
|
+
|
|
1174
|
+
---
|
|
1175
|
+
|
|
1176
|
+
##### `SNS` <a name="SNS" id="@robhan-cdk-lib/aws_grafana.NotificationDestinations.SNS"></a>
|
|
1177
|
+
|
|
1178
|
+
Amazon Simple Notification Service (SNS) as notification destination.
|
|
1179
|
+
|
|
1180
|
+
---
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
### PermissionTypes <a name="PermissionTypes" id="@robhan-cdk-lib/aws_grafana.PermissionTypes"></a>
|
|
1184
|
+
|
|
1185
|
+
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.
|
|
1186
|
+
|
|
1187
|
+
If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
|
|
1188
|
+
|
|
1189
|
+
If you are working with a workspace in a member account of an organization and that account is
|
|
1190
|
+
not a delegated administrator account, and you want the workspace to access data sources in
|
|
1191
|
+
other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
|
|
1192
|
+
|
|
1193
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1194
|
+
|
|
1195
|
+
| **Name** | **Description** |
|
|
1196
|
+
| --- | --- |
|
|
1197
|
+
| <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. |
|
|
1198
|
+
| <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. |
|
|
1199
|
+
|
|
1200
|
+
---
|
|
1201
|
+
|
|
1202
|
+
##### `CUSTOMER_MANAGED` <a name="CUSTOMER_MANAGED" id="@robhan-cdk-lib/aws_grafana.PermissionTypes.CUSTOMER_MANAGED"></a>
|
|
1203
|
+
|
|
1204
|
+
Customer-managed permissions where you manage user access to Grafana.
|
|
1205
|
+
|
|
1206
|
+
---
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
##### `SERVICE_MANAGED` <a name="SERVICE_MANAGED" id="@robhan-cdk-lib/aws_grafana.PermissionTypes.SERVICE_MANAGED"></a>
|
|
1210
|
+
|
|
1211
|
+
Service-managed permissions where AWS manages user access to Grafana.
|
|
1212
|
+
|
|
1213
|
+
---
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
### SamlConfigurationStatuses <a name="SamlConfigurationStatuses" id="@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses"></a>
|
|
1217
|
+
|
|
1218
|
+
Status of SAML configuration for a Grafana workspace.
|
|
1219
|
+
|
|
1220
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1221
|
+
|
|
1222
|
+
| **Name** | **Description** |
|
|
1223
|
+
| --- | --- |
|
|
1224
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses.CONFIGURED">CONFIGURED</a></code> | SAML is configured for the workspace. |
|
|
1225
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses.NOT_CONFIGURED">NOT_CONFIGURED</a></code> | SAML is not configured for the workspace. |
|
|
1226
|
+
|
|
1227
|
+
---
|
|
1228
|
+
|
|
1229
|
+
##### `CONFIGURED` <a name="CONFIGURED" id="@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses.CONFIGURED"></a>
|
|
1230
|
+
|
|
1231
|
+
SAML is configured for the workspace.
|
|
1232
|
+
|
|
1233
|
+
---
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
##### `NOT_CONFIGURED` <a name="NOT_CONFIGURED" id="@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses.NOT_CONFIGURED"></a>
|
|
1237
|
+
|
|
1238
|
+
SAML is not configured for the workspace.
|
|
1239
|
+
|
|
1240
|
+
---
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
### Status <a name="Status" id="@robhan-cdk-lib/aws_grafana.Status"></a>
|
|
1244
|
+
|
|
1245
|
+
Status of a Grafana workspace.
|
|
1246
|
+
|
|
1247
|
+
#### Members <a name="Members" id="Members"></a>
|
|
1248
|
+
|
|
1249
|
+
| **Name** | **Description** |
|
|
1250
|
+
| --- | --- |
|
|
1251
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.ACTIVE">ACTIVE</a></code> | Workspace is active and ready to use. |
|
|
1252
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.CREATING">CREATING</a></code> | Workspace is being created. |
|
|
1253
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.DELETING">DELETING</a></code> | Workspace is being deleted. |
|
|
1254
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.FAILED">FAILED</a></code> | Workspace operation has failed. |
|
|
1255
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.UPDATING">UPDATING</a></code> | Workspace is being updated. |
|
|
1256
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.UPGRADING">UPGRADING</a></code> | Workspace is being upgraded. |
|
|
1257
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.DELETION_FAILED">DELETION_FAILED</a></code> | Workspace deletion has failed. |
|
|
1258
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.CREATION_FAILED">CREATION_FAILED</a></code> | Workspace creation has failed. |
|
|
1259
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.UPDATE_FAILED">UPDATE_FAILED</a></code> | Workspace update has failed. |
|
|
1260
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.UPGRADE_FAILED">UPGRADE_FAILED</a></code> | Workspace upgrade has failed. |
|
|
1261
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Status.LICENSE_REMOVAL_FAILED">LICENSE_REMOVAL_FAILED</a></code> | License removal has failed. |
|
|
1262
|
+
|
|
1263
|
+
---
|
|
1264
|
+
|
|
1265
|
+
##### `ACTIVE` <a name="ACTIVE" id="@robhan-cdk-lib/aws_grafana.Status.ACTIVE"></a>
|
|
1266
|
+
|
|
1267
|
+
Workspace is active and ready to use.
|
|
1268
|
+
|
|
1269
|
+
---
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
##### `CREATING` <a name="CREATING" id="@robhan-cdk-lib/aws_grafana.Status.CREATING"></a>
|
|
1273
|
+
|
|
1274
|
+
Workspace is being created.
|
|
1275
|
+
|
|
1276
|
+
---
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
##### `DELETING` <a name="DELETING" id="@robhan-cdk-lib/aws_grafana.Status.DELETING"></a>
|
|
1280
|
+
|
|
1281
|
+
Workspace is being deleted.
|
|
1282
|
+
|
|
1283
|
+
---
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
##### `FAILED` <a name="FAILED" id="@robhan-cdk-lib/aws_grafana.Status.FAILED"></a>
|
|
1287
|
+
|
|
1288
|
+
Workspace operation has failed.
|
|
1289
|
+
|
|
1290
|
+
---
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
##### `UPDATING` <a name="UPDATING" id="@robhan-cdk-lib/aws_grafana.Status.UPDATING"></a>
|
|
1294
|
+
|
|
1295
|
+
Workspace is being updated.
|
|
1296
|
+
|
|
1297
|
+
---
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
##### `UPGRADING` <a name="UPGRADING" id="@robhan-cdk-lib/aws_grafana.Status.UPGRADING"></a>
|
|
1301
|
+
|
|
1302
|
+
Workspace is being upgraded.
|
|
1303
|
+
|
|
1304
|
+
---
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
##### `DELETION_FAILED` <a name="DELETION_FAILED" id="@robhan-cdk-lib/aws_grafana.Status.DELETION_FAILED"></a>
|
|
1308
|
+
|
|
1309
|
+
Workspace deletion has failed.
|
|
1310
|
+
|
|
1311
|
+
---
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
##### `CREATION_FAILED` <a name="CREATION_FAILED" id="@robhan-cdk-lib/aws_grafana.Status.CREATION_FAILED"></a>
|
|
1315
|
+
|
|
1316
|
+
Workspace creation has failed.
|
|
1317
|
+
|
|
1318
|
+
---
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
##### `UPDATE_FAILED` <a name="UPDATE_FAILED" id="@robhan-cdk-lib/aws_grafana.Status.UPDATE_FAILED"></a>
|
|
1322
|
+
|
|
1323
|
+
Workspace update has failed.
|
|
1324
|
+
|
|
1325
|
+
---
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
##### `UPGRADE_FAILED` <a name="UPGRADE_FAILED" id="@robhan-cdk-lib/aws_grafana.Status.UPGRADE_FAILED"></a>
|
|
1329
|
+
|
|
1330
|
+
Workspace upgrade has failed.
|
|
1331
|
+
|
|
1332
|
+
---
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
##### `LICENSE_REMOVAL_FAILED` <a name="LICENSE_REMOVAL_FAILED" id="@robhan-cdk-lib/aws_grafana.Status.LICENSE_REMOVAL_FAILED"></a>
|
|
1336
|
+
|
|
1337
|
+
License removal has failed.
|
|
1338
|
+
|
|
1339
|
+
---
|
|
1340
|
+
|