@robhan-cdk-lib/aws_grafana 0.0.24 → 0.0.26
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 +1728 -462
- package/API.md +1528 -363
- package/lib/index.d.ts +2 -1
- package/lib/index.js +17 -10
- package/lib/workspace-base.d.ts +499 -0
- package/lib/workspace-base.js +150 -0
- package/lib/workspace.d.ts +89 -255
- package/lib/workspace.js +52 -138
- package/package.json +9 -3
package/API.md
CHANGED
|
@@ -49,6 +49,7 @@ new Workspace(scope: Construct, id: string, props: WorkspaceProps)
|
|
|
49
49
|
| **Name** | **Description** |
|
|
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
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
52
53
|
|
|
53
54
|
---
|
|
54
55
|
|
|
@@ -60,11 +61,36 @@ public toString(): string
|
|
|
60
61
|
|
|
61
62
|
Returns a string representation of this construct.
|
|
62
63
|
|
|
64
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_grafana.Workspace.applyRemovalPolicy"></a>
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Apply the given removal policy to this resource.
|
|
71
|
+
|
|
72
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
73
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
74
|
+
CDK application or because you've made a change that requires the resource
|
|
75
|
+
to be replaced.
|
|
76
|
+
|
|
77
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
78
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
79
|
+
|
|
80
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_grafana.Workspace.applyRemovalPolicy.parameter.policy"></a>
|
|
81
|
+
|
|
82
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
63
86
|
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
64
87
|
|
|
65
88
|
| **Name** | **Description** |
|
|
66
89
|
| --- | --- |
|
|
67
90
|
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
91
|
+
| <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. |
|
|
92
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
93
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes">fromWorkspaceAttributes</a></code> | *No description.* |
|
|
68
94
|
|
|
69
95
|
---
|
|
70
96
|
|
|
@@ -86,22 +112,76 @@ Any object.
|
|
|
86
112
|
|
|
87
113
|
---
|
|
88
114
|
|
|
115
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_grafana.Workspace.isOwnedResource"></a>
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
import { Workspace } from '@robhan-cdk-lib/aws_grafana'
|
|
119
|
+
|
|
120
|
+
Workspace.isOwnedResource(construct: IConstruct)
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
124
|
+
|
|
125
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_grafana.Workspace.isOwnedResource.parameter.construct"></a>
|
|
126
|
+
|
|
127
|
+
- *Type:* constructs.IConstruct
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_grafana.Workspace.isResource"></a>
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import { Workspace } from '@robhan-cdk-lib/aws_grafana'
|
|
135
|
+
|
|
136
|
+
Workspace.isResource(construct: IConstruct)
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Check whether the given construct is a Resource.
|
|
140
|
+
|
|
141
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_grafana.Workspace.isResource.parameter.construct"></a>
|
|
142
|
+
|
|
143
|
+
- *Type:* constructs.IConstruct
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
##### `fromWorkspaceAttributes` <a name="fromWorkspaceAttributes" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes"></a>
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
import { Workspace } from '@robhan-cdk-lib/aws_grafana'
|
|
151
|
+
|
|
152
|
+
Workspace.fromWorkspaceAttributes(scope: Construct, id: string, attrs: WorkspaceAttributes)
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes.parameter.scope"></a>
|
|
156
|
+
|
|
157
|
+
- *Type:* constructs.Construct
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes.parameter.id"></a>
|
|
162
|
+
|
|
163
|
+
- *Type:* string
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_grafana.Workspace.fromWorkspaceAttributes.parameter.attrs"></a>
|
|
168
|
+
|
|
169
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes">WorkspaceAttributes</a>
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
89
173
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
90
174
|
|
|
91
175
|
| **Name** | **Type** | **Description** |
|
|
92
176
|
| --- | --- | --- |
|
|
93
177
|
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
178
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
179
|
+
| <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. |
|
|
94
180
|
| <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. |
|
|
95
181
|
| <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. |
|
|
96
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | The date that the workspace was created. |
|
|
97
|
-
| <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. |
|
|
98
|
-
| <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. |
|
|
99
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.id">id</a></code> | <code>string</code> | The unique ID of this workspace. |
|
|
100
|
-
| <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. |
|
|
101
182
|
| <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. |
|
|
102
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.
|
|
103
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.
|
|
104
|
-
| <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. |
|
|
183
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The arn of this workspace. |
|
|
184
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
|
|
105
185
|
| <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. |
|
|
106
186
|
| <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. |
|
|
107
187
|
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
|
|
@@ -115,6 +195,13 @@ Any object.
|
|
|
115
195
|
| <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. |
|
|
116
196
|
| <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. |
|
|
117
197
|
| <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. |
|
|
198
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp">creationTimestamp</a></code> | <code>string</code> | The date that the workspace was created. |
|
|
199
|
+
| <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. |
|
|
200
|
+
| <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. |
|
|
201
|
+
| <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. |
|
|
202
|
+
| <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. |
|
|
203
|
+
| <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. |
|
|
204
|
+
| <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. |
|
|
118
205
|
|
|
119
206
|
---
|
|
120
207
|
|
|
@@ -130,91 +217,62 @@ The tree node.
|
|
|
130
217
|
|
|
131
218
|
---
|
|
132
219
|
|
|
133
|
-
##### `
|
|
134
|
-
|
|
135
|
-
```typescript
|
|
136
|
-
public readonly accountAccessType: AccountAccessType;
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
140
|
-
|
|
141
|
-
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.
|
|
142
|
-
|
|
143
|
-
If this is
|
|
144
|
-
ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
|
|
145
|
-
workspace can access.
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders"></a>
|
|
220
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_grafana.Workspace.property.env"></a>
|
|
150
221
|
|
|
151
222
|
```typescript
|
|
152
|
-
public readonly
|
|
223
|
+
public readonly env: ResourceEnvironment;
|
|
153
224
|
```
|
|
154
225
|
|
|
155
|
-
- *Type:*
|
|
156
|
-
|
|
157
|
-
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.
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
##### `creationTimestamp`<sup>Required</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp"></a>
|
|
162
|
-
|
|
163
|
-
```typescript
|
|
164
|
-
public readonly creationTimestamp: string;
|
|
165
|
-
```
|
|
226
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
166
227
|
|
|
167
|
-
|
|
228
|
+
The environment this resource belongs to.
|
|
168
229
|
|
|
169
|
-
|
|
230
|
+
For resources that are created and managed by the CDK
|
|
231
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
232
|
+
this is always the same as the environment of the stack they belong to;
|
|
233
|
+
however, for imported resources
|
|
234
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
235
|
+
that might be different than the stack they were imported into.
|
|
170
236
|
|
|
171
237
|
---
|
|
172
238
|
|
|
173
|
-
##### `
|
|
239
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_grafana.Workspace.property.stack"></a>
|
|
174
240
|
|
|
175
241
|
```typescript
|
|
176
|
-
public readonly
|
|
242
|
+
public readonly stack: Stack;
|
|
177
243
|
```
|
|
178
244
|
|
|
179
|
-
- *Type:*
|
|
245
|
+
- *Type:* aws-cdk-lib.Stack
|
|
180
246
|
|
|
181
|
-
The
|
|
247
|
+
The stack in which this resource is defined.
|
|
182
248
|
|
|
183
249
|
---
|
|
184
250
|
|
|
185
|
-
##### `
|
|
251
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.Workspace.property.accountAccessType"></a>
|
|
186
252
|
|
|
187
253
|
```typescript
|
|
188
|
-
public readonly
|
|
254
|
+
public readonly accountAccessType: AccountAccessType;
|
|
189
255
|
```
|
|
190
256
|
|
|
191
|
-
- *Type:*
|
|
192
|
-
|
|
193
|
-
Specifies the version of Grafana supported by this workspace.
|
|
194
|
-
|
|
195
|
-
---
|
|
196
|
-
|
|
197
|
-
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_grafana.Workspace.property.id"></a>
|
|
198
|
-
|
|
199
|
-
```typescript
|
|
200
|
-
public readonly id: string;
|
|
201
|
-
```
|
|
257
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
202
258
|
|
|
203
|
-
|
|
259
|
+
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.
|
|
204
260
|
|
|
205
|
-
|
|
261
|
+
If this is
|
|
262
|
+
ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
|
|
263
|
+
workspace can access.
|
|
206
264
|
|
|
207
265
|
---
|
|
208
266
|
|
|
209
|
-
##### `
|
|
267
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.Workspace.property.authenticationProviders"></a>
|
|
210
268
|
|
|
211
269
|
```typescript
|
|
212
|
-
public readonly
|
|
270
|
+
public readonly authenticationProviders: AuthenticationProviders[];
|
|
213
271
|
```
|
|
214
272
|
|
|
215
|
-
- *Type:*
|
|
273
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
|
|
216
274
|
|
|
217
|
-
|
|
275
|
+
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.
|
|
218
276
|
|
|
219
277
|
---
|
|
220
278
|
|
|
@@ -236,39 +294,27 @@ other AWS accounts in the organization, this parameter must be set to CUSTOMER_M
|
|
|
236
294
|
|
|
237
295
|
---
|
|
238
296
|
|
|
239
|
-
##### `
|
|
240
|
-
|
|
241
|
-
```typescript
|
|
242
|
-
public readonly samlConfigurationStatus: SamlConfigurationStatuses;
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses">SamlConfigurationStatuses</a>
|
|
246
|
-
|
|
247
|
-
Specifies whether the workspace's SAML configuration is complete.
|
|
248
|
-
|
|
249
|
-
---
|
|
250
|
-
|
|
251
|
-
##### `ssoClientId`<sup>Required</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId"></a>
|
|
297
|
+
##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceArn"></a>
|
|
252
298
|
|
|
253
299
|
```typescript
|
|
254
|
-
public readonly
|
|
300
|
+
public readonly workspaceArn: string;
|
|
255
301
|
```
|
|
256
302
|
|
|
257
303
|
- *Type:* string
|
|
258
304
|
|
|
259
|
-
The
|
|
305
|
+
The arn of this workspace.
|
|
260
306
|
|
|
261
307
|
---
|
|
262
308
|
|
|
263
|
-
##### `
|
|
309
|
+
##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.workspaceId"></a>
|
|
264
310
|
|
|
265
311
|
```typescript
|
|
266
|
-
public readonly
|
|
312
|
+
public readonly workspaceId: string;
|
|
267
313
|
```
|
|
268
314
|
|
|
269
|
-
- *Type:*
|
|
315
|
+
- *Type:* string
|
|
270
316
|
|
|
271
|
-
The
|
|
317
|
+
The unique ID of this workspace.
|
|
272
318
|
|
|
273
319
|
---
|
|
274
320
|
|
|
@@ -436,459 +482,1592 @@ The configuration settings for an Amazon VPC that contains data sources for your
|
|
|
436
482
|
|
|
437
483
|
---
|
|
438
484
|
|
|
439
|
-
|
|
440
|
-
## Structs <a name="Structs" id="Structs"></a>
|
|
441
|
-
|
|
442
|
-
### NetworkAccessControl <a name="NetworkAccessControl" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl"></a>
|
|
443
|
-
|
|
444
|
-
The configuration settings for network access to your workspace.
|
|
445
|
-
|
|
446
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.Initializer"></a>
|
|
485
|
+
##### `creationTimestamp`<sup>Required</sup> <a name="creationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.creationTimestamp"></a>
|
|
447
486
|
|
|
448
487
|
```typescript
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
const networkAccessControl: NetworkAccessControl = { ... }
|
|
488
|
+
public readonly creationTimestamp: string;
|
|
452
489
|
```
|
|
453
490
|
|
|
454
|
-
|
|
491
|
+
- *Type:* string
|
|
455
492
|
|
|
456
|
-
|
|
457
|
-
| --- | --- | --- |
|
|
458
|
-
| <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. |
|
|
459
|
-
| <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. |
|
|
493
|
+
The date that the workspace was created.
|
|
460
494
|
|
|
461
495
|
---
|
|
462
496
|
|
|
463
|
-
##### `
|
|
497
|
+
##### `endpoint`<sup>Required</sup> <a name="endpoint" id="@robhan-cdk-lib/aws_grafana.Workspace.property.endpoint"></a>
|
|
464
498
|
|
|
465
499
|
```typescript
|
|
466
|
-
public readonly
|
|
500
|
+
public readonly endpoint: string;
|
|
467
501
|
```
|
|
468
502
|
|
|
469
|
-
- *Type:*
|
|
470
|
-
|
|
471
|
-
An array of prefix list IDs.
|
|
472
|
-
|
|
473
|
-
A prefix list is a list of CIDR ranges of IP addresses. The IP
|
|
474
|
-
addresses specified are allowed to access your workspace. If the list is not included in the
|
|
475
|
-
configuration (passed an empty array) then no IP addresses are allowed to access the
|
|
476
|
-
workspace.
|
|
503
|
+
- *Type:* string
|
|
477
504
|
|
|
478
|
-
|
|
505
|
+
The URL that users can use to access the Grafana console in the workspace.
|
|
479
506
|
|
|
480
507
|
---
|
|
481
508
|
|
|
482
|
-
##### `
|
|
509
|
+
##### `grafanaVersion`<sup>Required</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.Workspace.property.grafanaVersion"></a>
|
|
483
510
|
|
|
484
511
|
```typescript
|
|
485
|
-
public readonly
|
|
512
|
+
public readonly grafanaVersion: string;
|
|
486
513
|
```
|
|
487
514
|
|
|
488
|
-
- *Type:*
|
|
489
|
-
|
|
490
|
-
An array of Amazon VPC endpoint IDs for the workspace.
|
|
491
|
-
|
|
492
|
-
You can create VPC endpoints to your
|
|
493
|
-
Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration
|
|
494
|
-
is specified then only VPC endpoints specified here are allowed to access the workspace. If
|
|
495
|
-
you pass in an empty array of strings, then no VPCs are allowed to access the workspace.
|
|
515
|
+
- *Type:* string
|
|
496
516
|
|
|
497
|
-
|
|
517
|
+
Specifies the version of Grafana supported by this workspace.
|
|
498
518
|
|
|
499
519
|
---
|
|
500
520
|
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
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.
|
|
504
|
-
|
|
505
|
-
Each attribute must be a string with length between 1 and 256 characters.
|
|
506
|
-
|
|
507
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.Initializer"></a>
|
|
521
|
+
##### `modificationTimestamp`<sup>Required</sup> <a name="modificationTimestamp" id="@robhan-cdk-lib/aws_grafana.Workspace.property.modificationTimestamp"></a>
|
|
508
522
|
|
|
509
523
|
```typescript
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
const samlAssertionAttributes: SamlAssertionAttributes = { ... }
|
|
524
|
+
public readonly modificationTimestamp: string;
|
|
513
525
|
```
|
|
514
526
|
|
|
515
|
-
|
|
527
|
+
- *Type:* string
|
|
516
528
|
|
|
517
|
-
|
|
518
|
-
| --- | --- | --- |
|
|
519
|
-
| <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. |
|
|
520
|
-
| <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. |
|
|
521
|
-
| <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. |
|
|
522
|
-
| <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. |
|
|
523
|
-
| <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. |
|
|
524
|
-
| <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. |
|
|
529
|
+
The most recent date that the workspace was modified.
|
|
525
530
|
|
|
526
531
|
---
|
|
527
532
|
|
|
528
|
-
##### `
|
|
533
|
+
##### `samlConfigurationStatus`<sup>Required</sup> <a name="samlConfigurationStatus" id="@robhan-cdk-lib/aws_grafana.Workspace.property.samlConfigurationStatus"></a>
|
|
529
534
|
|
|
530
535
|
```typescript
|
|
531
|
-
public readonly
|
|
536
|
+
public readonly samlConfigurationStatus: SamlConfigurationStatuses;
|
|
532
537
|
```
|
|
533
538
|
|
|
534
|
-
- *Type:*
|
|
535
|
-
|
|
536
|
-
The name of the attribute within the SAML assertion to use as the email names for SAML users.
|
|
539
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfigurationStatuses">SamlConfigurationStatuses</a>
|
|
537
540
|
|
|
538
|
-
|
|
541
|
+
Specifies whether the workspace's SAML configuration is complete.
|
|
539
542
|
|
|
540
543
|
---
|
|
541
544
|
|
|
542
|
-
##### `
|
|
545
|
+
##### `ssoClientId`<sup>Required</sup> <a name="ssoClientId" id="@robhan-cdk-lib/aws_grafana.Workspace.property.ssoClientId"></a>
|
|
543
546
|
|
|
544
547
|
```typescript
|
|
545
|
-
public readonly
|
|
548
|
+
public readonly ssoClientId: string;
|
|
546
549
|
```
|
|
547
550
|
|
|
548
551
|
- *Type:* string
|
|
549
552
|
|
|
550
|
-
The
|
|
551
|
-
|
|
552
|
-
Must be between 1 and 256 characters long.
|
|
553
|
+
The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana.
|
|
553
554
|
|
|
554
555
|
---
|
|
555
556
|
|
|
556
|
-
##### `
|
|
557
|
+
##### `status`<sup>Required</sup> <a name="status" id="@robhan-cdk-lib/aws_grafana.Workspace.property.status"></a>
|
|
557
558
|
|
|
558
559
|
```typescript
|
|
559
|
-
public readonly
|
|
560
|
+
public readonly status: Status;
|
|
560
561
|
```
|
|
561
562
|
|
|
562
|
-
- *Type:*
|
|
563
|
-
|
|
564
|
-
The name of the attribute within the SAML assertion to use as the login names for SAML users.
|
|
563
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.Status">Status</a>
|
|
565
564
|
|
|
566
|
-
|
|
565
|
+
The current status of the workspace.
|
|
567
566
|
|
|
568
567
|
---
|
|
569
568
|
|
|
570
|
-
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.name"></a>
|
|
571
569
|
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
570
|
+
### WorkspaceBase <a name="WorkspaceBase" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase"></a>
|
|
571
|
+
|
|
572
|
+
- *Implements:* <a href="#@robhan-cdk-lib/aws_grafana.IWorkspace">IWorkspace</a>
|
|
573
|
+
|
|
574
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer"></a>
|
|
575
|
+
|
|
576
|
+
```typescript
|
|
577
|
+
import { WorkspaceBase } from '@robhan-cdk-lib/aws_grafana'
|
|
578
|
+
|
|
579
|
+
new WorkspaceBase(scope: Construct, id: string, props?: ResourceProps)
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
| **Name** | **Type** | **Description** |
|
|
583
|
+
| --- | --- | --- |
|
|
584
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
585
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
586
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
|
|
587
|
+
|
|
588
|
+
---
|
|
589
|
+
|
|
590
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer.parameter.scope"></a>
|
|
591
|
+
|
|
592
|
+
- *Type:* constructs.Construct
|
|
593
|
+
|
|
594
|
+
---
|
|
595
|
+
|
|
596
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer.parameter.id"></a>
|
|
597
|
+
|
|
598
|
+
- *Type:* string
|
|
599
|
+
|
|
600
|
+
---
|
|
601
|
+
|
|
602
|
+
##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.Initializer.parameter.props"></a>
|
|
603
|
+
|
|
604
|
+
- *Type:* aws-cdk-lib.ResourceProps
|
|
605
|
+
|
|
606
|
+
---
|
|
607
|
+
|
|
608
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
609
|
+
|
|
610
|
+
| **Name** | **Description** |
|
|
611
|
+
| --- | --- |
|
|
612
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
613
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
614
|
+
|
|
615
|
+
---
|
|
616
|
+
|
|
617
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.toString"></a>
|
|
618
|
+
|
|
619
|
+
```typescript
|
|
620
|
+
public toString(): string
|
|
621
|
+
```
|
|
622
|
+
|
|
623
|
+
Returns a string representation of this construct.
|
|
624
|
+
|
|
625
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyRemovalPolicy"></a>
|
|
626
|
+
|
|
627
|
+
```typescript
|
|
628
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
Apply the given removal policy to this resource.
|
|
632
|
+
|
|
633
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
634
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
635
|
+
CDK application or because you've made a change that requires the resource
|
|
636
|
+
to be replaced.
|
|
637
|
+
|
|
638
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
639
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
640
|
+
|
|
641
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.applyRemovalPolicy.parameter.policy"></a>
|
|
642
|
+
|
|
643
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
644
|
+
|
|
645
|
+
---
|
|
646
|
+
|
|
647
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
648
|
+
|
|
649
|
+
| **Name** | **Description** |
|
|
650
|
+
| --- | --- |
|
|
651
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
652
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
653
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
654
|
+
|
|
655
|
+
---
|
|
656
|
+
|
|
657
|
+
##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.isConstruct"></a>
|
|
658
|
+
|
|
659
|
+
```typescript
|
|
660
|
+
import { WorkspaceBase } from '@robhan-cdk-lib/aws_grafana'
|
|
661
|
+
|
|
662
|
+
WorkspaceBase.isConstruct(x: any)
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
Checks if `x` is a construct.
|
|
666
|
+
|
|
667
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.isConstruct.parameter.x"></a>
|
|
668
|
+
|
|
669
|
+
- *Type:* any
|
|
670
|
+
|
|
671
|
+
Any object.
|
|
672
|
+
|
|
673
|
+
---
|
|
674
|
+
|
|
675
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.isOwnedResource"></a>
|
|
676
|
+
|
|
677
|
+
```typescript
|
|
678
|
+
import { WorkspaceBase } from '@robhan-cdk-lib/aws_grafana'
|
|
679
|
+
|
|
680
|
+
WorkspaceBase.isOwnedResource(construct: IConstruct)
|
|
681
|
+
```
|
|
682
|
+
|
|
683
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
684
|
+
|
|
685
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.isOwnedResource.parameter.construct"></a>
|
|
686
|
+
|
|
687
|
+
- *Type:* constructs.IConstruct
|
|
688
|
+
|
|
689
|
+
---
|
|
690
|
+
|
|
691
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.isResource"></a>
|
|
692
|
+
|
|
693
|
+
```typescript
|
|
694
|
+
import { WorkspaceBase } from '@robhan-cdk-lib/aws_grafana'
|
|
695
|
+
|
|
696
|
+
WorkspaceBase.isResource(construct: IConstruct)
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
Check whether the given construct is a Resource.
|
|
700
|
+
|
|
701
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.isResource.parameter.construct"></a>
|
|
702
|
+
|
|
703
|
+
- *Type:* constructs.IConstruct
|
|
704
|
+
|
|
705
|
+
---
|
|
706
|
+
|
|
707
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
708
|
+
|
|
709
|
+
| **Name** | **Type** | **Description** |
|
|
710
|
+
| --- | --- | --- |
|
|
711
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
712
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
713
|
+
| <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. |
|
|
714
|
+
| <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. |
|
|
715
|
+
| <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. |
|
|
716
|
+
| <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. |
|
|
717
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of this workspace. |
|
|
718
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
|
|
719
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.clientToken">clientToken</a></code> | <code>string</code> | The client token for the workspace. |
|
|
720
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.dataSources">dataSources</a></code> | <code>string[]</code> | The data sources of this workspace. |
|
|
721
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.description">description</a></code> | <code>string</code> | The description of this workspace. |
|
|
722
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.name">name</a></code> | <code>string</code> | The name of this workspace. |
|
|
723
|
+
| <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. |
|
|
724
|
+
| <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. |
|
|
725
|
+
| <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. |
|
|
726
|
+
| <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. |
|
|
727
|
+
| <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. |
|
|
728
|
+
| <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. |
|
|
729
|
+
| <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. |
|
|
730
|
+
| <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. |
|
|
731
|
+
| <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. |
|
|
732
|
+
|
|
733
|
+
---
|
|
734
|
+
|
|
735
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.node"></a>
|
|
736
|
+
|
|
737
|
+
```typescript
|
|
738
|
+
public readonly node: Node;
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
- *Type:* constructs.Node
|
|
742
|
+
|
|
743
|
+
The tree node.
|
|
744
|
+
|
|
745
|
+
---
|
|
746
|
+
|
|
747
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.env"></a>
|
|
748
|
+
|
|
749
|
+
```typescript
|
|
750
|
+
public readonly env: ResourceEnvironment;
|
|
751
|
+
```
|
|
752
|
+
|
|
753
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
754
|
+
|
|
755
|
+
The environment this resource belongs to.
|
|
756
|
+
|
|
757
|
+
For resources that are created and managed by the CDK
|
|
758
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
759
|
+
this is always the same as the environment of the stack they belong to;
|
|
760
|
+
however, for imported resources
|
|
761
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
762
|
+
that might be different than the stack they were imported into.
|
|
763
|
+
|
|
764
|
+
---
|
|
765
|
+
|
|
766
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.stack"></a>
|
|
767
|
+
|
|
768
|
+
```typescript
|
|
769
|
+
public readonly stack: Stack;
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
- *Type:* aws-cdk-lib.Stack
|
|
773
|
+
|
|
774
|
+
The stack in which this resource is defined.
|
|
775
|
+
|
|
776
|
+
---
|
|
777
|
+
|
|
778
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.accountAccessType"></a>
|
|
779
|
+
|
|
780
|
+
```typescript
|
|
781
|
+
public readonly accountAccessType: AccountAccessType;
|
|
782
|
+
```
|
|
783
|
+
|
|
784
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
785
|
+
|
|
786
|
+
The account access type for the workspace.
|
|
787
|
+
|
|
788
|
+
---
|
|
789
|
+
|
|
790
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.authenticationProviders"></a>
|
|
791
|
+
|
|
792
|
+
```typescript
|
|
793
|
+
public readonly authenticationProviders: AuthenticationProviders[];
|
|
794
|
+
```
|
|
795
|
+
|
|
796
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
|
|
797
|
+
|
|
798
|
+
The authentication providers for the workspace.
|
|
799
|
+
|
|
800
|
+
---
|
|
801
|
+
|
|
802
|
+
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.permissionType"></a>
|
|
803
|
+
|
|
804
|
+
```typescript
|
|
805
|
+
public readonly permissionType: PermissionTypes;
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
|
|
809
|
+
|
|
810
|
+
The permission type for the workspace.
|
|
811
|
+
|
|
812
|
+
---
|
|
813
|
+
|
|
814
|
+
##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceArn"></a>
|
|
815
|
+
|
|
816
|
+
```typescript
|
|
817
|
+
public readonly workspaceArn: string;
|
|
818
|
+
```
|
|
819
|
+
|
|
820
|
+
- *Type:* string
|
|
821
|
+
|
|
822
|
+
The ARN of this workspace.
|
|
823
|
+
|
|
824
|
+
---
|
|
825
|
+
|
|
826
|
+
##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.workspaceId"></a>
|
|
827
|
+
|
|
828
|
+
```typescript
|
|
829
|
+
public readonly workspaceId: string;
|
|
830
|
+
```
|
|
831
|
+
|
|
832
|
+
- *Type:* string
|
|
833
|
+
|
|
834
|
+
The unique ID of this workspace.
|
|
835
|
+
|
|
836
|
+
---
|
|
837
|
+
|
|
838
|
+
##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.clientToken"></a>
|
|
839
|
+
|
|
840
|
+
```typescript
|
|
841
|
+
public readonly clientToken: string;
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
- *Type:* string
|
|
845
|
+
|
|
846
|
+
The client token for the workspace.
|
|
847
|
+
|
|
848
|
+
---
|
|
849
|
+
|
|
850
|
+
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.dataSources"></a>
|
|
851
|
+
|
|
852
|
+
```typescript
|
|
853
|
+
public readonly dataSources: string[];
|
|
854
|
+
```
|
|
855
|
+
|
|
856
|
+
- *Type:* string[]
|
|
857
|
+
|
|
858
|
+
The data sources of this workspace.
|
|
859
|
+
|
|
860
|
+
---
|
|
861
|
+
|
|
862
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.description"></a>
|
|
863
|
+
|
|
864
|
+
```typescript
|
|
865
|
+
public readonly description: string;
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
- *Type:* string
|
|
869
|
+
|
|
870
|
+
The description of this workspace.
|
|
871
|
+
|
|
872
|
+
---
|
|
873
|
+
|
|
874
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.name"></a>
|
|
875
|
+
|
|
876
|
+
```typescript
|
|
877
|
+
public readonly name: string;
|
|
878
|
+
```
|
|
879
|
+
|
|
880
|
+
- *Type:* string
|
|
881
|
+
|
|
882
|
+
The name of this workspace.
|
|
883
|
+
|
|
884
|
+
---
|
|
885
|
+
|
|
886
|
+
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.networkAccessControl"></a>
|
|
887
|
+
|
|
888
|
+
```typescript
|
|
889
|
+
public readonly networkAccessControl: NetworkAccessControl;
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
|
|
893
|
+
|
|
894
|
+
The configuration settings for network access to your workspace.
|
|
895
|
+
|
|
896
|
+
---
|
|
897
|
+
|
|
898
|
+
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.notificationDestinations"></a>
|
|
899
|
+
|
|
900
|
+
```typescript
|
|
901
|
+
public readonly notificationDestinations: NotificationDestinations[];
|
|
902
|
+
```
|
|
903
|
+
|
|
904
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
|
|
905
|
+
|
|
906
|
+
The notification destinations for the workspace.
|
|
907
|
+
|
|
908
|
+
---
|
|
909
|
+
|
|
910
|
+
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.organizationalUnits"></a>
|
|
911
|
+
|
|
912
|
+
```typescript
|
|
913
|
+
public readonly organizationalUnits: string[];
|
|
914
|
+
```
|
|
915
|
+
|
|
916
|
+
- *Type:* string[]
|
|
917
|
+
|
|
918
|
+
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.
|
|
919
|
+
|
|
920
|
+
---
|
|
921
|
+
|
|
922
|
+
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.organizationRoleName"></a>
|
|
923
|
+
|
|
924
|
+
```typescript
|
|
925
|
+
public readonly organizationRoleName: string;
|
|
926
|
+
```
|
|
927
|
+
|
|
928
|
+
- *Type:* string
|
|
929
|
+
|
|
930
|
+
The name of the IAM role that is used to access resources through Organizations.
|
|
931
|
+
|
|
932
|
+
---
|
|
933
|
+
|
|
934
|
+
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.pluginAdminEnabled"></a>
|
|
935
|
+
|
|
936
|
+
```typescript
|
|
937
|
+
public readonly pluginAdminEnabled: boolean;
|
|
938
|
+
```
|
|
939
|
+
|
|
940
|
+
- *Type:* boolean
|
|
941
|
+
|
|
942
|
+
Whether plugin administration is enabled in the workspace.
|
|
943
|
+
|
|
944
|
+
Setting to true allows workspace
|
|
945
|
+
admins to install, uninstall, and update plugins from within the Grafana workspace.
|
|
946
|
+
|
|
947
|
+
This option is only valid for workspaces that support Grafana version 9 or newer.
|
|
948
|
+
|
|
949
|
+
---
|
|
950
|
+
|
|
951
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.role"></a>
|
|
952
|
+
|
|
953
|
+
```typescript
|
|
954
|
+
public readonly role: IRole;
|
|
955
|
+
```
|
|
956
|
+
|
|
957
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
958
|
+
|
|
959
|
+
The IAM role that grants permissions to the AWS resources that the workspace will view data from.
|
|
960
|
+
|
|
961
|
+
---
|
|
962
|
+
|
|
963
|
+
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.samlConfiguration"></a>
|
|
964
|
+
|
|
965
|
+
```typescript
|
|
966
|
+
public readonly samlConfiguration: SamlConfiguration;
|
|
967
|
+
```
|
|
968
|
+
|
|
969
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
|
|
970
|
+
|
|
971
|
+
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.
|
|
972
|
+
|
|
973
|
+
---
|
|
974
|
+
|
|
975
|
+
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.stackSetName"></a>
|
|
976
|
+
|
|
977
|
+
```typescript
|
|
978
|
+
public readonly stackSetName: string;
|
|
979
|
+
```
|
|
980
|
+
|
|
981
|
+
- *Type:* string
|
|
982
|
+
|
|
983
|
+
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
|
|
984
|
+
|
|
985
|
+
---
|
|
986
|
+
|
|
987
|
+
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceBase.property.vpcConfiguration"></a>
|
|
988
|
+
|
|
989
|
+
```typescript
|
|
990
|
+
public readonly vpcConfiguration: VpcConfiguration;
|
|
991
|
+
```
|
|
992
|
+
|
|
993
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
|
|
994
|
+
|
|
995
|
+
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
|
|
996
|
+
|
|
997
|
+
---
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
1001
|
+
|
|
1002
|
+
### NetworkAccessControl <a name="NetworkAccessControl" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl"></a>
|
|
1003
|
+
|
|
1004
|
+
The configuration settings for network access to your workspace.
|
|
1005
|
+
|
|
1006
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.Initializer"></a>
|
|
1007
|
+
|
|
1008
|
+
```typescript
|
|
1009
|
+
import { NetworkAccessControl } from '@robhan-cdk-lib/aws_grafana'
|
|
1010
|
+
|
|
1011
|
+
const networkAccessControl: NetworkAccessControl = { ... }
|
|
1012
|
+
```
|
|
1013
|
+
|
|
1014
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1015
|
+
|
|
1016
|
+
| **Name** | **Type** | **Description** |
|
|
1017
|
+
| --- | --- | --- |
|
|
1018
|
+
| <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. |
|
|
1019
|
+
| <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. |
|
|
1020
|
+
|
|
1021
|
+
---
|
|
1022
|
+
|
|
1023
|
+
##### `prefixLists`<sup>Optional</sup> <a name="prefixLists" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.property.prefixLists"></a>
|
|
1024
|
+
|
|
1025
|
+
```typescript
|
|
1026
|
+
public readonly prefixLists: IPrefixList[];
|
|
1027
|
+
```
|
|
1028
|
+
|
|
1029
|
+
- *Type:* aws-cdk-lib.aws_ec2.IPrefixList[]
|
|
1030
|
+
|
|
1031
|
+
An array of prefix list IDs.
|
|
1032
|
+
|
|
1033
|
+
A prefix list is a list of CIDR ranges of IP addresses. The IP
|
|
1034
|
+
addresses specified are allowed to access your workspace. If the list is not included in the
|
|
1035
|
+
configuration (passed an empty array) then no IP addresses are allowed to access the
|
|
1036
|
+
workspace.
|
|
1037
|
+
|
|
1038
|
+
Maximum of 5 prefix lists allowed.
|
|
1039
|
+
|
|
1040
|
+
---
|
|
1041
|
+
|
|
1042
|
+
##### `vpcEndpoints`<sup>Optional</sup> <a name="vpcEndpoints" id="@robhan-cdk-lib/aws_grafana.NetworkAccessControl.property.vpcEndpoints"></a>
|
|
1043
|
+
|
|
1044
|
+
```typescript
|
|
1045
|
+
public readonly vpcEndpoints: IVpcEndpoint[];
|
|
1046
|
+
```
|
|
1047
|
+
|
|
1048
|
+
- *Type:* aws-cdk-lib.aws_ec2.IVpcEndpoint[]
|
|
1049
|
+
|
|
1050
|
+
An array of Amazon VPC endpoint IDs for the workspace.
|
|
1051
|
+
|
|
1052
|
+
You can create VPC endpoints to your
|
|
1053
|
+
Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration
|
|
1054
|
+
is specified then only VPC endpoints specified here are allowed to access the workspace. If
|
|
1055
|
+
you pass in an empty array of strings, then no VPCs are allowed to access the workspace.
|
|
1056
|
+
|
|
1057
|
+
Maximum of 5 VPC endpoints allowed.
|
|
1058
|
+
|
|
1059
|
+
---
|
|
1060
|
+
|
|
1061
|
+
### SamlAssertionAttributes <a name="SamlAssertionAttributes" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes"></a>
|
|
1062
|
+
|
|
1063
|
+
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.
|
|
1064
|
+
|
|
1065
|
+
Each attribute must be a string with length between 1 and 256 characters.
|
|
1066
|
+
|
|
1067
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.Initializer"></a>
|
|
1068
|
+
|
|
1069
|
+
```typescript
|
|
1070
|
+
import { SamlAssertionAttributes } from '@robhan-cdk-lib/aws_grafana'
|
|
1071
|
+
|
|
1072
|
+
const samlAssertionAttributes: SamlAssertionAttributes = { ... }
|
|
1073
|
+
```
|
|
1074
|
+
|
|
1075
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1076
|
+
|
|
1077
|
+
| **Name** | **Type** | **Description** |
|
|
1078
|
+
| --- | --- | --- |
|
|
1079
|
+
| <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. |
|
|
1080
|
+
| <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. |
|
|
1081
|
+
| <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. |
|
|
1082
|
+
| <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. |
|
|
1083
|
+
| <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. |
|
|
1084
|
+
| <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. |
|
|
1085
|
+
|
|
1086
|
+
---
|
|
1087
|
+
|
|
1088
|
+
##### `email`<sup>Optional</sup> <a name="email" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.email"></a>
|
|
1089
|
+
|
|
1090
|
+
```typescript
|
|
1091
|
+
public readonly email: string;
|
|
1092
|
+
```
|
|
1093
|
+
|
|
1094
|
+
- *Type:* string
|
|
1095
|
+
|
|
1096
|
+
The name of the attribute within the SAML assertion to use as the email names for SAML users.
|
|
1097
|
+
|
|
1098
|
+
Must be between 1 and 256 characters long.
|
|
1099
|
+
|
|
1100
|
+
---
|
|
1101
|
+
|
|
1102
|
+
##### `groups`<sup>Optional</sup> <a name="groups" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.groups"></a>
|
|
1103
|
+
|
|
1104
|
+
```typescript
|
|
1105
|
+
public readonly groups: string;
|
|
1106
|
+
```
|
|
1107
|
+
|
|
1108
|
+
- *Type:* string
|
|
1109
|
+
|
|
1110
|
+
The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups.
|
|
1111
|
+
|
|
1112
|
+
Must be between 1 and 256 characters long.
|
|
1113
|
+
|
|
1114
|
+
---
|
|
1115
|
+
|
|
1116
|
+
##### `login`<sup>Optional</sup> <a name="login" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.login"></a>
|
|
1117
|
+
|
|
1118
|
+
```typescript
|
|
1119
|
+
public readonly login: string;
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
- *Type:* string
|
|
1123
|
+
|
|
1124
|
+
The name of the attribute within the SAML assertion to use as the login names for SAML users.
|
|
1125
|
+
|
|
1126
|
+
Must be between 1 and 256 characters long.
|
|
1127
|
+
|
|
1128
|
+
---
|
|
1129
|
+
|
|
1130
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.name"></a>
|
|
1131
|
+
|
|
1132
|
+
```typescript
|
|
1133
|
+
public readonly name: string;
|
|
1134
|
+
```
|
|
1135
|
+
|
|
1136
|
+
- *Type:* string
|
|
1137
|
+
|
|
1138
|
+
The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users.
|
|
1139
|
+
|
|
1140
|
+
Must be between 1 and 256 characters long.
|
|
1141
|
+
|
|
1142
|
+
---
|
|
1143
|
+
|
|
1144
|
+
##### `org`<sup>Optional</sup> <a name="org" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.org"></a>
|
|
1145
|
+
|
|
1146
|
+
```typescript
|
|
1147
|
+
public readonly org: string;
|
|
1148
|
+
```
|
|
1149
|
+
|
|
1150
|
+
- *Type:* string
|
|
1151
|
+
|
|
1152
|
+
The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations.
|
|
1153
|
+
|
|
1154
|
+
Must be between 1 and 256 characters long.
|
|
1155
|
+
|
|
1156
|
+
---
|
|
1157
|
+
|
|
1158
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes.property.role"></a>
|
|
1159
|
+
|
|
1160
|
+
```typescript
|
|
1161
|
+
public readonly role: string;
|
|
1162
|
+
```
|
|
1163
|
+
|
|
1164
|
+
- *Type:* string
|
|
1165
|
+
|
|
1166
|
+
The name of the attribute within the SAML assertion to use as the user roles.
|
|
1167
|
+
|
|
1168
|
+
Must be between 1 and 256 characters long.
|
|
1169
|
+
|
|
1170
|
+
---
|
|
1171
|
+
|
|
1172
|
+
### SamlConfiguration <a name="SamlConfiguration" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration"></a>
|
|
1173
|
+
|
|
1174
|
+
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.
|
|
1175
|
+
|
|
1176
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.Initializer"></a>
|
|
1177
|
+
|
|
1178
|
+
```typescript
|
|
1179
|
+
import { SamlConfiguration } from '@robhan-cdk-lib/aws_grafana'
|
|
1180
|
+
|
|
1181
|
+
const samlConfiguration: SamlConfiguration = { ... }
|
|
1182
|
+
```
|
|
1183
|
+
|
|
1184
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1185
|
+
|
|
1186
|
+
| **Name** | **Type** | **Description** |
|
|
1187
|
+
| --- | --- | --- |
|
|
1188
|
+
| <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. |
|
|
1189
|
+
| <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. |
|
|
1190
|
+
| <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. |
|
|
1191
|
+
| <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. |
|
|
1192
|
+
| <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. |
|
|
1193
|
+
|
|
1194
|
+
---
|
|
1195
|
+
|
|
1196
|
+
##### `idpMetadata`<sup>Required</sup> <a name="idpMetadata" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.idpMetadata"></a>
|
|
1197
|
+
|
|
1198
|
+
```typescript
|
|
1199
|
+
public readonly idpMetadata: SamlIdpMetadata;
|
|
1200
|
+
```
|
|
1201
|
+
|
|
1202
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata">SamlIdpMetadata</a>
|
|
1203
|
+
|
|
1204
|
+
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
|
|
1205
|
+
|
|
1206
|
+
Required field for SAML configuration.
|
|
1207
|
+
|
|
1208
|
+
---
|
|
1209
|
+
|
|
1210
|
+
##### `allowedOrganizations`<sup>Optional</sup> <a name="allowedOrganizations" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.allowedOrganizations"></a>
|
|
1211
|
+
|
|
1212
|
+
```typescript
|
|
1213
|
+
public readonly allowedOrganizations: string[];
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1216
|
+
- *Type:* string[]
|
|
1217
|
+
|
|
1218
|
+
Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
|
|
1219
|
+
|
|
1220
|
+
If this is empty, all organizations in the assertion attribute have access.
|
|
1221
|
+
|
|
1222
|
+
Must have between 1 and 256 elements.
|
|
1223
|
+
|
|
1224
|
+
---
|
|
1225
|
+
|
|
1226
|
+
##### `assertionAtrributes`<sup>Optional</sup> <a name="assertionAtrributes" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.assertionAtrributes"></a>
|
|
1227
|
+
|
|
1228
|
+
```typescript
|
|
1229
|
+
public readonly assertionAtrributes: SamlAssertionAttributes;
|
|
1230
|
+
```
|
|
1231
|
+
|
|
1232
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlAssertionAttributes">SamlAssertionAttributes</a>
|
|
1233
|
+
|
|
1234
|
+
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.
|
|
1235
|
+
|
|
1236
|
+
---
|
|
1237
|
+
|
|
1238
|
+
##### `loginValidityDuration`<sup>Optional</sup> <a name="loginValidityDuration" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.loginValidityDuration"></a>
|
|
1239
|
+
|
|
1240
|
+
```typescript
|
|
1241
|
+
public readonly loginValidityDuration: number;
|
|
1242
|
+
```
|
|
1243
|
+
|
|
1244
|
+
- *Type:* number
|
|
1245
|
+
|
|
1246
|
+
How long a sign-on session by a SAML user is valid, before the user has to sign on again.
|
|
1247
|
+
|
|
1248
|
+
Must be a positive number.
|
|
1249
|
+
|
|
1250
|
+
---
|
|
1251
|
+
|
|
1252
|
+
##### `roleValues`<sup>Optional</sup> <a name="roleValues" id="@robhan-cdk-lib/aws_grafana.SamlConfiguration.property.roleValues"></a>
|
|
1253
|
+
|
|
1254
|
+
```typescript
|
|
1255
|
+
public readonly roleValues: SamlRoleValues;
|
|
1256
|
+
```
|
|
1257
|
+
|
|
1258
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlRoleValues">SamlRoleValues</a>
|
|
1259
|
+
|
|
1260
|
+
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
|
|
1261
|
+
|
|
1262
|
+
---
|
|
1263
|
+
|
|
1264
|
+
### SamlIdpMetadata <a name="SamlIdpMetadata" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata"></a>
|
|
1265
|
+
|
|
1266
|
+
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
|
|
1267
|
+
|
|
1268
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.Initializer"></a>
|
|
1269
|
+
|
|
1270
|
+
```typescript
|
|
1271
|
+
import { SamlIdpMetadata } from '@robhan-cdk-lib/aws_grafana'
|
|
1272
|
+
|
|
1273
|
+
const samlIdpMetadata: SamlIdpMetadata = { ... }
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1277
|
+
|
|
1278
|
+
| **Name** | **Type** | **Description** |
|
|
1279
|
+
| --- | --- | --- |
|
|
1280
|
+
| <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. |
|
|
1281
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.xml">xml</a></code> | <code>string</code> | The full IdP metadata, in XML format. |
|
|
1282
|
+
|
|
1283
|
+
---
|
|
1284
|
+
|
|
1285
|
+
##### `url`<sup>Optional</sup> <a name="url" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.url"></a>
|
|
1286
|
+
|
|
1287
|
+
```typescript
|
|
1288
|
+
public readonly url: string;
|
|
1289
|
+
```
|
|
1290
|
+
|
|
1291
|
+
- *Type:* string
|
|
1292
|
+
|
|
1293
|
+
The URL of the location containing the IdP metadata.
|
|
1294
|
+
|
|
1295
|
+
Must be a string with length between 1 and 2048 characters.
|
|
1296
|
+
|
|
1297
|
+
---
|
|
1298
|
+
|
|
1299
|
+
##### `xml`<sup>Optional</sup> <a name="xml" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.xml"></a>
|
|
1300
|
+
|
|
1301
|
+
```typescript
|
|
1302
|
+
public readonly xml: string;
|
|
1303
|
+
```
|
|
1304
|
+
|
|
1305
|
+
- *Type:* string
|
|
1306
|
+
|
|
1307
|
+
The full IdP metadata, in XML format.
|
|
1308
|
+
|
|
1309
|
+
---
|
|
1310
|
+
|
|
1311
|
+
### SamlRoleValues <a name="SamlRoleValues" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues"></a>
|
|
1312
|
+
|
|
1313
|
+
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
|
|
1314
|
+
|
|
1315
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.Initializer"></a>
|
|
1316
|
+
|
|
1317
|
+
```typescript
|
|
1318
|
+
import { SamlRoleValues } from '@robhan-cdk-lib/aws_grafana'
|
|
1319
|
+
|
|
1320
|
+
const samlRoleValues: SamlRoleValues = { ... }
|
|
1321
|
+
```
|
|
1322
|
+
|
|
1323
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1324
|
+
|
|
1325
|
+
| **Name** | **Type** | **Description** |
|
|
1326
|
+
| --- | --- | --- |
|
|
1327
|
+
| <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. |
|
|
1328
|
+
| <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. |
|
|
1329
|
+
|
|
1330
|
+
---
|
|
1331
|
+
|
|
1332
|
+
##### `admin`<sup>Optional</sup> <a name="admin" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.property.admin"></a>
|
|
1333
|
+
|
|
1334
|
+
```typescript
|
|
1335
|
+
public readonly admin: string[];
|
|
1336
|
+
```
|
|
1337
|
+
|
|
1338
|
+
- *Type:* string[]
|
|
1339
|
+
|
|
1340
|
+
A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
|
|
1341
|
+
|
|
1342
|
+
Maximum of 256 elements.
|
|
1343
|
+
|
|
1344
|
+
---
|
|
1345
|
+
|
|
1346
|
+
##### `editor`<sup>Optional</sup> <a name="editor" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.property.editor"></a>
|
|
1347
|
+
|
|
1348
|
+
```typescript
|
|
1349
|
+
public readonly editor: string[];
|
|
1350
|
+
```
|
|
1351
|
+
|
|
1352
|
+
- *Type:* string[]
|
|
1353
|
+
|
|
1354
|
+
A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
|
|
1355
|
+
|
|
1356
|
+
Maximum of 256 elements.
|
|
1357
|
+
|
|
1358
|
+
---
|
|
1359
|
+
|
|
1360
|
+
### VpcConfiguration <a name="VpcConfiguration" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration"></a>
|
|
1361
|
+
|
|
1362
|
+
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
|
|
1363
|
+
|
|
1364
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration.Initializer"></a>
|
|
1365
|
+
|
|
1366
|
+
```typescript
|
|
1367
|
+
import { VpcConfiguration } from '@robhan-cdk-lib/aws_grafana'
|
|
1368
|
+
|
|
1369
|
+
const vpcConfiguration: VpcConfiguration = { ... }
|
|
1370
|
+
```
|
|
1371
|
+
|
|
1372
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1373
|
+
|
|
1374
|
+
| **Name** | **Type** | **Description** |
|
|
1375
|
+
| --- | --- | --- |
|
|
1376
|
+
| <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. |
|
|
1377
|
+
| <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. |
|
|
1378
|
+
|
|
1379
|
+
---
|
|
1380
|
+
|
|
1381
|
+
##### `securityGroups`<sup>Required</sup> <a name="securityGroups" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration.property.securityGroups"></a>
|
|
1382
|
+
|
|
1383
|
+
```typescript
|
|
1384
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
1385
|
+
```
|
|
1386
|
+
|
|
1387
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
1388
|
+
|
|
1389
|
+
The list of Amazon EC2 security groups attached to the Amazon VPC for your Grafana workspace to connect.
|
|
1390
|
+
|
|
1391
|
+
Duplicates not allowed.
|
|
1392
|
+
|
|
1393
|
+
Array Members: Minimum number of 1 items. Maximum number of 5 items.
|
|
1394
|
+
|
|
1395
|
+
Required for VPC configuration.
|
|
1396
|
+
|
|
1397
|
+
---
|
|
1398
|
+
|
|
1399
|
+
##### `subnets`<sup>Required</sup> <a name="subnets" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration.property.subnets"></a>
|
|
1400
|
+
|
|
1401
|
+
```typescript
|
|
1402
|
+
public readonly subnets: ISubnet[];
|
|
1403
|
+
```
|
|
1404
|
+
|
|
1405
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISubnet[]
|
|
1406
|
+
|
|
1407
|
+
The list of Amazon EC2 subnets created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
|
|
1408
|
+
|
|
1409
|
+
Array Members: Minimum number of 2 items. Maximum number of 6 items.
|
|
1410
|
+
|
|
1411
|
+
Required for VPC configuration.
|
|
1412
|
+
|
|
1413
|
+
---
|
|
1414
|
+
|
|
1415
|
+
### WorkspaceAttributes <a name="WorkspaceAttributes" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes"></a>
|
|
1416
|
+
|
|
1417
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.Initializer"></a>
|
|
1418
|
+
|
|
1419
|
+
```typescript
|
|
1420
|
+
import { WorkspaceAttributes } from '@robhan-cdk-lib/aws_grafana'
|
|
1421
|
+
|
|
1422
|
+
const workspaceAttributes: WorkspaceAttributes = { ... }
|
|
1423
|
+
```
|
|
1424
|
+
|
|
1425
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1426
|
+
|
|
1427
|
+
| **Name** | **Type** | **Description** |
|
|
1428
|
+
| --- | --- | --- |
|
|
1429
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1430
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1431
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1432
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.clientToken">clientToken</a></code> | <code>string</code> | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
|
|
1433
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1434
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
|
|
1435
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.name">name</a></code> | <code>string</code> | The name of the workspace. |
|
|
1436
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1437
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1438
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1439
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.organizationRoleName">organizationRoleName</a></code> | <code>string</code> | Name of the IAM role to use for the organization. |
|
|
1440
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether plugin administration is enabled in the workspace. |
|
|
1441
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1442
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1443
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1444
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.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. |
|
|
1445
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The arn of this workspace. |
|
|
1446
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
|
|
1447
|
+
|
|
1448
|
+
---
|
|
1449
|
+
|
|
1450
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.accountAccessType"></a>
|
|
1451
|
+
|
|
1452
|
+
```typescript
|
|
1453
|
+
public readonly accountAccessType: AccountAccessType;
|
|
1454
|
+
```
|
|
1455
|
+
|
|
1456
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
1457
|
+
|
|
1458
|
+
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.
|
|
1459
|
+
|
|
1460
|
+
If this is
|
|
1461
|
+
ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
|
|
1462
|
+
workspace can access.
|
|
1463
|
+
|
|
1464
|
+
Required field.
|
|
1465
|
+
|
|
1466
|
+
---
|
|
1467
|
+
|
|
1468
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.authenticationProviders"></a>
|
|
1469
|
+
|
|
1470
|
+
```typescript
|
|
1471
|
+
public readonly authenticationProviders: AuthenticationProviders[];
|
|
1472
|
+
```
|
|
1473
|
+
|
|
1474
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
|
|
1475
|
+
|
|
1476
|
+
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.
|
|
1477
|
+
|
|
1478
|
+
Required field.
|
|
1479
|
+
|
|
1480
|
+
---
|
|
1481
|
+
|
|
1482
|
+
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.permissionType"></a>
|
|
1483
|
+
|
|
1484
|
+
```typescript
|
|
1485
|
+
public readonly permissionType: PermissionTypes;
|
|
1486
|
+
```
|
|
1487
|
+
|
|
1488
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
|
|
1489
|
+
|
|
1490
|
+
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.
|
|
1491
|
+
|
|
1492
|
+
If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
|
|
1493
|
+
|
|
1494
|
+
If you are working with a workspace in a member account of an organization and that account is
|
|
1495
|
+
not a delegated administrator account, and you want the workspace to access data sources in
|
|
1496
|
+
other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
|
|
1497
|
+
|
|
1498
|
+
Required field.
|
|
1499
|
+
|
|
1500
|
+
---
|
|
1501
|
+
|
|
1502
|
+
##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.clientToken"></a>
|
|
1503
|
+
|
|
1504
|
+
```typescript
|
|
1505
|
+
public readonly clientToken: string;
|
|
1506
|
+
```
|
|
1507
|
+
|
|
1508
|
+
- *Type:* string
|
|
1509
|
+
|
|
1510
|
+
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
|
|
1511
|
+
|
|
1512
|
+
Must be 1-64 characters long and contain only printable ASCII characters.
|
|
1513
|
+
|
|
1514
|
+
---
|
|
1515
|
+
|
|
1516
|
+
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.dataSources"></a>
|
|
1517
|
+
|
|
1518
|
+
```typescript
|
|
1519
|
+
public readonly dataSources: string[];
|
|
1520
|
+
```
|
|
1521
|
+
|
|
1522
|
+
- *Type:* string[]
|
|
1523
|
+
|
|
1524
|
+
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.
|
|
1525
|
+
|
|
1526
|
+
This list is only used when the workspace was created through the AWS console, and the
|
|
1527
|
+
permissionType is SERVICE_MANAGED.
|
|
1528
|
+
|
|
1529
|
+
---
|
|
1530
|
+
|
|
1531
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.description"></a>
|
|
1532
|
+
|
|
1533
|
+
```typescript
|
|
1534
|
+
public readonly description: string;
|
|
1535
|
+
```
|
|
1536
|
+
|
|
1537
|
+
- *Type:* string
|
|
1538
|
+
|
|
1539
|
+
The user-defined description of the workspace.
|
|
1540
|
+
|
|
1541
|
+
Maximum length of 2048 characters.
|
|
1542
|
+
|
|
1543
|
+
---
|
|
1544
|
+
|
|
1545
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.name"></a>
|
|
1546
|
+
|
|
1547
|
+
```typescript
|
|
1548
|
+
public readonly name: string;
|
|
1549
|
+
```
|
|
1550
|
+
|
|
1551
|
+
- *Type:* string
|
|
1552
|
+
|
|
1553
|
+
The name of the workspace.
|
|
1554
|
+
|
|
1555
|
+
Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots,
|
|
1556
|
+
underscores, and tildes.
|
|
1557
|
+
|
|
1558
|
+
---
|
|
1559
|
+
|
|
1560
|
+
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.networkAccessControl"></a>
|
|
1561
|
+
|
|
1562
|
+
```typescript
|
|
1563
|
+
public readonly networkAccessControl: NetworkAccessControl;
|
|
1564
|
+
```
|
|
1565
|
+
|
|
1566
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
|
|
1567
|
+
|
|
1568
|
+
The configuration settings for network access to your workspace.
|
|
1569
|
+
|
|
1570
|
+
---
|
|
1571
|
+
|
|
1572
|
+
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.notificationDestinations"></a>
|
|
1573
|
+
|
|
1574
|
+
```typescript
|
|
1575
|
+
public readonly notificationDestinations: NotificationDestinations[];
|
|
1576
|
+
```
|
|
1577
|
+
|
|
1578
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
|
|
1579
|
+
|
|
1580
|
+
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.
|
|
1581
|
+
|
|
1582
|
+
---
|
|
1583
|
+
|
|
1584
|
+
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.organizationalUnits"></a>
|
|
1585
|
+
|
|
1586
|
+
```typescript
|
|
1587
|
+
public readonly organizationalUnits: string[];
|
|
1588
|
+
```
|
|
1589
|
+
|
|
1590
|
+
- *Type:* string[]
|
|
1591
|
+
|
|
1592
|
+
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.
|
|
1593
|
+
|
|
1594
|
+
---
|
|
1595
|
+
|
|
1596
|
+
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.organizationRoleName"></a>
|
|
1597
|
+
|
|
1598
|
+
```typescript
|
|
1599
|
+
public readonly organizationRoleName: string;
|
|
1600
|
+
```
|
|
575
1601
|
|
|
576
1602
|
- *Type:* string
|
|
577
1603
|
|
|
578
|
-
|
|
1604
|
+
Name of the IAM role to use for the organization.
|
|
579
1605
|
|
|
580
|
-
|
|
1606
|
+
Maximum length of 2048 characters.
|
|
581
1607
|
|
|
582
1608
|
---
|
|
583
1609
|
|
|
584
|
-
##### `
|
|
1610
|
+
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.pluginAdminEnabled"></a>
|
|
585
1611
|
|
|
586
1612
|
```typescript
|
|
587
|
-
public readonly
|
|
1613
|
+
public readonly pluginAdminEnabled: boolean;
|
|
1614
|
+
```
|
|
1615
|
+
|
|
1616
|
+
- *Type:* boolean
|
|
1617
|
+
|
|
1618
|
+
Whether plugin administration is enabled in the workspace.
|
|
1619
|
+
|
|
1620
|
+
Setting to true allows workspace
|
|
1621
|
+
admins to install, uninstall, and update plugins from within the Grafana workspace.
|
|
1622
|
+
|
|
1623
|
+
This option is only valid for workspaces that support Grafana version 9 or newer.
|
|
1624
|
+
|
|
1625
|
+
Default: false
|
|
1626
|
+
|
|
1627
|
+
---
|
|
1628
|
+
|
|
1629
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.role"></a>
|
|
1630
|
+
|
|
1631
|
+
```typescript
|
|
1632
|
+
public readonly role: IRole;
|
|
1633
|
+
```
|
|
1634
|
+
|
|
1635
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
1636
|
+
|
|
1637
|
+
The IAM role that grants permissions to the AWS resources that the workspace will view data from.
|
|
1638
|
+
|
|
1639
|
+
---
|
|
1640
|
+
|
|
1641
|
+
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.samlConfiguration"></a>
|
|
1642
|
+
|
|
1643
|
+
```typescript
|
|
1644
|
+
public readonly samlConfiguration: SamlConfiguration;
|
|
1645
|
+
```
|
|
1646
|
+
|
|
1647
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
|
|
1648
|
+
|
|
1649
|
+
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.
|
|
1650
|
+
|
|
1651
|
+
---
|
|
1652
|
+
|
|
1653
|
+
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.stackSetName"></a>
|
|
1654
|
+
|
|
1655
|
+
```typescript
|
|
1656
|
+
public readonly stackSetName: string;
|
|
588
1657
|
```
|
|
589
1658
|
|
|
590
1659
|
- *Type:* string
|
|
591
1660
|
|
|
592
|
-
The name of the
|
|
1661
|
+
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
|
|
593
1662
|
|
|
594
|
-
|
|
1663
|
+
---
|
|
1664
|
+
|
|
1665
|
+
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.vpcConfiguration"></a>
|
|
1666
|
+
|
|
1667
|
+
```typescript
|
|
1668
|
+
public readonly vpcConfiguration: VpcConfiguration;
|
|
1669
|
+
```
|
|
1670
|
+
|
|
1671
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
|
|
1672
|
+
|
|
1673
|
+
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
|
|
595
1674
|
|
|
596
1675
|
---
|
|
597
1676
|
|
|
598
|
-
##### `
|
|
1677
|
+
##### `workspaceArn`<sup>Optional</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.workspaceArn"></a>
|
|
599
1678
|
|
|
600
1679
|
```typescript
|
|
601
|
-
public readonly
|
|
1680
|
+
public readonly workspaceArn: string;
|
|
602
1681
|
```
|
|
603
1682
|
|
|
604
1683
|
- *Type:* string
|
|
605
1684
|
|
|
606
|
-
The
|
|
1685
|
+
The arn of this workspace.
|
|
607
1686
|
|
|
608
|
-
|
|
1687
|
+
Either this or the workspaceId must be provided.
|
|
609
1688
|
|
|
610
1689
|
---
|
|
611
1690
|
|
|
612
|
-
|
|
1691
|
+
##### `workspaceId`<sup>Optional</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.WorkspaceAttributes.property.workspaceId"></a>
|
|
613
1692
|
|
|
614
|
-
|
|
1693
|
+
```typescript
|
|
1694
|
+
public readonly workspaceId: string;
|
|
1695
|
+
```
|
|
615
1696
|
|
|
616
|
-
|
|
1697
|
+
- *Type:* string
|
|
1698
|
+
|
|
1699
|
+
The unique ID of this workspace.
|
|
1700
|
+
|
|
1701
|
+
Either this or the workspaceArn must be provided.
|
|
1702
|
+
|
|
1703
|
+
---
|
|
1704
|
+
|
|
1705
|
+
### WorkspaceProps <a name="WorkspaceProps" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps"></a>
|
|
1706
|
+
|
|
1707
|
+
Properties for creating an Amazon Managed Grafana workspace.
|
|
1708
|
+
|
|
1709
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.Initializer"></a>
|
|
617
1710
|
|
|
618
1711
|
```typescript
|
|
619
|
-
import {
|
|
1712
|
+
import { WorkspaceProps } from '@robhan-cdk-lib/aws_grafana'
|
|
620
1713
|
|
|
621
|
-
const
|
|
1714
|
+
const workspaceProps: WorkspaceProps = { ... }
|
|
622
1715
|
```
|
|
623
1716
|
|
|
624
1717
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
625
1718
|
|
|
626
1719
|
| **Name** | **Type** | **Description** |
|
|
627
1720
|
| --- | --- | --- |
|
|
628
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
629
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
630
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
631
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
632
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
1721
|
+
| <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> | 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. |
|
|
1722
|
+
| <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> | 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. |
|
|
1723
|
+
| <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> | 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. |
|
|
1724
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.clientToken">clientToken</a></code> | <code>string</code> | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
|
|
1725
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.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. |
|
|
1726
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
|
|
1727
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Specifies the version of Grafana to support in the workspace. |
|
|
1728
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.name">name</a></code> | <code>string</code> | The name of the workspace. |
|
|
1729
|
+
| <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> | The configuration settings for network access to your workspace. |
|
|
1730
|
+
| <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> | 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. |
|
|
1731
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.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. |
|
|
1732
|
+
| <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. |
|
|
1733
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether plugin administration is enabled in the workspace. |
|
|
1734
|
+
| <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. |
|
|
1735
|
+
| <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. |
|
|
1736
|
+
| <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. |
|
|
1737
|
+
| <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. |
|
|
633
1738
|
|
|
634
1739
|
---
|
|
635
1740
|
|
|
636
|
-
##### `
|
|
1741
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.accountAccessType"></a>
|
|
637
1742
|
|
|
638
1743
|
```typescript
|
|
639
|
-
public readonly
|
|
1744
|
+
public readonly accountAccessType: AccountAccessType;
|
|
640
1745
|
```
|
|
641
1746
|
|
|
642
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.
|
|
1747
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AccountAccessType">AccountAccessType</a>
|
|
643
1748
|
|
|
644
|
-
|
|
1749
|
+
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.
|
|
1750
|
+
|
|
1751
|
+
If this is
|
|
1752
|
+
ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
|
|
1753
|
+
workspace can access.
|
|
1754
|
+
|
|
1755
|
+
Required field.
|
|
1756
|
+
|
|
1757
|
+
---
|
|
1758
|
+
|
|
1759
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.authenticationProviders"></a>
|
|
1760
|
+
|
|
1761
|
+
```typescript
|
|
1762
|
+
public readonly authenticationProviders: AuthenticationProviders[];
|
|
1763
|
+
```
|
|
1764
|
+
|
|
1765
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.AuthenticationProviders">AuthenticationProviders</a>[]
|
|
1766
|
+
|
|
1767
|
+
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.
|
|
1768
|
+
|
|
1769
|
+
Required field.
|
|
1770
|
+
|
|
1771
|
+
---
|
|
1772
|
+
|
|
1773
|
+
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.permissionType"></a>
|
|
1774
|
+
|
|
1775
|
+
```typescript
|
|
1776
|
+
public readonly permissionType: PermissionTypes;
|
|
1777
|
+
```
|
|
1778
|
+
|
|
1779
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.PermissionTypes">PermissionTypes</a>
|
|
1780
|
+
|
|
1781
|
+
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.
|
|
1782
|
+
|
|
1783
|
+
If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself.
|
|
1784
|
+
|
|
1785
|
+
If you are working with a workspace in a member account of an organization and that account is
|
|
1786
|
+
not a delegated administrator account, and you want the workspace to access data sources in
|
|
1787
|
+
other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
|
|
1788
|
+
|
|
1789
|
+
Required field.
|
|
1790
|
+
|
|
1791
|
+
---
|
|
1792
|
+
|
|
1793
|
+
##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.clientToken"></a>
|
|
1794
|
+
|
|
1795
|
+
```typescript
|
|
1796
|
+
public readonly clientToken: string;
|
|
1797
|
+
```
|
|
1798
|
+
|
|
1799
|
+
- *Type:* string
|
|
1800
|
+
|
|
1801
|
+
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
|
|
1802
|
+
|
|
1803
|
+
Must be 1-64 characters long and contain only printable ASCII characters.
|
|
1804
|
+
|
|
1805
|
+
---
|
|
1806
|
+
|
|
1807
|
+
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.dataSources"></a>
|
|
1808
|
+
|
|
1809
|
+
```typescript
|
|
1810
|
+
public readonly dataSources: string[];
|
|
1811
|
+
```
|
|
1812
|
+
|
|
1813
|
+
- *Type:* string[]
|
|
1814
|
+
|
|
1815
|
+
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.
|
|
1816
|
+
|
|
1817
|
+
This list is only used when the workspace was created through the AWS console, and the
|
|
1818
|
+
permissionType is SERVICE_MANAGED.
|
|
1819
|
+
|
|
1820
|
+
---
|
|
1821
|
+
|
|
1822
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.description"></a>
|
|
1823
|
+
|
|
1824
|
+
```typescript
|
|
1825
|
+
public readonly description: string;
|
|
1826
|
+
```
|
|
1827
|
+
|
|
1828
|
+
- *Type:* string
|
|
1829
|
+
|
|
1830
|
+
The user-defined description of the workspace.
|
|
1831
|
+
|
|
1832
|
+
Maximum length of 2048 characters.
|
|
1833
|
+
|
|
1834
|
+
---
|
|
1835
|
+
|
|
1836
|
+
##### `grafanaVersion`<sup>Optional</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.grafanaVersion"></a>
|
|
1837
|
+
|
|
1838
|
+
```typescript
|
|
1839
|
+
public readonly grafanaVersion: string;
|
|
1840
|
+
```
|
|
1841
|
+
|
|
1842
|
+
- *Type:* string
|
|
1843
|
+
|
|
1844
|
+
Specifies the version of Grafana to support in the workspace.
|
|
1845
|
+
|
|
1846
|
+
Defaults to the latest version
|
|
1847
|
+
on create (for example, 9.4), or the current version of the workspace on update.
|
|
1848
|
+
Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from
|
|
1849
|
+
9.4 to 8.4).
|
|
645
1850
|
|
|
646
|
-
|
|
1851
|
+
Must be 1-255 characters long.
|
|
647
1852
|
|
|
648
1853
|
---
|
|
649
1854
|
|
|
650
|
-
##### `
|
|
1855
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.name"></a>
|
|
651
1856
|
|
|
652
1857
|
```typescript
|
|
653
|
-
public readonly
|
|
1858
|
+
public readonly name: string;
|
|
654
1859
|
```
|
|
655
1860
|
|
|
656
|
-
- *Type:* string
|
|
657
|
-
|
|
658
|
-
Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace.
|
|
1861
|
+
- *Type:* string
|
|
659
1862
|
|
|
660
|
-
|
|
1863
|
+
The name of the workspace.
|
|
661
1864
|
|
|
662
|
-
Must
|
|
1865
|
+
Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots,
|
|
1866
|
+
underscores, and tildes.
|
|
663
1867
|
|
|
664
1868
|
---
|
|
665
1869
|
|
|
666
|
-
##### `
|
|
1870
|
+
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.networkAccessControl"></a>
|
|
667
1871
|
|
|
668
1872
|
```typescript
|
|
669
|
-
public readonly
|
|
1873
|
+
public readonly networkAccessControl: NetworkAccessControl;
|
|
670
1874
|
```
|
|
671
1875
|
|
|
672
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.
|
|
1876
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NetworkAccessControl">NetworkAccessControl</a>
|
|
673
1877
|
|
|
674
|
-
|
|
1878
|
+
The configuration settings for network access to your workspace.
|
|
675
1879
|
|
|
676
1880
|
---
|
|
677
1881
|
|
|
678
|
-
##### `
|
|
1882
|
+
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.notificationDestinations"></a>
|
|
679
1883
|
|
|
680
1884
|
```typescript
|
|
681
|
-
public readonly
|
|
1885
|
+
public readonly notificationDestinations: NotificationDestinations[];
|
|
682
1886
|
```
|
|
683
1887
|
|
|
684
|
-
- *Type:*
|
|
685
|
-
|
|
686
|
-
How long a sign-on session by a SAML user is valid, before the user has to sign on again.
|
|
1888
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.NotificationDestinations">NotificationDestinations</a>[]
|
|
687
1889
|
|
|
688
|
-
|
|
1890
|
+
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.
|
|
689
1891
|
|
|
690
1892
|
---
|
|
691
1893
|
|
|
692
|
-
##### `
|
|
1894
|
+
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.organizationalUnits"></a>
|
|
693
1895
|
|
|
694
1896
|
```typescript
|
|
695
|
-
public readonly
|
|
1897
|
+
public readonly organizationalUnits: string[];
|
|
696
1898
|
```
|
|
697
1899
|
|
|
698
|
-
- *Type:*
|
|
1900
|
+
- *Type:* string[]
|
|
699
1901
|
|
|
700
|
-
|
|
1902
|
+
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.
|
|
701
1903
|
|
|
702
1904
|
---
|
|
703
1905
|
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.
|
|
707
|
-
|
|
708
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.Initializer"></a>
|
|
1906
|
+
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.organizationRoleName"></a>
|
|
709
1907
|
|
|
710
1908
|
```typescript
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
const samlIdpMetadata: SamlIdpMetadata = { ... }
|
|
1909
|
+
public readonly organizationRoleName: string;
|
|
714
1910
|
```
|
|
715
1911
|
|
|
716
|
-
|
|
1912
|
+
- *Type:* string
|
|
717
1913
|
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.SamlIdpMetadata.property.xml">xml</a></code> | <code>string</code> | The full IdP metadata, in XML format. |
|
|
1914
|
+
Name of the IAM role to use for the organization.
|
|
1915
|
+
|
|
1916
|
+
Maximum length of 2048 characters.
|
|
722
1917
|
|
|
723
1918
|
---
|
|
724
1919
|
|
|
725
|
-
##### `
|
|
1920
|
+
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.pluginAdminEnabled"></a>
|
|
726
1921
|
|
|
727
1922
|
```typescript
|
|
728
|
-
public readonly
|
|
1923
|
+
public readonly pluginAdminEnabled: boolean;
|
|
729
1924
|
```
|
|
730
1925
|
|
|
731
|
-
- *Type:*
|
|
1926
|
+
- *Type:* boolean
|
|
732
1927
|
|
|
733
|
-
|
|
1928
|
+
Whether plugin administration is enabled in the workspace.
|
|
734
1929
|
|
|
735
|
-
|
|
1930
|
+
Setting to true allows workspace
|
|
1931
|
+
admins to install, uninstall, and update plugins from within the Grafana workspace.
|
|
1932
|
+
|
|
1933
|
+
This option is only valid for workspaces that support Grafana version 9 or newer.
|
|
1934
|
+
|
|
1935
|
+
Default: false
|
|
736
1936
|
|
|
737
1937
|
---
|
|
738
1938
|
|
|
739
|
-
##### `
|
|
1939
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.role"></a>
|
|
740
1940
|
|
|
741
1941
|
```typescript
|
|
742
|
-
public readonly
|
|
1942
|
+
public readonly role: IRole;
|
|
743
1943
|
```
|
|
744
1944
|
|
|
745
|
-
- *Type:*
|
|
1945
|
+
- *Type:* aws-cdk-lib.aws_iam.IRole
|
|
746
1946
|
|
|
747
|
-
The
|
|
1947
|
+
The IAM role that grants permissions to the AWS resources that the workspace will view data from.
|
|
748
1948
|
|
|
749
1949
|
---
|
|
750
1950
|
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.
|
|
754
|
-
|
|
755
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.SamlRoleValues.Initializer"></a>
|
|
1951
|
+
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.samlConfiguration"></a>
|
|
756
1952
|
|
|
757
1953
|
```typescript
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
const samlRoleValues: SamlRoleValues = { ... }
|
|
1954
|
+
public readonly samlConfiguration: SamlConfiguration;
|
|
761
1955
|
```
|
|
762
1956
|
|
|
763
|
-
|
|
1957
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.SamlConfiguration">SamlConfiguration</a>
|
|
764
1958
|
|
|
765
|
-
|
|
766
|
-
| --- | --- | --- |
|
|
767
|
-
| <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. |
|
|
768
|
-
| <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. |
|
|
1959
|
+
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.
|
|
769
1960
|
|
|
770
1961
|
---
|
|
771
1962
|
|
|
772
|
-
##### `
|
|
1963
|
+
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.stackSetName"></a>
|
|
773
1964
|
|
|
774
1965
|
```typescript
|
|
775
|
-
public readonly
|
|
1966
|
+
public readonly stackSetName: string;
|
|
776
1967
|
```
|
|
777
1968
|
|
|
778
|
-
- *Type:* string
|
|
779
|
-
|
|
780
|
-
A list of groups from the SAML assertion attribute to grant the Grafana Admin role to.
|
|
1969
|
+
- *Type:* string
|
|
781
1970
|
|
|
782
|
-
|
|
1971
|
+
The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace.
|
|
783
1972
|
|
|
784
1973
|
---
|
|
785
1974
|
|
|
786
|
-
##### `
|
|
1975
|
+
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.vpcConfiguration"></a>
|
|
787
1976
|
|
|
788
1977
|
```typescript
|
|
789
|
-
public readonly
|
|
1978
|
+
public readonly vpcConfiguration: VpcConfiguration;
|
|
790
1979
|
```
|
|
791
1980
|
|
|
792
|
-
- *Type:*
|
|
793
|
-
|
|
794
|
-
A list of groups from the SAML assertion attribute to grant the Grafana Editor role to.
|
|
1981
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_grafana.VpcConfiguration">VpcConfiguration</a>
|
|
795
1982
|
|
|
796
|
-
|
|
1983
|
+
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
|
|
797
1984
|
|
|
798
1985
|
---
|
|
799
1986
|
|
|
800
|
-
### VpcConfiguration <a name="VpcConfiguration" id="@robhan-cdk-lib/aws_grafana.VpcConfiguration"></a>
|
|
801
1987
|
|
|
802
|
-
|
|
1988
|
+
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
803
1989
|
|
|
804
|
-
|
|
1990
|
+
### IWorkspace <a name="IWorkspace" id="@robhan-cdk-lib/aws_grafana.IWorkspace"></a>
|
|
805
1991
|
|
|
806
|
-
|
|
807
|
-
|
|
1992
|
+
- *Extends:* aws-cdk-lib.IResource
|
|
1993
|
+
|
|
1994
|
+
- *Implemented By:* <a href="#@robhan-cdk-lib/aws_grafana.Workspace">Workspace</a>, <a href="#@robhan-cdk-lib/aws_grafana.WorkspaceBase">WorkspaceBase</a>, <a href="#@robhan-cdk-lib/aws_grafana.IWorkspace">IWorkspace</a>
|
|
1995
|
+
|
|
1996
|
+
Represents an Amazon Managed Service for Grafana workspace.
|
|
808
1997
|
|
|
809
|
-
const vpcConfiguration: VpcConfiguration = { ... }
|
|
810
|
-
```
|
|
811
1998
|
|
|
812
1999
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
813
2000
|
|
|
814
2001
|
| **Name** | **Type** | **Description** |
|
|
815
2002
|
| --- | --- | --- |
|
|
816
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
817
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
2003
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
2004
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
2005
|
+
| <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. |
|
|
2006
|
+
| <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. |
|
|
2007
|
+
| <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. |
|
|
2008
|
+
| <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. |
|
|
2009
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of this workspace. |
|
|
2010
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID of this workspace. |
|
|
2011
|
+
| <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. |
|
|
2012
|
+
| <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. |
|
|
2013
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
|
|
2014
|
+
| <code><a href="#@robhan-cdk-lib/aws_grafana.IWorkspace.property.name">name</a></code> | <code>string</code> | The name of the workspace. |
|
|
2015
|
+
| <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. |
|
|
2016
|
+
| <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. |
|
|
2017
|
+
| <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. |
|
|
2018
|
+
| <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. |
|
|
2019
|
+
| <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. |
|
|
2020
|
+
| <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. |
|
|
2021
|
+
| <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. |
|
|
2022
|
+
| <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. |
|
|
2023
|
+
| <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. |
|
|
2024
|
+
|
|
2025
|
+
---
|
|
2026
|
+
|
|
2027
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.node"></a>
|
|
822
2028
|
|
|
823
2029
|
```typescript
|
|
824
|
-
public readonly
|
|
2030
|
+
public readonly node: Node;
|
|
825
2031
|
```
|
|
826
2032
|
|
|
827
|
-
- *Type:*
|
|
828
|
-
|
|
829
|
-
The list of Amazon EC2 security groups attached to the Amazon VPC for your Grafana workspace to connect.
|
|
830
|
-
|
|
831
|
-
Duplicates not allowed.
|
|
832
|
-
|
|
833
|
-
Array Members: Minimum number of 1 items. Maximum number of 5 items.
|
|
2033
|
+
- *Type:* constructs.Node
|
|
834
2034
|
|
|
835
|
-
|
|
2035
|
+
The tree node.
|
|
836
2036
|
|
|
837
2037
|
---
|
|
838
2038
|
|
|
839
|
-
##### `
|
|
2039
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.env"></a>
|
|
840
2040
|
|
|
841
2041
|
```typescript
|
|
842
|
-
public readonly
|
|
2042
|
+
public readonly env: ResourceEnvironment;
|
|
843
2043
|
```
|
|
844
2044
|
|
|
845
|
-
- *Type:* aws-cdk-lib.
|
|
846
|
-
|
|
847
|
-
The list of Amazon EC2 subnets created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed.
|
|
2045
|
+
- *Type:* aws-cdk-lib.ResourceEnvironment
|
|
848
2046
|
|
|
849
|
-
|
|
2047
|
+
The environment this resource belongs to.
|
|
850
2048
|
|
|
851
|
-
|
|
2049
|
+
For resources that are created and managed by the CDK
|
|
2050
|
+
(generally, those created by creating new class instances like Role, Bucket, etc.),
|
|
2051
|
+
this is always the same as the environment of the stack they belong to;
|
|
2052
|
+
however, for imported resources
|
|
2053
|
+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
|
|
2054
|
+
that might be different than the stack they were imported into.
|
|
852
2055
|
|
|
853
2056
|
---
|
|
854
2057
|
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
Properties for creating an Amazon Managed Grafana workspace.
|
|
858
|
-
|
|
859
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.Initializer"></a>
|
|
2058
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.stack"></a>
|
|
860
2059
|
|
|
861
2060
|
```typescript
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
const workspaceProps: WorkspaceProps = { ... }
|
|
2061
|
+
public readonly stack: Stack;
|
|
865
2062
|
```
|
|
866
2063
|
|
|
867
|
-
|
|
2064
|
+
- *Type:* aws-cdk-lib.Stack
|
|
868
2065
|
|
|
869
|
-
|
|
870
|
-
| --- | --- | --- |
|
|
871
|
-
| <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> | 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. |
|
|
872
|
-
| <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> | 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. |
|
|
873
|
-
| <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> | 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. |
|
|
874
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.clientToken">clientToken</a></code> | <code>string</code> | A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request. |
|
|
875
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.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. |
|
|
876
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.description">description</a></code> | <code>string</code> | The user-defined description of the workspace. |
|
|
877
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.grafanaVersion">grafanaVersion</a></code> | <code>string</code> | Specifies the version of Grafana to support in the workspace. |
|
|
878
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.name">name</a></code> | <code>string</code> | The name of the workspace. |
|
|
879
|
-
| <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> | The configuration settings for network access to your workspace. |
|
|
880
|
-
| <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> | 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. |
|
|
881
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.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. |
|
|
882
|
-
| <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. |
|
|
883
|
-
| <code><a href="#@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.pluginAdminEnabled">pluginAdminEnabled</a></code> | <code>boolean</code> | Whether plugin administration is enabled in the workspace. |
|
|
884
|
-
| <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. |
|
|
885
|
-
| <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. |
|
|
886
|
-
| <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. |
|
|
887
|
-
| <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. |
|
|
2066
|
+
The stack in which this resource is defined.
|
|
888
2067
|
|
|
889
2068
|
---
|
|
890
2069
|
|
|
891
|
-
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.
|
|
2070
|
+
##### `accountAccessType`<sup>Required</sup> <a name="accountAccessType" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.accountAccessType"></a>
|
|
892
2071
|
|
|
893
2072
|
```typescript
|
|
894
2073
|
public readonly accountAccessType: AccountAccessType;
|
|
@@ -902,11 +2081,9 @@ If this is
|
|
|
902
2081
|
ORGANIZATION, the OrganizationalUnits parameter specifies which organizational units the
|
|
903
2082
|
workspace can access.
|
|
904
2083
|
|
|
905
|
-
Required field.
|
|
906
|
-
|
|
907
2084
|
---
|
|
908
2085
|
|
|
909
|
-
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.
|
|
2086
|
+
##### `authenticationProviders`<sup>Required</sup> <a name="authenticationProviders" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.authenticationProviders"></a>
|
|
910
2087
|
|
|
911
2088
|
```typescript
|
|
912
2089
|
public readonly authenticationProviders: AuthenticationProviders[];
|
|
@@ -916,11 +2093,9 @@ public readonly authenticationProviders: AuthenticationProviders[];
|
|
|
916
2093
|
|
|
917
2094
|
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.
|
|
918
2095
|
|
|
919
|
-
Required field.
|
|
920
|
-
|
|
921
2096
|
---
|
|
922
2097
|
|
|
923
|
-
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.
|
|
2098
|
+
##### `permissionType`<sup>Required</sup> <a name="permissionType" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.permissionType"></a>
|
|
924
2099
|
|
|
925
2100
|
```typescript
|
|
926
2101
|
public readonly permissionType: PermissionTypes;
|
|
@@ -936,11 +2111,33 @@ If you are working with a workspace in a member account of an organization and t
|
|
|
936
2111
|
not a delegated administrator account, and you want the workspace to access data sources in
|
|
937
2112
|
other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED.
|
|
938
2113
|
|
|
939
|
-
|
|
2114
|
+
---
|
|
2115
|
+
|
|
2116
|
+
##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceArn"></a>
|
|
2117
|
+
|
|
2118
|
+
```typescript
|
|
2119
|
+
public readonly workspaceArn: string;
|
|
2120
|
+
```
|
|
2121
|
+
|
|
2122
|
+
- *Type:* string
|
|
2123
|
+
|
|
2124
|
+
The ARN of this workspace.
|
|
940
2125
|
|
|
941
2126
|
---
|
|
942
2127
|
|
|
943
|
-
##### `
|
|
2128
|
+
##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.workspaceId"></a>
|
|
2129
|
+
|
|
2130
|
+
```typescript
|
|
2131
|
+
public readonly workspaceId: string;
|
|
2132
|
+
```
|
|
2133
|
+
|
|
2134
|
+
- *Type:* string
|
|
2135
|
+
|
|
2136
|
+
The unique ID of this workspace.
|
|
2137
|
+
|
|
2138
|
+
---
|
|
2139
|
+
|
|
2140
|
+
##### `clientToken`<sup>Optional</sup> <a name="clientToken" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.clientToken"></a>
|
|
944
2141
|
|
|
945
2142
|
```typescript
|
|
946
2143
|
public readonly clientToken: string;
|
|
@@ -950,11 +2147,9 @@ public readonly clientToken: string;
|
|
|
950
2147
|
|
|
951
2148
|
A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
|
|
952
2149
|
|
|
953
|
-
Must be 1-64 characters long and contain only printable ASCII characters.
|
|
954
|
-
|
|
955
2150
|
---
|
|
956
2151
|
|
|
957
|
-
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.
|
|
2152
|
+
##### `dataSources`<sup>Optional</sup> <a name="dataSources" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.dataSources"></a>
|
|
958
2153
|
|
|
959
2154
|
```typescript
|
|
960
2155
|
public readonly dataSources: string[];
|
|
@@ -969,7 +2164,7 @@ permissionType is SERVICE_MANAGED.
|
|
|
969
2164
|
|
|
970
2165
|
---
|
|
971
2166
|
|
|
972
|
-
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.
|
|
2167
|
+
##### `description`<sup>Optional</sup> <a name="description" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.description"></a>
|
|
973
2168
|
|
|
974
2169
|
```typescript
|
|
975
2170
|
public readonly description: string;
|
|
@@ -979,30 +2174,9 @@ public readonly description: string;
|
|
|
979
2174
|
|
|
980
2175
|
The user-defined description of the workspace.
|
|
981
2176
|
|
|
982
|
-
Maximum length of 2048 characters.
|
|
983
|
-
|
|
984
|
-
---
|
|
985
|
-
|
|
986
|
-
##### `grafanaVersion`<sup>Optional</sup> <a name="grafanaVersion" id="@robhan-cdk-lib/aws_grafana.WorkspaceProps.property.grafanaVersion"></a>
|
|
987
|
-
|
|
988
|
-
```typescript
|
|
989
|
-
public readonly grafanaVersion: string;
|
|
990
|
-
```
|
|
991
|
-
|
|
992
|
-
- *Type:* string
|
|
993
|
-
|
|
994
|
-
Specifies the version of Grafana to support in the workspace.
|
|
995
|
-
|
|
996
|
-
Defaults to the latest version
|
|
997
|
-
on create (for example, 9.4), or the current version of the workspace on update.
|
|
998
|
-
Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from
|
|
999
|
-
9.4 to 8.4).
|
|
1000
|
-
|
|
1001
|
-
Must be 1-255 characters long.
|
|
1002
|
-
|
|
1003
2177
|
---
|
|
1004
2178
|
|
|
1005
|
-
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.
|
|
2179
|
+
##### `name`<sup>Optional</sup> <a name="name" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.name"></a>
|
|
1006
2180
|
|
|
1007
2181
|
```typescript
|
|
1008
2182
|
public readonly name: string;
|
|
@@ -1012,12 +2186,9 @@ public readonly name: string;
|
|
|
1012
2186
|
|
|
1013
2187
|
The name of the workspace.
|
|
1014
2188
|
|
|
1015
|
-
Must be 1-255 characters long and contain only alphanumeric characters, hyphens, dots,
|
|
1016
|
-
underscores, and tildes.
|
|
1017
|
-
|
|
1018
2189
|
---
|
|
1019
2190
|
|
|
1020
|
-
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.
|
|
2191
|
+
##### `networkAccessControl`<sup>Optional</sup> <a name="networkAccessControl" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.networkAccessControl"></a>
|
|
1021
2192
|
|
|
1022
2193
|
```typescript
|
|
1023
2194
|
public readonly networkAccessControl: NetworkAccessControl;
|
|
@@ -1029,7 +2200,7 @@ The configuration settings for network access to your workspace.
|
|
|
1029
2200
|
|
|
1030
2201
|
---
|
|
1031
2202
|
|
|
1032
|
-
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.
|
|
2203
|
+
##### `notificationDestinations`<sup>Optional</sup> <a name="notificationDestinations" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.notificationDestinations"></a>
|
|
1033
2204
|
|
|
1034
2205
|
```typescript
|
|
1035
2206
|
public readonly notificationDestinations: NotificationDestinations[];
|
|
@@ -1041,7 +2212,7 @@ The AWS notification channels that Amazon Managed Grafana can automatically crea
|
|
|
1041
2212
|
|
|
1042
2213
|
---
|
|
1043
2214
|
|
|
1044
|
-
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.
|
|
2215
|
+
##### `organizationalUnits`<sup>Optional</sup> <a name="organizationalUnits" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.organizationalUnits"></a>
|
|
1045
2216
|
|
|
1046
2217
|
```typescript
|
|
1047
2218
|
public readonly organizationalUnits: string[];
|
|
@@ -1053,7 +2224,7 @@ Specifies the organizational units that this workspace is allowed to use data so
|
|
|
1053
2224
|
|
|
1054
2225
|
---
|
|
1055
2226
|
|
|
1056
|
-
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.
|
|
2227
|
+
##### `organizationRoleName`<sup>Optional</sup> <a name="organizationRoleName" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.organizationRoleName"></a>
|
|
1057
2228
|
|
|
1058
2229
|
```typescript
|
|
1059
2230
|
public readonly organizationRoleName: string;
|
|
@@ -1061,13 +2232,11 @@ public readonly organizationRoleName: string;
|
|
|
1061
2232
|
|
|
1062
2233
|
- *Type:* string
|
|
1063
2234
|
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
Maximum length of 2048 characters.
|
|
2235
|
+
The name of the IAM role that is used to access resources through Organizations.
|
|
1067
2236
|
|
|
1068
2237
|
---
|
|
1069
2238
|
|
|
1070
|
-
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.
|
|
2239
|
+
##### `pluginAdminEnabled`<sup>Optional</sup> <a name="pluginAdminEnabled" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.pluginAdminEnabled"></a>
|
|
1071
2240
|
|
|
1072
2241
|
```typescript
|
|
1073
2242
|
public readonly pluginAdminEnabled: boolean;
|
|
@@ -1082,11 +2251,9 @@ admins to install, uninstall, and update plugins from within the Grafana workspa
|
|
|
1082
2251
|
|
|
1083
2252
|
This option is only valid for workspaces that support Grafana version 9 or newer.
|
|
1084
2253
|
|
|
1085
|
-
Default: false
|
|
1086
|
-
|
|
1087
2254
|
---
|
|
1088
2255
|
|
|
1089
|
-
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.
|
|
2256
|
+
##### `role`<sup>Optional</sup> <a name="role" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.role"></a>
|
|
1090
2257
|
|
|
1091
2258
|
```typescript
|
|
1092
2259
|
public readonly role: IRole;
|
|
@@ -1098,7 +2265,7 @@ The IAM role that grants permissions to the AWS resources that the workspace wil
|
|
|
1098
2265
|
|
|
1099
2266
|
---
|
|
1100
2267
|
|
|
1101
|
-
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.
|
|
2268
|
+
##### `samlConfiguration`<sup>Optional</sup> <a name="samlConfiguration" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.samlConfiguration"></a>
|
|
1102
2269
|
|
|
1103
2270
|
```typescript
|
|
1104
2271
|
public readonly samlConfiguration: SamlConfiguration;
|
|
@@ -1110,7 +2277,7 @@ If the workspace uses SAML, use this structure to map SAML assertion attributes
|
|
|
1110
2277
|
|
|
1111
2278
|
---
|
|
1112
2279
|
|
|
1113
|
-
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.
|
|
2280
|
+
##### `stackSetName`<sup>Optional</sup> <a name="stackSetName" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.stackSetName"></a>
|
|
1114
2281
|
|
|
1115
2282
|
```typescript
|
|
1116
2283
|
public readonly stackSetName: string;
|
|
@@ -1122,7 +2289,7 @@ The name of the AWS CloudFormation stack set that is used to generate IAM roles
|
|
|
1122
2289
|
|
|
1123
2290
|
---
|
|
1124
2291
|
|
|
1125
|
-
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.
|
|
2292
|
+
##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@robhan-cdk-lib/aws_grafana.IWorkspace.property.vpcConfiguration"></a>
|
|
1126
2293
|
|
|
1127
2294
|
```typescript
|
|
1128
2295
|
public readonly vpcConfiguration: VpcConfiguration;
|
|
@@ -1134,8 +2301,6 @@ The configuration settings for an Amazon VPC that contains data sources for your
|
|
|
1134
2301
|
|
|
1135
2302
|
---
|
|
1136
2303
|
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
2304
|
## Enums <a name="Enums" id="Enums"></a>
|
|
1140
2305
|
|
|
1141
2306
|
### AccountAccessType <a name="AccountAccessType" id="@robhan-cdk-lib/aws_grafana.AccountAccessType"></a>
|