@paulo_raca/cdk-skylight 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md.md ADDED
@@ -0,0 +1,2038 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### AwsManagedMicrosoftAd <a name="AwsManagedMicrosoftAd" id="cdk-skylight.authentication.AwsManagedMicrosoftAd"></a>
6
+
7
+ A Ad Authentication represents an integration pattern of Managed AD and Route 53 Resolver in a specific VPC.
8
+
9
+ The Construct creates Managed AD with the provided Secret (Secrets Manager) or generates a new Secret.
10
+ The secret saved to SSM parameter store so others can use it with other Constructs (Such as Windows node or FSx)
11
+ The provided VPC or the new created VPC will be configured to forward DNS requests to the Managed AD with Route53 Resolvers
12
+ The construct also creates (optionally) t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createADGroup)
13
+
14
+ The createADGroup() method creates an Active Directory permission group in the domain, using the domain admin user.
15
+ Please note: When calling createADGroup() API, a Lambda will be created to start the worker machine (Using AWS-SDK),
16
+ then each command will be scheduled with State Manager, and the instance will be shut down after complete.
17
+
18
+ #### Initializers <a name="Initializers" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer"></a>
19
+
20
+ ```typescript
21
+ import { authentication } from 'cdk-skylight'
22
+
23
+ new authentication.AwsManagedMicrosoftAd(scope: Construct, id: string, props: IAwsManagedMicrosoftAdProps)
24
+ ```
25
+
26
+ | **Name** | **Type** | **Description** |
27
+ | --- | --- | --- |
28
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
29
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
30
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer.parameter.props">props</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdProps</code> | *No description.* |
31
+
32
+ ---
33
+
34
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer.parameter.scope"></a>
35
+
36
+ - *Type:* constructs.Construct
37
+
38
+ ---
39
+
40
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer.parameter.id"></a>
41
+
42
+ - *Type:* string
43
+
44
+ ---
45
+
46
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.Initializer.parameter.props"></a>
47
+
48
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdProps
49
+
50
+ ---
51
+
52
+ #### Methods <a name="Methods" id="Methods"></a>
53
+
54
+ | **Name** | **Description** |
55
+ | --- | --- |
56
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.toString">toString</a></code> | Returns a string representation of this construct. |
57
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.createADGroup">createADGroup</a></code> | *No description.* |
58
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.createServiceAccount">createServiceAccount</a></code> | *No description.* |
59
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.createWorker">createWorker</a></code> | *No description.* |
60
+
61
+ ---
62
+
63
+ ##### `toString` <a name="toString" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.toString"></a>
64
+
65
+ ```typescript
66
+ public toString(): string
67
+ ```
68
+
69
+ Returns a string representation of this construct.
70
+
71
+ ##### `createADGroup` <a name="createADGroup" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createADGroup"></a>
72
+
73
+ ```typescript
74
+ public createADGroup(groupName: string, groupDescription: string): void
75
+ ```
76
+
77
+ ###### `groupName`<sup>Required</sup> <a name="groupName" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createADGroup.parameter.groupName"></a>
78
+
79
+ - *Type:* string
80
+
81
+ ---
82
+
83
+ ###### `groupDescription`<sup>Required</sup> <a name="groupDescription" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createADGroup.parameter.groupDescription"></a>
84
+
85
+ - *Type:* string
86
+
87
+ ---
88
+
89
+ ##### `createServiceAccount` <a name="createServiceAccount" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createServiceAccount"></a>
90
+
91
+ ```typescript
92
+ public createServiceAccount(adServiceAccountName: string, servicePrincipalNames: string, principalsAllowedToRetrieveManagedPassword: string): void
93
+ ```
94
+
95
+ ###### `adServiceAccountName`<sup>Required</sup> <a name="adServiceAccountName" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createServiceAccount.parameter.adServiceAccountName"></a>
96
+
97
+ - *Type:* string
98
+
99
+ ---
100
+
101
+ ###### `servicePrincipalNames`<sup>Required</sup> <a name="servicePrincipalNames" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createServiceAccount.parameter.servicePrincipalNames"></a>
102
+
103
+ - *Type:* string
104
+
105
+ ---
106
+
107
+ ###### `principalsAllowedToRetrieveManagedPassword`<sup>Required</sup> <a name="principalsAllowedToRetrieveManagedPassword" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createServiceAccount.parameter.principalsAllowedToRetrieveManagedPassword"></a>
108
+
109
+ - *Type:* string
110
+
111
+ ---
112
+
113
+ ##### `createWorker` <a name="createWorker" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createWorker"></a>
114
+
115
+ ```typescript
116
+ public createWorker(domainName: string, domainPassword: ISecret): DomainWindowsNode
117
+ ```
118
+
119
+ ###### `domainName`<sup>Required</sup> <a name="domainName" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createWorker.parameter.domainName"></a>
120
+
121
+ - *Type:* string
122
+
123
+ ---
124
+
125
+ ###### `domainPassword`<sup>Required</sup> <a name="domainPassword" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.createWorker.parameter.domainPassword"></a>
126
+
127
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
128
+
129
+ ---
130
+
131
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
132
+
133
+ | **Name** | **Description** |
134
+ | --- | --- |
135
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
136
+
137
+ ---
138
+
139
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.isConstruct"></a>
140
+
141
+ ```typescript
142
+ import { authentication } from 'cdk-skylight'
143
+
144
+ authentication.AwsManagedMicrosoftAd.isConstruct(x: any)
145
+ ```
146
+
147
+ Checks if `x` is a construct.
148
+
149
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.isConstruct.parameter.x"></a>
150
+
151
+ - *Type:* any
152
+
153
+ Any object.
154
+
155
+ ---
156
+
157
+ #### Properties <a name="Properties" id="Properties"></a>
158
+
159
+ | **Name** | **Type** | **Description** |
160
+ | --- | --- | --- |
161
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
162
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.property.adParameters">adParameters</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters</code> | *No description.* |
163
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.property.microsoftAD">microsoftAD</a></code> | <code>aws-cdk-lib.aws_directoryservice.CfnMicrosoftAD</code> | *No description.* |
164
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.property.props">props</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdProps</code> | *No description.* |
165
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.property.secret">secret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
166
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAd.property.domainWindowsNode">domainWindowsNode</a></code> | <code>cdk-skylight.compute.DomainWindowsNode</code> | *No description.* |
167
+
168
+ ---
169
+
170
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.property.node"></a>
171
+
172
+ ```typescript
173
+ public readonly node: Node;
174
+ ```
175
+
176
+ - *Type:* constructs.Node
177
+
178
+ The tree node.
179
+
180
+ ---
181
+
182
+ ##### `adParameters`<sup>Required</sup> <a name="adParameters" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.property.adParameters"></a>
183
+
184
+ ```typescript
185
+ public readonly adParameters: IAwsManagedMicrosoftAdParameters;
186
+ ```
187
+
188
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
189
+
190
+ ---
191
+
192
+ ##### `microsoftAD`<sup>Required</sup> <a name="microsoftAD" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.property.microsoftAD"></a>
193
+
194
+ ```typescript
195
+ public readonly microsoftAD: CfnMicrosoftAD;
196
+ ```
197
+
198
+ - *Type:* aws-cdk-lib.aws_directoryservice.CfnMicrosoftAD
199
+
200
+ ---
201
+
202
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.property.props"></a>
203
+
204
+ ```typescript
205
+ public readonly props: IAwsManagedMicrosoftAdProps;
206
+ ```
207
+
208
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdProps
209
+
210
+ ---
211
+
212
+ ##### `secret`<sup>Required</sup> <a name="secret" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.property.secret"></a>
213
+
214
+ ```typescript
215
+ public readonly secret: ISecret;
216
+ ```
217
+
218
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
219
+
220
+ ---
221
+
222
+ ##### `domainWindowsNode`<sup>Optional</sup> <a name="domainWindowsNode" id="cdk-skylight.authentication.AwsManagedMicrosoftAd.property.domainWindowsNode"></a>
223
+
224
+ ```typescript
225
+ public readonly domainWindowsNode: DomainWindowsNode;
226
+ ```
227
+
228
+ - *Type:* cdk-skylight.compute.DomainWindowsNode
229
+
230
+ ---
231
+
232
+
233
+ ### AwsManagedMicrosoftAdR53 <a name="AwsManagedMicrosoftAdR53" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53"></a>
234
+
235
+ A Ad Authentication represents an integration pattern of Managed AD and Route 53 Resolver in a specific VPC.
236
+
237
+ The Construct creates Managed AD with the provided Secret (Secrets Manager) or generates a new Secret.
238
+ The secret saved to SSM parameter store so others can use it with other Constructs (Such as Windows node or FSx)
239
+ The provided VPC or the new created VPC will be configured to forward DNS requests to the Managed AD with Route53 Resolvers
240
+ The construct also creates (optionally) t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createADGroup)
241
+
242
+ The createADGroup() method creates an Active Directory permission group in the domain, using the domain admin user.
243
+ Please note: When calling createADGroup() API, a Lambda will be created to start the worker machine (Using AWS-SDK),
244
+ then each command will be scheduled with State Manager, and the instance will be shut down after complete.
245
+
246
+ #### Initializers <a name="Initializers" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer"></a>
247
+
248
+ ```typescript
249
+ import { authentication } from 'cdk-skylight'
250
+
251
+ new authentication.AwsManagedMicrosoftAdR53(scope: Construct, id: string, props: IAwsManagedMicrosoftAdProps)
252
+ ```
253
+
254
+ | **Name** | **Type** | **Description** |
255
+ | --- | --- | --- |
256
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
257
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
258
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer.parameter.props">props</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdProps</code> | *No description.* |
259
+
260
+ ---
261
+
262
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer.parameter.scope"></a>
263
+
264
+ - *Type:* constructs.Construct
265
+
266
+ ---
267
+
268
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer.parameter.id"></a>
269
+
270
+ - *Type:* string
271
+
272
+ ---
273
+
274
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.Initializer.parameter.props"></a>
275
+
276
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdProps
277
+
278
+ ---
279
+
280
+ #### Methods <a name="Methods" id="Methods"></a>
281
+
282
+ | **Name** | **Description** |
283
+ | --- | --- |
284
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.toString">toString</a></code> | Returns a string representation of this construct. |
285
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createADGroup">createADGroup</a></code> | *No description.* |
286
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createServiceAccount">createServiceAccount</a></code> | *No description.* |
287
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createWorker">createWorker</a></code> | *No description.* |
288
+
289
+ ---
290
+
291
+ ##### `toString` <a name="toString" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.toString"></a>
292
+
293
+ ```typescript
294
+ public toString(): string
295
+ ```
296
+
297
+ Returns a string representation of this construct.
298
+
299
+ ##### `createADGroup` <a name="createADGroup" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createADGroup"></a>
300
+
301
+ ```typescript
302
+ public createADGroup(groupName: string, groupDescription: string): void
303
+ ```
304
+
305
+ ###### `groupName`<sup>Required</sup> <a name="groupName" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createADGroup.parameter.groupName"></a>
306
+
307
+ - *Type:* string
308
+
309
+ ---
310
+
311
+ ###### `groupDescription`<sup>Required</sup> <a name="groupDescription" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createADGroup.parameter.groupDescription"></a>
312
+
313
+ - *Type:* string
314
+
315
+ ---
316
+
317
+ ##### `createServiceAccount` <a name="createServiceAccount" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createServiceAccount"></a>
318
+
319
+ ```typescript
320
+ public createServiceAccount(adServiceAccountName: string, servicePrincipalNames: string, principalsAllowedToRetrieveManagedPassword: string): void
321
+ ```
322
+
323
+ ###### `adServiceAccountName`<sup>Required</sup> <a name="adServiceAccountName" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createServiceAccount.parameter.adServiceAccountName"></a>
324
+
325
+ - *Type:* string
326
+
327
+ ---
328
+
329
+ ###### `servicePrincipalNames`<sup>Required</sup> <a name="servicePrincipalNames" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createServiceAccount.parameter.servicePrincipalNames"></a>
330
+
331
+ - *Type:* string
332
+
333
+ ---
334
+
335
+ ###### `principalsAllowedToRetrieveManagedPassword`<sup>Required</sup> <a name="principalsAllowedToRetrieveManagedPassword" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createServiceAccount.parameter.principalsAllowedToRetrieveManagedPassword"></a>
336
+
337
+ - *Type:* string
338
+
339
+ ---
340
+
341
+ ##### `createWorker` <a name="createWorker" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createWorker"></a>
342
+
343
+ ```typescript
344
+ public createWorker(domainName: string, domainPassword: ISecret): DomainWindowsNode
345
+ ```
346
+
347
+ ###### `domainName`<sup>Required</sup> <a name="domainName" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createWorker.parameter.domainName"></a>
348
+
349
+ - *Type:* string
350
+
351
+ ---
352
+
353
+ ###### `domainPassword`<sup>Required</sup> <a name="domainPassword" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.createWorker.parameter.domainPassword"></a>
354
+
355
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
356
+
357
+ ---
358
+
359
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
360
+
361
+ | **Name** | **Description** |
362
+ | --- | --- |
363
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
364
+
365
+ ---
366
+
367
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.isConstruct"></a>
368
+
369
+ ```typescript
370
+ import { authentication } from 'cdk-skylight'
371
+
372
+ authentication.AwsManagedMicrosoftAdR53.isConstruct(x: any)
373
+ ```
374
+
375
+ Checks if `x` is a construct.
376
+
377
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.isConstruct.parameter.x"></a>
378
+
379
+ - *Type:* any
380
+
381
+ Any object.
382
+
383
+ ---
384
+
385
+ #### Properties <a name="Properties" id="Properties"></a>
386
+
387
+ | **Name** | **Type** | **Description** |
388
+ | --- | --- | --- |
389
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
390
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.adParameters">adParameters</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters</code> | *No description.* |
391
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.microsoftAD">microsoftAD</a></code> | <code>aws-cdk-lib.aws_directoryservice.CfnMicrosoftAD</code> | *No description.* |
392
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.props">props</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdProps</code> | *No description.* |
393
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.secret">secret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
394
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.domainWindowsNode">domainWindowsNode</a></code> | <code>cdk-skylight.compute.DomainWindowsNode</code> | *No description.* |
395
+
396
+ ---
397
+
398
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.node"></a>
399
+
400
+ ```typescript
401
+ public readonly node: Node;
402
+ ```
403
+
404
+ - *Type:* constructs.Node
405
+
406
+ The tree node.
407
+
408
+ ---
409
+
410
+ ##### `adParameters`<sup>Required</sup> <a name="adParameters" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.adParameters"></a>
411
+
412
+ ```typescript
413
+ public readonly adParameters: IAwsManagedMicrosoftAdParameters;
414
+ ```
415
+
416
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
417
+
418
+ ---
419
+
420
+ ##### `microsoftAD`<sup>Required</sup> <a name="microsoftAD" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.microsoftAD"></a>
421
+
422
+ ```typescript
423
+ public readonly microsoftAD: CfnMicrosoftAD;
424
+ ```
425
+
426
+ - *Type:* aws-cdk-lib.aws_directoryservice.CfnMicrosoftAD
427
+
428
+ ---
429
+
430
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.props"></a>
431
+
432
+ ```typescript
433
+ public readonly props: IAwsManagedMicrosoftAdProps;
434
+ ```
435
+
436
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdProps
437
+
438
+ ---
439
+
440
+ ##### `secret`<sup>Required</sup> <a name="secret" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.secret"></a>
441
+
442
+ ```typescript
443
+ public readonly secret: ISecret;
444
+ ```
445
+
446
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
447
+
448
+ ---
449
+
450
+ ##### `domainWindowsNode`<sup>Optional</sup> <a name="domainWindowsNode" id="cdk-skylight.authentication.AwsManagedMicrosoftAdR53.property.domainWindowsNode"></a>
451
+
452
+ ```typescript
453
+ public readonly domainWindowsNode: DomainWindowsNode;
454
+ ```
455
+
456
+ - *Type:* cdk-skylight.compute.DomainWindowsNode
457
+
458
+ ---
459
+
460
+
461
+ ### DomainWindowsNode <a name="DomainWindowsNode" id="cdk-skylight.compute.DomainWindowsNode"></a>
462
+
463
+ A Domain Windows Node represents one Windows EC2 instance configured with Active Directory.
464
+
465
+ The DomainWindowsNode can be customized to different instance sizes and additional permissions set just like any other EC2 Instance.
466
+ You can use this construct to run elevated domain tasks with domain permissions or run your application in a single instance setup.
467
+
468
+ The machine will be joined to the provided Active Directory domain using a custom CloudFormation bootstrap that will wait until the required reboot to join the domain. Then it will register the machine in SSM and pull tasks from the SSM State manager.
469
+
470
+ You can send tasks to that machine using the provided methods: runPsCommands() and runPSwithDomainAdmin()
471
+
472
+ #### Initializers <a name="Initializers" id="cdk-skylight.compute.DomainWindowsNode.Initializer"></a>
473
+
474
+ ```typescript
475
+ import { compute } from 'cdk-skylight'
476
+
477
+ new compute.DomainWindowsNode(scope: Construct, id: string, props: IDomainWindowsNodeProps)
478
+ ```
479
+
480
+ | **Name** | **Type** | **Description** |
481
+ | --- | --- | --- |
482
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
483
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
484
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.Initializer.parameter.props">props</a></code> | <code>cdk-skylight.compute.IDomainWindowsNodeProps</code> | *No description.* |
485
+
486
+ ---
487
+
488
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-skylight.compute.DomainWindowsNode.Initializer.parameter.scope"></a>
489
+
490
+ - *Type:* constructs.Construct
491
+
492
+ ---
493
+
494
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.compute.DomainWindowsNode.Initializer.parameter.id"></a>
495
+
496
+ - *Type:* string
497
+
498
+ ---
499
+
500
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.compute.DomainWindowsNode.Initializer.parameter.props"></a>
501
+
502
+ - *Type:* cdk-skylight.compute.IDomainWindowsNodeProps
503
+
504
+ ---
505
+
506
+ #### Methods <a name="Methods" id="Methods"></a>
507
+
508
+ | **Name** | **Description** |
509
+ | --- | --- |
510
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.toString">toString</a></code> | Returns a string representation of this construct. |
511
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.openRDP">openRDP</a></code> | Open the security group of the Node Node to specific IP address on port 3389 i.e: openRDP("1.1.1.1/32"). |
512
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.runPsCommands">runPsCommands</a></code> | Running PowerShell scripts on the Node with SSM Document. |
513
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.runPSwithDomainAdmin">runPSwithDomainAdmin</a></code> | Running PowerShell scripts on the Node with SSM Document with Domain Admin (Using the Secret used to join the machine to the domain) i.e: runPsCommands(["Write-host 'Hello world'", "Write-host 'Second command'"], "myScript") The provided psCommands will be stored in C:\Scripts and will be run with scheduled task with Domain Admin rights. |
514
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.runShellCommands">runShellCommands</a></code> | Running bash scripts on the Node with SSM Document. |
515
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.startInstance">startInstance</a></code> | *No description.* |
516
+
517
+ ---
518
+
519
+ ##### `toString` <a name="toString" id="cdk-skylight.compute.DomainWindowsNode.toString"></a>
520
+
521
+ ```typescript
522
+ public toString(): string
523
+ ```
524
+
525
+ Returns a string representation of this construct.
526
+
527
+ ##### `openRDP` <a name="openRDP" id="cdk-skylight.compute.DomainWindowsNode.openRDP"></a>
528
+
529
+ ```typescript
530
+ public openRDP(ipaddress: string): void
531
+ ```
532
+
533
+ Open the security group of the Node Node to specific IP address on port 3389 i.e: openRDP("1.1.1.1/32").
534
+
535
+ ###### `ipaddress`<sup>Required</sup> <a name="ipaddress" id="cdk-skylight.compute.DomainWindowsNode.openRDP.parameter.ipaddress"></a>
536
+
537
+ - *Type:* string
538
+
539
+ ---
540
+
541
+ ##### `runPsCommands` <a name="runPsCommands" id="cdk-skylight.compute.DomainWindowsNode.runPsCommands"></a>
542
+
543
+ ```typescript
544
+ public runPsCommands(psCommands: string[], id: string): void
545
+ ```
546
+
547
+ Running PowerShell scripts on the Node with SSM Document.
548
+
549
+ i.e: runPsCommands(["Write-host 'Hello world'", "Write-host 'Second command'"], "myScript")
550
+
551
+ ###### `psCommands`<sup>Required</sup> <a name="psCommands" id="cdk-skylight.compute.DomainWindowsNode.runPsCommands.parameter.psCommands"></a>
552
+
553
+ - *Type:* string[]
554
+
555
+ ---
556
+
557
+ ###### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.compute.DomainWindowsNode.runPsCommands.parameter.id"></a>
558
+
559
+ - *Type:* string
560
+
561
+ ---
562
+
563
+ ##### `runPSwithDomainAdmin` <a name="runPSwithDomainAdmin" id="cdk-skylight.compute.DomainWindowsNode.runPSwithDomainAdmin"></a>
564
+
565
+ ```typescript
566
+ public runPSwithDomainAdmin(psCommands: string[], id: string): void
567
+ ```
568
+
569
+ Running PowerShell scripts on the Node with SSM Document with Domain Admin (Using the Secret used to join the machine to the domain) i.e: runPsCommands(["Write-host 'Hello world'", "Write-host 'Second command'"], "myScript") The provided psCommands will be stored in C:\Scripts and will be run with scheduled task with Domain Admin rights.
570
+
571
+ ###### `psCommands`<sup>Required</sup> <a name="psCommands" id="cdk-skylight.compute.DomainWindowsNode.runPSwithDomainAdmin.parameter.psCommands"></a>
572
+
573
+ - *Type:* string[]
574
+
575
+ ---
576
+
577
+ ###### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.compute.DomainWindowsNode.runPSwithDomainAdmin.parameter.id"></a>
578
+
579
+ - *Type:* string
580
+
581
+ ---
582
+
583
+ ##### `runShellCommands` <a name="runShellCommands" id="cdk-skylight.compute.DomainWindowsNode.runShellCommands"></a>
584
+
585
+ ```typescript
586
+ public runShellCommands(ShellCommands: string[], id: string): void
587
+ ```
588
+
589
+ Running bash scripts on the Node with SSM Document.
590
+
591
+ i.e: runPsCommands(["echo 'hello world'", "echo 'Second command'"], "myScript")
592
+
593
+ ###### `ShellCommands`<sup>Required</sup> <a name="ShellCommands" id="cdk-skylight.compute.DomainWindowsNode.runShellCommands.parameter.ShellCommands"></a>
594
+
595
+ - *Type:* string[]
596
+
597
+ ---
598
+
599
+ ###### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.compute.DomainWindowsNode.runShellCommands.parameter.id"></a>
600
+
601
+ - *Type:* string
602
+
603
+ ---
604
+
605
+ ##### `startInstance` <a name="startInstance" id="cdk-skylight.compute.DomainWindowsNode.startInstance"></a>
606
+
607
+ ```typescript
608
+ public startInstance(): void
609
+ ```
610
+
611
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
612
+
613
+ | **Name** | **Description** |
614
+ | --- | --- |
615
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
616
+
617
+ ---
618
+
619
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-skylight.compute.DomainWindowsNode.isConstruct"></a>
620
+
621
+ ```typescript
622
+ import { compute } from 'cdk-skylight'
623
+
624
+ compute.DomainWindowsNode.isConstruct(x: any)
625
+ ```
626
+
627
+ Checks if `x` is a construct.
628
+
629
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-skylight.compute.DomainWindowsNode.isConstruct.parameter.x"></a>
630
+
631
+ - *Type:* any
632
+
633
+ Any object.
634
+
635
+ ---
636
+
637
+ #### Properties <a name="Properties" id="Properties"></a>
638
+
639
+ | **Name** | **Type** | **Description** |
640
+ | --- | --- | --- |
641
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
642
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.property.instance">instance</a></code> | <code>aws-cdk-lib.aws_ec2.Instance</code> | *No description.* |
643
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.property.nodeRole">nodeRole</a></code> | <code>aws-cdk-lib.aws_iam.Role</code> | *No description.* |
644
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
645
+ | <code><a href="#cdk-skylight.compute.DomainWindowsNode.property.passwordObject">passwordObject</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
646
+
647
+ ---
648
+
649
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-skylight.compute.DomainWindowsNode.property.node"></a>
650
+
651
+ ```typescript
652
+ public readonly node: Node;
653
+ ```
654
+
655
+ - *Type:* constructs.Node
656
+
657
+ The tree node.
658
+
659
+ ---
660
+
661
+ ##### `instance`<sup>Required</sup> <a name="instance" id="cdk-skylight.compute.DomainWindowsNode.property.instance"></a>
662
+
663
+ ```typescript
664
+ public readonly instance: Instance;
665
+ ```
666
+
667
+ - *Type:* aws-cdk-lib.aws_ec2.Instance
668
+
669
+ ---
670
+
671
+ ##### `nodeRole`<sup>Required</sup> <a name="nodeRole" id="cdk-skylight.compute.DomainWindowsNode.property.nodeRole"></a>
672
+
673
+ ```typescript
674
+ public readonly nodeRole: Role;
675
+ ```
676
+
677
+ - *Type:* aws-cdk-lib.aws_iam.Role
678
+
679
+ ---
680
+
681
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.compute.DomainWindowsNode.property.vpc"></a>
682
+
683
+ ```typescript
684
+ public readonly vpc: IVpc;
685
+ ```
686
+
687
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
688
+
689
+ ---
690
+
691
+ ##### `passwordObject`<sup>Optional</sup> <a name="passwordObject" id="cdk-skylight.compute.DomainWindowsNode.property.passwordObject"></a>
692
+
693
+ ```typescript
694
+ public readonly passwordObject: ISecret;
695
+ ```
696
+
697
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
698
+
699
+ ---
700
+
701
+
702
+ ### FSxWindows <a name="FSxWindows" id="cdk-skylight.storage.FSxWindows"></a>
703
+
704
+ A FSxWindows represents an integration pattern of Amazon FSx and Managed AD in a specific VPC.
705
+
706
+ The Construct creates Amazon FSx for Windows
707
+ The construct also creates (optionally) t3.nano machine that is part of the domain that can be used to run admin-tasks (such as createFolder)
708
+
709
+ The createFolder() method creates an SMB Folder in the FSx filesystem, using the domain admin user.
710
+ Please note: When calling createFolder() API, a Lambda will be created to start the worker machine (Using AWS-SDK),
711
+ then each command will be scheduled with State Manager, and the instance will be shut down after complete .
712
+
713
+ #### Initializers <a name="Initializers" id="cdk-skylight.storage.FSxWindows.Initializer"></a>
714
+
715
+ ```typescript
716
+ import { storage } from 'cdk-skylight'
717
+
718
+ new storage.FSxWindows(scope: Construct, id: string, props: IFSxWindowsProps)
719
+ ```
720
+
721
+ | **Name** | **Type** | **Description** |
722
+ | --- | --- | --- |
723
+ | <code><a href="#cdk-skylight.storage.FSxWindows.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
724
+ | <code><a href="#cdk-skylight.storage.FSxWindows.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
725
+ | <code><a href="#cdk-skylight.storage.FSxWindows.Initializer.parameter.props">props</a></code> | <code>cdk-skylight.storage.IFSxWindowsProps</code> | *No description.* |
726
+
727
+ ---
728
+
729
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-skylight.storage.FSxWindows.Initializer.parameter.scope"></a>
730
+
731
+ - *Type:* constructs.Construct
732
+
733
+ ---
734
+
735
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.storage.FSxWindows.Initializer.parameter.id"></a>
736
+
737
+ - *Type:* string
738
+
739
+ ---
740
+
741
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.storage.FSxWindows.Initializer.parameter.props"></a>
742
+
743
+ - *Type:* cdk-skylight.storage.IFSxWindowsProps
744
+
745
+ ---
746
+
747
+ #### Methods <a name="Methods" id="Methods"></a>
748
+
749
+ | **Name** | **Description** |
750
+ | --- | --- |
751
+ | <code><a href="#cdk-skylight.storage.FSxWindows.toString">toString</a></code> | Returns a string representation of this construct. |
752
+ | <code><a href="#cdk-skylight.storage.FSxWindows.createFolder">createFolder</a></code> | *No description.* |
753
+ | <code><a href="#cdk-skylight.storage.FSxWindows.createWorker">createWorker</a></code> | *No description.* |
754
+
755
+ ---
756
+
757
+ ##### `toString` <a name="toString" id="cdk-skylight.storage.FSxWindows.toString"></a>
758
+
759
+ ```typescript
760
+ public toString(): string
761
+ ```
762
+
763
+ Returns a string representation of this construct.
764
+
765
+ ##### `createFolder` <a name="createFolder" id="cdk-skylight.storage.FSxWindows.createFolder"></a>
766
+
767
+ ```typescript
768
+ public createFolder(worker: DomainWindowsNode, folderName: string, secretName: ISecret): void
769
+ ```
770
+
771
+ ###### `worker`<sup>Required</sup> <a name="worker" id="cdk-skylight.storage.FSxWindows.createFolder.parameter.worker"></a>
772
+
773
+ - *Type:* cdk-skylight.compute.DomainWindowsNode
774
+
775
+ ---
776
+
777
+ ###### `folderName`<sup>Required</sup> <a name="folderName" id="cdk-skylight.storage.FSxWindows.createFolder.parameter.folderName"></a>
778
+
779
+ - *Type:* string
780
+
781
+ ---
782
+
783
+ ###### `secretName`<sup>Required</sup> <a name="secretName" id="cdk-skylight.storage.FSxWindows.createFolder.parameter.secretName"></a>
784
+
785
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
786
+
787
+ ---
788
+
789
+ ##### `createWorker` <a name="createWorker" id="cdk-skylight.storage.FSxWindows.createWorker"></a>
790
+
791
+ ```typescript
792
+ public createWorker(domainName: string, domainPassword: ISecret): DomainWindowsNode
793
+ ```
794
+
795
+ ###### `domainName`<sup>Required</sup> <a name="domainName" id="cdk-skylight.storage.FSxWindows.createWorker.parameter.domainName"></a>
796
+
797
+ - *Type:* string
798
+
799
+ ---
800
+
801
+ ###### `domainPassword`<sup>Required</sup> <a name="domainPassword" id="cdk-skylight.storage.FSxWindows.createWorker.parameter.domainPassword"></a>
802
+
803
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
804
+
805
+ ---
806
+
807
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
808
+
809
+ | **Name** | **Description** |
810
+ | --- | --- |
811
+ | <code><a href="#cdk-skylight.storage.FSxWindows.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
812
+
813
+ ---
814
+
815
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-skylight.storage.FSxWindows.isConstruct"></a>
816
+
817
+ ```typescript
818
+ import { storage } from 'cdk-skylight'
819
+
820
+ storage.FSxWindows.isConstruct(x: any)
821
+ ```
822
+
823
+ Checks if `x` is a construct.
824
+
825
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-skylight.storage.FSxWindows.isConstruct.parameter.x"></a>
826
+
827
+ - *Type:* any
828
+
829
+ Any object.
830
+
831
+ ---
832
+
833
+ #### Properties <a name="Properties" id="Properties"></a>
834
+
835
+ | **Name** | **Type** | **Description** |
836
+ | --- | --- | --- |
837
+ | <code><a href="#cdk-skylight.storage.FSxWindows.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
838
+ | <code><a href="#cdk-skylight.storage.FSxWindows.property.fsxObject">fsxObject</a></code> | <code>aws-cdk-lib.aws_fsx.CfnFileSystem</code> | *No description.* |
839
+ | <code><a href="#cdk-skylight.storage.FSxWindows.property.props">props</a></code> | <code>cdk-skylight.storage.IFSxWindowsProps</code> | *No description.* |
840
+ | <code><a href="#cdk-skylight.storage.FSxWindows.property.ssmParameters">ssmParameters</a></code> | <code>cdk-skylight.storage.IFSxWindowsParameters</code> | *No description.* |
841
+
842
+ ---
843
+
844
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-skylight.storage.FSxWindows.property.node"></a>
845
+
846
+ ```typescript
847
+ public readonly node: Node;
848
+ ```
849
+
850
+ - *Type:* constructs.Node
851
+
852
+ The tree node.
853
+
854
+ ---
855
+
856
+ ##### `fsxObject`<sup>Required</sup> <a name="fsxObject" id="cdk-skylight.storage.FSxWindows.property.fsxObject"></a>
857
+
858
+ ```typescript
859
+ public readonly fsxObject: CfnFileSystem;
860
+ ```
861
+
862
+ - *Type:* aws-cdk-lib.aws_fsx.CfnFileSystem
863
+
864
+ ---
865
+
866
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.storage.FSxWindows.property.props"></a>
867
+
868
+ ```typescript
869
+ public readonly props: IFSxWindowsProps;
870
+ ```
871
+
872
+ - *Type:* cdk-skylight.storage.IFSxWindowsProps
873
+
874
+ ---
875
+
876
+ ##### `ssmParameters`<sup>Required</sup> <a name="ssmParameters" id="cdk-skylight.storage.FSxWindows.property.ssmParameters"></a>
877
+
878
+ ```typescript
879
+ public readonly ssmParameters: IFSxWindowsParameters;
880
+ ```
881
+
882
+ - *Type:* cdk-skylight.storage.IFSxWindowsParameters
883
+
884
+ ---
885
+
886
+
887
+ ### WindowsEKSCluster <a name="WindowsEKSCluster" id="cdk-skylight.compute.WindowsEKSCluster"></a>
888
+
889
+ #### Initializers <a name="Initializers" id="cdk-skylight.compute.WindowsEKSCluster.Initializer"></a>
890
+
891
+ ```typescript
892
+ import { compute } from 'cdk-skylight'
893
+
894
+ new compute.WindowsEKSCluster(scope: Construct, id: string, props: IWindowsEKSClusterProps)
895
+ ```
896
+
897
+ | **Name** | **Type** | **Description** |
898
+ | --- | --- | --- |
899
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
900
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
901
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.Initializer.parameter.props">props</a></code> | <code>cdk-skylight.compute.IWindowsEKSClusterProps</code> | *No description.* |
902
+
903
+ ---
904
+
905
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-skylight.compute.WindowsEKSCluster.Initializer.parameter.scope"></a>
906
+
907
+ - *Type:* constructs.Construct
908
+
909
+ ---
910
+
911
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.compute.WindowsEKSCluster.Initializer.parameter.id"></a>
912
+
913
+ - *Type:* string
914
+
915
+ ---
916
+
917
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.compute.WindowsEKSCluster.Initializer.parameter.props"></a>
918
+
919
+ - *Type:* cdk-skylight.compute.IWindowsEKSClusterProps
920
+
921
+ ---
922
+
923
+ #### Methods <a name="Methods" id="Methods"></a>
924
+
925
+ | **Name** | **Description** |
926
+ | --- | --- |
927
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.toString">toString</a></code> | Returns a string representation of this construct. |
928
+
929
+ ---
930
+
931
+ ##### `toString` <a name="toString" id="cdk-skylight.compute.WindowsEKSCluster.toString"></a>
932
+
933
+ ```typescript
934
+ public toString(): string
935
+ ```
936
+
937
+ Returns a string representation of this construct.
938
+
939
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
940
+
941
+ | **Name** | **Description** |
942
+ | --- | --- |
943
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
944
+
945
+ ---
946
+
947
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-skylight.compute.WindowsEKSCluster.isConstruct"></a>
948
+
949
+ ```typescript
950
+ import { compute } from 'cdk-skylight'
951
+
952
+ compute.WindowsEKSCluster.isConstruct(x: any)
953
+ ```
954
+
955
+ Checks if `x` is a construct.
956
+
957
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-skylight.compute.WindowsEKSCluster.isConstruct.parameter.x"></a>
958
+
959
+ - *Type:* any
960
+
961
+ Any object.
962
+
963
+ ---
964
+
965
+ #### Properties <a name="Properties" id="Properties"></a>
966
+
967
+ | **Name** | **Type** | **Description** |
968
+ | --- | --- | --- |
969
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
970
+ | <code><a href="#cdk-skylight.compute.WindowsEKSCluster.property.eksCluster">eksCluster</a></code> | <code>aws-cdk-lib.aws_eks.Cluster</code> | *No description.* |
971
+
972
+ ---
973
+
974
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-skylight.compute.WindowsEKSCluster.property.node"></a>
975
+
976
+ ```typescript
977
+ public readonly node: Node;
978
+ ```
979
+
980
+ - *Type:* constructs.Node
981
+
982
+ The tree node.
983
+
984
+ ---
985
+
986
+ ##### `eksCluster`<sup>Required</sup> <a name="eksCluster" id="cdk-skylight.compute.WindowsEKSCluster.property.eksCluster"></a>
987
+
988
+ ```typescript
989
+ public readonly eksCluster: Cluster;
990
+ ```
991
+
992
+ - *Type:* aws-cdk-lib.aws_eks.Cluster
993
+
994
+ ---
995
+
996
+
997
+ ### WindowsEKSNodes <a name="WindowsEKSNodes" id="cdk-skylight.compute.WindowsEKSNodes"></a>
998
+
999
+ - *Implements:* cdk-skylight.compute.IRuntimeNodes
1000
+
1001
+ #### Initializers <a name="Initializers" id="cdk-skylight.compute.WindowsEKSNodes.Initializer"></a>
1002
+
1003
+ ```typescript
1004
+ import { compute } from 'cdk-skylight'
1005
+
1006
+ new compute.WindowsEKSNodes(scope: Construct, id: string, props: IWindowsEKSNodesProps)
1007
+ ```
1008
+
1009
+ | **Name** | **Type** | **Description** |
1010
+ | --- | --- | --- |
1011
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
1012
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
1013
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.Initializer.parameter.props">props</a></code> | <code>cdk-skylight.compute.IWindowsEKSNodesProps</code> | *No description.* |
1014
+
1015
+ ---
1016
+
1017
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-skylight.compute.WindowsEKSNodes.Initializer.parameter.scope"></a>
1018
+
1019
+ - *Type:* constructs.Construct
1020
+
1021
+ ---
1022
+
1023
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-skylight.compute.WindowsEKSNodes.Initializer.parameter.id"></a>
1024
+
1025
+ - *Type:* string
1026
+
1027
+ ---
1028
+
1029
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-skylight.compute.WindowsEKSNodes.Initializer.parameter.props"></a>
1030
+
1031
+ - *Type:* cdk-skylight.compute.IWindowsEKSNodesProps
1032
+
1033
+ ---
1034
+
1035
+ #### Methods <a name="Methods" id="Methods"></a>
1036
+
1037
+ | **Name** | **Description** |
1038
+ | --- | --- |
1039
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.toString">toString</a></code> | Returns a string representation of this construct. |
1040
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.addAdDependency">addAdDependency</a></code> | Method to configure the Nodes to part of AD Domain Secret: The secrets manager secret to use must be in format: '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}' (From cdk-skylight.AwsManagedMicrosoftAdR53 Object). |
1041
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.addEKSDependency">addEKSDependency</a></code> | Method to add the nodes to specific Cluster. |
1042
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.addLocalCredFile">addLocalCredFile</a></code> | Method to add support for LocalCredFile <Experimental>. |
1043
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.addStorageDependency">addStorageDependency</a></code> | Method to configure persistent storage dependency to the hosts by using Global Mapping. |
1044
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.addUserData">addUserData</a></code> | Method to add userData to the nodes. |
1045
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.gMSAWebHookAutoInstall">gMSAWebHookAutoInstall</a></code> | *No description.* |
1046
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.runPowerShellSSMDocument">runPowerShellSSMDocument</a></code> | *No description.* |
1047
+
1048
+ ---
1049
+
1050
+ ##### `toString` <a name="toString" id="cdk-skylight.compute.WindowsEKSNodes.toString"></a>
1051
+
1052
+ ```typescript
1053
+ public toString(): string
1054
+ ```
1055
+
1056
+ Returns a string representation of this construct.
1057
+
1058
+ ##### `addAdDependency` <a name="addAdDependency" id="cdk-skylight.compute.WindowsEKSNodes.addAdDependency"></a>
1059
+
1060
+ ```typescript
1061
+ public addAdDependency(adParametersStore: IAwsManagedMicrosoftAdParameters): void
1062
+ ```
1063
+
1064
+ Method to configure the Nodes to part of AD Domain Secret: The secrets manager secret to use must be in format: '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}' (From cdk-skylight.AwsManagedMicrosoftAdR53 Object).
1065
+
1066
+ ###### `adParametersStore`<sup>Required</sup> <a name="adParametersStore" id="cdk-skylight.compute.WindowsEKSNodes.addAdDependency.parameter.adParametersStore"></a>
1067
+
1068
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1069
+
1070
+ ---
1071
+
1072
+ ##### `addEKSDependency` <a name="addEKSDependency" id="cdk-skylight.compute.WindowsEKSNodes.addEKSDependency"></a>
1073
+
1074
+ ```typescript
1075
+ public addEKSDependency(eksCluster: Cluster): void
1076
+ ```
1077
+
1078
+ Method to add the nodes to specific Cluster.
1079
+
1080
+ ###### `eksCluster`<sup>Required</sup> <a name="eksCluster" id="cdk-skylight.compute.WindowsEKSNodes.addEKSDependency.parameter.eksCluster"></a>
1081
+
1082
+ - *Type:* aws-cdk-lib.aws_eks.Cluster
1083
+
1084
+ ---
1085
+
1086
+ ##### `addLocalCredFile` <a name="addLocalCredFile" id="cdk-skylight.compute.WindowsEKSNodes.addLocalCredFile"></a>
1087
+
1088
+ ```typescript
1089
+ public addLocalCredFile(adParametersStore: IAwsManagedMicrosoftAdParameters, ADGroupName: string, AccountName: string): void
1090
+ ```
1091
+
1092
+ Method to add support for LocalCredFile <Experimental>.
1093
+
1094
+ ###### `adParametersStore`<sup>Required</sup> <a name="adParametersStore" id="cdk-skylight.compute.WindowsEKSNodes.addLocalCredFile.parameter.adParametersStore"></a>
1095
+
1096
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1097
+
1098
+ ---
1099
+
1100
+ ###### `ADGroupName`<sup>Required</sup> <a name="ADGroupName" id="cdk-skylight.compute.WindowsEKSNodes.addLocalCredFile.parameter.ADGroupName"></a>
1101
+
1102
+ - *Type:* string
1103
+
1104
+ ---
1105
+
1106
+ ###### `AccountName`<sup>Required</sup> <a name="AccountName" id="cdk-skylight.compute.WindowsEKSNodes.addLocalCredFile.parameter.AccountName"></a>
1107
+
1108
+ - *Type:* string
1109
+
1110
+ ---
1111
+
1112
+ ##### `addStorageDependency` <a name="addStorageDependency" id="cdk-skylight.compute.WindowsEKSNodes.addStorageDependency"></a>
1113
+
1114
+ ```typescript
1115
+ public addStorageDependency(adParametersStore: IAwsManagedMicrosoftAdParameters, fsxParametersStore: IFSxWindowsParameters, folderName: string): void
1116
+ ```
1117
+
1118
+ Method to configure persistent storage dependency to the hosts by using Global Mapping.
1119
+
1120
+ ###### `adParametersStore`<sup>Required</sup> <a name="adParametersStore" id="cdk-skylight.compute.WindowsEKSNodes.addStorageDependency.parameter.adParametersStore"></a>
1121
+
1122
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1123
+
1124
+ ---
1125
+
1126
+ ###### `fsxParametersStore`<sup>Required</sup> <a name="fsxParametersStore" id="cdk-skylight.compute.WindowsEKSNodes.addStorageDependency.parameter.fsxParametersStore"></a>
1127
+
1128
+ - *Type:* cdk-skylight.storage.IFSxWindowsParameters
1129
+
1130
+ ---
1131
+
1132
+ ###### `folderName`<sup>Required</sup> <a name="folderName" id="cdk-skylight.compute.WindowsEKSNodes.addStorageDependency.parameter.folderName"></a>
1133
+
1134
+ - *Type:* string
1135
+
1136
+ ---
1137
+
1138
+ ##### `addUserData` <a name="addUserData" id="cdk-skylight.compute.WindowsEKSNodes.addUserData"></a>
1139
+
1140
+ ```typescript
1141
+ public addUserData(commands: string): void
1142
+ ```
1143
+
1144
+ Method to add userData to the nodes.
1145
+
1146
+ ###### `commands`<sup>Required</sup> <a name="commands" id="cdk-skylight.compute.WindowsEKSNodes.addUserData.parameter.commands"></a>
1147
+
1148
+ - *Type:* string
1149
+
1150
+ ---
1151
+
1152
+ ##### `gMSAWebHookAutoInstall` <a name="gMSAWebHookAutoInstall" id="cdk-skylight.compute.WindowsEKSNodes.gMSAWebHookAutoInstall"></a>
1153
+
1154
+ ```typescript
1155
+ public gMSAWebHookAutoInstall(eksCluster: Cluster, privateSignerName: string, awsaccountid: string, awsregion: string): void
1156
+ ```
1157
+
1158
+ ###### `eksCluster`<sup>Required</sup> <a name="eksCluster" id="cdk-skylight.compute.WindowsEKSNodes.gMSAWebHookAutoInstall.parameter.eksCluster"></a>
1159
+
1160
+ - *Type:* aws-cdk-lib.aws_eks.Cluster
1161
+
1162
+ ---
1163
+
1164
+ ###### `privateSignerName`<sup>Required</sup> <a name="privateSignerName" id="cdk-skylight.compute.WindowsEKSNodes.gMSAWebHookAutoInstall.parameter.privateSignerName"></a>
1165
+
1166
+ - *Type:* string
1167
+
1168
+ ---
1169
+
1170
+ ###### `awsaccountid`<sup>Required</sup> <a name="awsaccountid" id="cdk-skylight.compute.WindowsEKSNodes.gMSAWebHookAutoInstall.parameter.awsaccountid"></a>
1171
+
1172
+ - *Type:* string
1173
+
1174
+ ---
1175
+
1176
+ ###### `awsregion`<sup>Required</sup> <a name="awsregion" id="cdk-skylight.compute.WindowsEKSNodes.gMSAWebHookAutoInstall.parameter.awsregion"></a>
1177
+
1178
+ - *Type:* string
1179
+
1180
+ ---
1181
+
1182
+ ##### `runPowerShellSSMDocument` <a name="runPowerShellSSMDocument" id="cdk-skylight.compute.WindowsEKSNodes.runPowerShellSSMDocument"></a>
1183
+
1184
+ ```typescript
1185
+ public runPowerShellSSMDocument(name: string, commands: string[]): void
1186
+ ```
1187
+
1188
+ ###### `name`<sup>Required</sup> <a name="name" id="cdk-skylight.compute.WindowsEKSNodes.runPowerShellSSMDocument.parameter.name"></a>
1189
+
1190
+ - *Type:* string
1191
+
1192
+ ---
1193
+
1194
+ ###### `commands`<sup>Required</sup> <a name="commands" id="cdk-skylight.compute.WindowsEKSNodes.runPowerShellSSMDocument.parameter.commands"></a>
1195
+
1196
+ - *Type:* string[]
1197
+
1198
+ ---
1199
+
1200
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
1201
+
1202
+ | **Name** | **Description** |
1203
+ | --- | --- |
1204
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
1205
+
1206
+ ---
1207
+
1208
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-skylight.compute.WindowsEKSNodes.isConstruct"></a>
1209
+
1210
+ ```typescript
1211
+ import { compute } from 'cdk-skylight'
1212
+
1213
+ compute.WindowsEKSNodes.isConstruct(x: any)
1214
+ ```
1215
+
1216
+ Checks if `x` is a construct.
1217
+
1218
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-skylight.compute.WindowsEKSNodes.isConstruct.parameter.x"></a>
1219
+
1220
+ - *Type:* any
1221
+
1222
+ Any object.
1223
+
1224
+ ---
1225
+
1226
+ #### Properties <a name="Properties" id="Properties"></a>
1227
+
1228
+ | **Name** | **Type** | **Description** |
1229
+ | --- | --- | --- |
1230
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1231
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.property.asg">asg</a></code> | <code>aws-cdk-lib.aws_autoscaling.AutoScalingGroup</code> | *No description.* |
1232
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.property.asgResource">asgResource</a></code> | <code>aws-cdk-lib.aws_autoscaling.CfnAutoScalingGroup</code> | *No description.* |
1233
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.property.nodesSg">nodesSg</a></code> | <code>aws-cdk-lib.aws_ec2.SecurityGroup</code> | *No description.* |
1234
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
1235
+ | <code><a href="#cdk-skylight.compute.WindowsEKSNodes.property.windowsWorkersRole">windowsWorkersRole</a></code> | <code>aws-cdk-lib.aws_iam.Role</code> | *No description.* |
1236
+
1237
+ ---
1238
+
1239
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-skylight.compute.WindowsEKSNodes.property.node"></a>
1240
+
1241
+ ```typescript
1242
+ public readonly node: Node;
1243
+ ```
1244
+
1245
+ - *Type:* constructs.Node
1246
+
1247
+ The tree node.
1248
+
1249
+ ---
1250
+
1251
+ ##### `asg`<sup>Required</sup> <a name="asg" id="cdk-skylight.compute.WindowsEKSNodes.property.asg"></a>
1252
+
1253
+ ```typescript
1254
+ public readonly asg: AutoScalingGroup;
1255
+ ```
1256
+
1257
+ - *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroup
1258
+
1259
+ ---
1260
+
1261
+ ##### `asgResource`<sup>Required</sup> <a name="asgResource" id="cdk-skylight.compute.WindowsEKSNodes.property.asgResource"></a>
1262
+
1263
+ ```typescript
1264
+ public readonly asgResource: CfnAutoScalingGroup;
1265
+ ```
1266
+
1267
+ - *Type:* aws-cdk-lib.aws_autoscaling.CfnAutoScalingGroup
1268
+
1269
+ ---
1270
+
1271
+ ##### `nodesSg`<sup>Required</sup> <a name="nodesSg" id="cdk-skylight.compute.WindowsEKSNodes.property.nodesSg"></a>
1272
+
1273
+ ```typescript
1274
+ public readonly nodesSg: SecurityGroup;
1275
+ ```
1276
+
1277
+ - *Type:* aws-cdk-lib.aws_ec2.SecurityGroup
1278
+
1279
+ ---
1280
+
1281
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.compute.WindowsEKSNodes.property.vpc"></a>
1282
+
1283
+ ```typescript
1284
+ public readonly vpc: IVpc;
1285
+ ```
1286
+
1287
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
1288
+
1289
+ ---
1290
+
1291
+ ##### `windowsWorkersRole`<sup>Required</sup> <a name="windowsWorkersRole" id="cdk-skylight.compute.WindowsEKSNodes.property.windowsWorkersRole"></a>
1292
+
1293
+ ```typescript
1294
+ public readonly windowsWorkersRole: Role;
1295
+ ```
1296
+
1297
+ - *Type:* aws-cdk-lib.aws_iam.Role
1298
+
1299
+ ---
1300
+
1301
+
1302
+
1303
+
1304
+ ## Protocols <a name="Protocols" id="Protocols"></a>
1305
+
1306
+ ### IAwsManagedMicrosoftAdParameters <a name="IAwsManagedMicrosoftAdParameters" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters"></a>
1307
+
1308
+ - *Implemented By:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1309
+
1310
+ The properties of an DomainWindowsNodeProps, requires Active Directory parameter to read the Secret to join the domain Default setting: Domain joined, m5.2xlarge, latest windows, Managed by SSM.
1311
+
1312
+
1313
+ #### Properties <a name="Properties" id="Properties"></a>
1314
+
1315
+ | **Name** | **Type** | **Description** |
1316
+ | --- | --- | --- |
1317
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.configurationStoreType">configurationStoreType</a></code> | <code>cdk-skylight.authentication.AwsManagedMicrosoftConfigurationStoreType</code> | The name of the Configuration Store Type to use. |
1318
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.directoryIDPointer">directoryIDPointer</a></code> | <code>string</code> | The name of the SSM Object that contains the Directory ID. |
1319
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.namespace">namespace</a></code> | <code>string</code> | The SSM namespace to read/write parameters to. |
1320
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.secretPointer">secretPointer</a></code> | <code>string</code> | The name of the SSM Object that contains the secret name in Secrets Manager. |
1321
+
1322
+ ---
1323
+
1324
+ ##### `configurationStoreType`<sup>Optional</sup> <a name="configurationStoreType" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.configurationStoreType"></a>
1325
+
1326
+ ```typescript
1327
+ public readonly configurationStoreType: AwsManagedMicrosoftConfigurationStoreType;
1328
+ ```
1329
+
1330
+ - *Type:* cdk-skylight.authentication.AwsManagedMicrosoftConfigurationStoreType
1331
+ - *Default:* 'AWS Systems Manager Parameter Store'.
1332
+
1333
+ The name of the Configuration Store Type to use.
1334
+
1335
+ ---
1336
+
1337
+ ##### `directoryIDPointer`<sup>Optional</sup> <a name="directoryIDPointer" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.directoryIDPointer"></a>
1338
+
1339
+ ```typescript
1340
+ public readonly directoryIDPointer: string;
1341
+ ```
1342
+
1343
+ - *Type:* string
1344
+ - *Default:* 'directoryID'.
1345
+
1346
+ The name of the SSM Object that contains the Directory ID.
1347
+
1348
+ ---
1349
+
1350
+ ##### `namespace`<sup>Optional</sup> <a name="namespace" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.namespace"></a>
1351
+
1352
+ ```typescript
1353
+ public readonly namespace: string;
1354
+ ```
1355
+
1356
+ - *Type:* string
1357
+ - *Default:* 'cdk-skylight'.
1358
+
1359
+ The SSM namespace to read/write parameters to.
1360
+
1361
+ ---
1362
+
1363
+ ##### `secretPointer`<sup>Optional</sup> <a name="secretPointer" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters.property.secretPointer"></a>
1364
+
1365
+ ```typescript
1366
+ public readonly secretPointer: string;
1367
+ ```
1368
+
1369
+ - *Type:* string
1370
+ - *Default:* 'domain-secret'.
1371
+
1372
+ The name of the SSM Object that contains the secret name in Secrets Manager.
1373
+
1374
+ ---
1375
+
1376
+ ### IAwsManagedMicrosoftAdProps <a name="IAwsManagedMicrosoftAdProps" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps"></a>
1377
+
1378
+ - *Implemented By:* cdk-skylight.authentication.IAwsManagedMicrosoftAdProps
1379
+
1380
+ The properties for the AwsManagedMicrosoftAd class.
1381
+
1382
+
1383
+ #### Properties <a name="Properties" id="Properties"></a>
1384
+
1385
+ | **Name** | **Type** | **Description** |
1386
+ | --- | --- | --- |
1387
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC to use, must have private subnets. |
1388
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.configurationStore">configurationStore</a></code> | <code>cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters</code> | The configuration store to save the directory parameters (After deployed). |
1389
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.createWorker">createWorker</a></code> | <code>boolean</code> | Create Domain joined machine to be used to run Powershell commands to that directory. |
1390
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.domainName">domainName</a></code> | <code>string</code> | The domain name for the Active Directory Domain. |
1391
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.edition">edition</a></code> | <code>string</code> | The edition to use for the Active Directory Domain. |
1392
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.secret">secret</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | The secrets manager secret to use must be in format: '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}'. |
1393
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.secretName">secretName</a></code> | <code>string</code> | The secret name to save the Domain Admin object. |
1394
+ | <code><a href="#cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.vpcSubnets">vpcSubnets</a></code> | <code>aws-cdk-lib.aws_ec2.SelectedSubnets</code> | VPC subnet selection, subnets must be private and exactly 2. |
1395
+
1396
+ ---
1397
+
1398
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.vpc"></a>
1399
+
1400
+ ```typescript
1401
+ public readonly vpc: IVpc;
1402
+ ```
1403
+
1404
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
1405
+
1406
+ The VPC to use, must have private subnets.
1407
+
1408
+ ---
1409
+
1410
+ ##### `configurationStore`<sup>Optional</sup> <a name="configurationStore" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.configurationStore"></a>
1411
+
1412
+ ```typescript
1413
+ public readonly configurationStore: IAwsManagedMicrosoftAdParameters;
1414
+ ```
1415
+
1416
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1417
+
1418
+ The configuration store to save the directory parameters (After deployed).
1419
+
1420
+ ---
1421
+
1422
+ ##### `createWorker`<sup>Optional</sup> <a name="createWorker" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.createWorker"></a>
1423
+
1424
+ ```typescript
1425
+ public readonly createWorker: boolean;
1426
+ ```
1427
+
1428
+ - *Type:* boolean
1429
+ - *Default:* 'true'.
1430
+
1431
+ Create Domain joined machine to be used to run Powershell commands to that directory.
1432
+
1433
+ (i.e Create Ad Group)
1434
+
1435
+ ---
1436
+
1437
+ ##### `domainName`<sup>Optional</sup> <a name="domainName" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.domainName"></a>
1438
+
1439
+ ```typescript
1440
+ public readonly domainName: string;
1441
+ ```
1442
+
1443
+ - *Type:* string
1444
+ - *Default:* 'domain.aws'.
1445
+
1446
+ The domain name for the Active Directory Domain.
1447
+
1448
+ ---
1449
+
1450
+ ##### `edition`<sup>Optional</sup> <a name="edition" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.edition"></a>
1451
+
1452
+ ```typescript
1453
+ public readonly edition: string;
1454
+ ```
1455
+
1456
+ - *Type:* string
1457
+ - *Default:* 'Standard'.
1458
+
1459
+ The edition to use for the Active Directory Domain.
1460
+
1461
+ Allowed values: Enterprise | Standard
1462
+ https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition
1463
+
1464
+ ---
1465
+
1466
+ ##### `secret`<sup>Optional</sup> <a name="secret" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.secret"></a>
1467
+
1468
+ ```typescript
1469
+ public readonly secret: ISecret;
1470
+ ```
1471
+
1472
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
1473
+ - *Default:* 'Randomly generated and stored in Secret Manager'.
1474
+
1475
+ The secrets manager secret to use must be in format: '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}'.
1476
+
1477
+ ---
1478
+
1479
+ ##### `secretName`<sup>Optional</sup> <a name="secretName" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.secretName"></a>
1480
+
1481
+ ```typescript
1482
+ public readonly secretName: string;
1483
+ ```
1484
+
1485
+ - *Type:* string
1486
+ - *Default:* '<domain.name>-secret'.
1487
+
1488
+ The secret name to save the Domain Admin object.
1489
+
1490
+ ---
1491
+
1492
+ ##### `vpcSubnets`<sup>Optional</sup> <a name="vpcSubnets" id="cdk-skylight.authentication.IAwsManagedMicrosoftAdProps.property.vpcSubnets"></a>
1493
+
1494
+ ```typescript
1495
+ public readonly vpcSubnets: SelectedSubnets;
1496
+ ```
1497
+
1498
+ - *Type:* aws-cdk-lib.aws_ec2.SelectedSubnets
1499
+
1500
+ VPC subnet selection, subnets must be private and exactly 2.
1501
+
1502
+ ---
1503
+
1504
+ ### IDomainWindowsNodeProps <a name="IDomainWindowsNodeProps" id="cdk-skylight.compute.IDomainWindowsNodeProps"></a>
1505
+
1506
+ - *Implemented By:* cdk-skylight.compute.IDomainWindowsNodeProps
1507
+
1508
+ The properties of an DomainWindowsNodeProps, requires Active Directory parameter to read the Secret to join the domain Default setting: Domain joined, m5.2xlarge, latest windows, Managed by SSM.
1509
+
1510
+
1511
+ #### Properties <a name="Properties" id="Properties"></a>
1512
+
1513
+ | **Name** | **Type** | **Description** |
1514
+ | --- | --- | --- |
1515
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC to use. |
1516
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.amiName">amiName</a></code> | <code>string</code> | The name of the AMI to search in SSM (ec2.LookupNodeImage) supports Regex. |
1517
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
1518
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.iamManagedPoliciesList">iamManagedPoliciesList</a></code> | <code>aws-cdk-lib.aws_iam.IManagedPolicy[]</code> | IAM Instance role permissions. |
1519
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.instanceType">instanceType</a></code> | <code>string</code> | The EC2 Instance type to use. |
1520
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.passwordObject">passwordObject</a></code> | <code>aws-cdk-lib.aws_secretsmanager.ISecret</code> | *No description.* |
1521
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.usePrivateSubnet">usePrivateSubnet</a></code> | <code>boolean</code> | Choose if to launch the instance in Private or in Public subnet Private = Subnet that routes to the internet, but not vice versa. |
1522
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.userData">userData</a></code> | <code>string</code> | Specific UserData to use. |
1523
+ | <code><a href="#cdk-skylight.compute.IDomainWindowsNodeProps.property.windowsMachine">windowsMachine</a></code> | <code>boolean</code> | *No description.* |
1524
+
1525
+ ---
1526
+
1527
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.vpc"></a>
1528
+
1529
+ ```typescript
1530
+ public readonly vpc: IVpc;
1531
+ ```
1532
+
1533
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
1534
+
1535
+ The VPC to use.
1536
+
1537
+ ---
1538
+
1539
+ ##### `amiName`<sup>Optional</sup> <a name="amiName" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.amiName"></a>
1540
+
1541
+ ```typescript
1542
+ public readonly amiName: string;
1543
+ ```
1544
+
1545
+ - *Type:* string
1546
+ - *Default:* 'Windows_Server-2022-English-Full'
1547
+
1548
+ The name of the AMI to search in SSM (ec2.LookupNodeImage) supports Regex.
1549
+
1550
+ ---
1551
+
1552
+ ##### `domainName`<sup>Optional</sup> <a name="domainName" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.domainName"></a>
1553
+
1554
+ ```typescript
1555
+ public readonly domainName: string;
1556
+ ```
1557
+
1558
+ - *Type:* string
1559
+
1560
+ ---
1561
+
1562
+ ##### `iamManagedPoliciesList`<sup>Optional</sup> <a name="iamManagedPoliciesList" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.iamManagedPoliciesList"></a>
1563
+
1564
+ ```typescript
1565
+ public readonly iamManagedPoliciesList: IManagedPolicy[];
1566
+ ```
1567
+
1568
+ - *Type:* aws-cdk-lib.aws_iam.IManagedPolicy[]
1569
+ - *Default:* 'AmazonSSMManagedInstanceCore, AmazonSSMDirectoryServiceAccess'.
1570
+
1571
+ IAM Instance role permissions.
1572
+
1573
+ ---
1574
+
1575
+ ##### `instanceType`<sup>Optional</sup> <a name="instanceType" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.instanceType"></a>
1576
+
1577
+ ```typescript
1578
+ public readonly instanceType: string;
1579
+ ```
1580
+
1581
+ - *Type:* string
1582
+ - *Default:* 'm5.2xlarge'.
1583
+
1584
+ The EC2 Instance type to use.
1585
+
1586
+ ---
1587
+
1588
+ ##### `passwordObject`<sup>Optional</sup> <a name="passwordObject" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.passwordObject"></a>
1589
+
1590
+ ```typescript
1591
+ public readonly passwordObject: ISecret;
1592
+ ```
1593
+
1594
+ - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
1595
+
1596
+ ---
1597
+
1598
+ ##### `usePrivateSubnet`<sup>Optional</sup> <a name="usePrivateSubnet" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.usePrivateSubnet"></a>
1599
+
1600
+ ```typescript
1601
+ public readonly usePrivateSubnet: boolean;
1602
+ ```
1603
+
1604
+ - *Type:* boolean
1605
+ - *Default:* Private.
1606
+
1607
+ Choose if to launch the instance in Private or in Public subnet Private = Subnet that routes to the internet, but not vice versa.
1608
+
1609
+ Public = Subnet that routes to the internet and vice versa.
1610
+
1611
+ ---
1612
+
1613
+ ##### `userData`<sup>Optional</sup> <a name="userData" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.userData"></a>
1614
+
1615
+ ```typescript
1616
+ public readonly userData: string;
1617
+ ```
1618
+
1619
+ - *Type:* string
1620
+ - *Default:* 'undefined'
1621
+
1622
+ Specific UserData to use.
1623
+
1624
+ The UserData may still be mutated after creation.
1625
+
1626
+ ---
1627
+
1628
+ ##### `windowsMachine`<sup>Optional</sup> <a name="windowsMachine" id="cdk-skylight.compute.IDomainWindowsNodeProps.property.windowsMachine"></a>
1629
+
1630
+ ```typescript
1631
+ public readonly windowsMachine: boolean;
1632
+ ```
1633
+
1634
+ - *Type:* boolean
1635
+ - *Default:* 'true'
1636
+
1637
+ ---
1638
+
1639
+ ### IFSxWindowsParameters <a name="IFSxWindowsParameters" id="cdk-skylight.storage.IFSxWindowsParameters"></a>
1640
+
1641
+ - *Implemented By:* cdk-skylight.storage.IFSxWindowsParameters
1642
+
1643
+
1644
+ #### Properties <a name="Properties" id="Properties"></a>
1645
+
1646
+ | **Name** | **Type** | **Description** |
1647
+ | --- | --- | --- |
1648
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsParameters.property.dnsEndpoint">dnsEndpoint</a></code> | <code>string</code> | The name of the parameter to save the FSxEndpoint DNS Endpoint. |
1649
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsParameters.property.namespace">namespace</a></code> | <code>string</code> | The SSM namespace to read/write parameters to. |
1650
+
1651
+ ---
1652
+
1653
+ ##### `dnsEndpoint`<sup>Optional</sup> <a name="dnsEndpoint" id="cdk-skylight.storage.IFSxWindowsParameters.property.dnsEndpoint"></a>
1654
+
1655
+ ```typescript
1656
+ public readonly dnsEndpoint: string;
1657
+ ```
1658
+
1659
+ - *Type:* string
1660
+ - *Default:* 'FSxEndpoint-DNS'.
1661
+
1662
+ The name of the parameter to save the FSxEndpoint DNS Endpoint.
1663
+
1664
+ ---
1665
+
1666
+ ##### `namespace`<sup>Optional</sup> <a name="namespace" id="cdk-skylight.storage.IFSxWindowsParameters.property.namespace"></a>
1667
+
1668
+ ```typescript
1669
+ public readonly namespace: string;
1670
+ ```
1671
+
1672
+ - *Type:* string
1673
+ - *Default:* 'cdk-skylight'.
1674
+
1675
+ The SSM namespace to read/write parameters to.
1676
+
1677
+ ---
1678
+
1679
+ ### IFSxWindowsProps <a name="IFSxWindowsProps" id="cdk-skylight.storage.IFSxWindowsProps"></a>
1680
+
1681
+ - *Implemented By:* cdk-skylight.storage.IFSxWindowsProps
1682
+
1683
+ The properties for the PersistentStorage class.
1684
+
1685
+
1686
+ #### Properties <a name="Properties" id="Properties"></a>
1687
+
1688
+ | **Name** | **Type** | **Description** |
1689
+ | --- | --- | --- |
1690
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.directoryId">directoryId</a></code> | <code>string</code> | *No description.* |
1691
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | The VPC to use, must have private subnets. |
1692
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.fileSystemInPrivateSubnet">fileSystemInPrivateSubnet</a></code> | <code>boolean</code> | Deploy the Amazon FSx file system in private subnet or public subnet See: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html. |
1693
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.fileSystemSize">fileSystemSize</a></code> | <code>number</code> | The Filesystem size in GB. |
1694
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.multiAZ">multiAZ</a></code> | <code>boolean</code> | Choosing Single-AZ or Multi-AZ file system deployment See: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html. |
1695
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.ssmParameters">ssmParameters</a></code> | <code>cdk-skylight.storage.IFSxWindowsParameters</code> | *No description.* |
1696
+ | <code><a href="#cdk-skylight.storage.IFSxWindowsProps.property.throughputMbps">throughputMbps</a></code> | <code>number</code> | The Filesystem throughput in MBps. |
1697
+
1698
+ ---
1699
+
1700
+ ##### `directoryId`<sup>Required</sup> <a name="directoryId" id="cdk-skylight.storage.IFSxWindowsProps.property.directoryId"></a>
1701
+
1702
+ ```typescript
1703
+ public readonly directoryId: string;
1704
+ ```
1705
+
1706
+ - *Type:* string
1707
+
1708
+ ---
1709
+
1710
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.storage.IFSxWindowsProps.property.vpc"></a>
1711
+
1712
+ ```typescript
1713
+ public readonly vpc: IVpc;
1714
+ ```
1715
+
1716
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
1717
+
1718
+ The VPC to use, must have private subnets.
1719
+
1720
+ ---
1721
+
1722
+ ##### `fileSystemInPrivateSubnet`<sup>Optional</sup> <a name="fileSystemInPrivateSubnet" id="cdk-skylight.storage.IFSxWindowsProps.property.fileSystemInPrivateSubnet"></a>
1723
+
1724
+ ```typescript
1725
+ public readonly fileSystemInPrivateSubnet: boolean;
1726
+ ```
1727
+
1728
+ - *Type:* boolean
1729
+ - *Default:* true.
1730
+
1731
+ Deploy the Amazon FSx file system in private subnet or public subnet See: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html.
1732
+
1733
+ ---
1734
+
1735
+ ##### `fileSystemSize`<sup>Optional</sup> <a name="fileSystemSize" id="cdk-skylight.storage.IFSxWindowsProps.property.fileSystemSize"></a>
1736
+
1737
+ ```typescript
1738
+ public readonly fileSystemSize: number;
1739
+ ```
1740
+
1741
+ - *Type:* number
1742
+ - *Default:* 200.
1743
+
1744
+ The Filesystem size in GB.
1745
+
1746
+ ---
1747
+
1748
+ ##### `multiAZ`<sup>Optional</sup> <a name="multiAZ" id="cdk-skylight.storage.IFSxWindowsProps.property.multiAZ"></a>
1749
+
1750
+ ```typescript
1751
+ public readonly multiAZ: boolean;
1752
+ ```
1753
+
1754
+ - *Type:* boolean
1755
+ - *Default:* true.
1756
+
1757
+ Choosing Single-AZ or Multi-AZ file system deployment See: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html.
1758
+
1759
+ ---
1760
+
1761
+ ##### `ssmParameters`<sup>Optional</sup> <a name="ssmParameters" id="cdk-skylight.storage.IFSxWindowsProps.property.ssmParameters"></a>
1762
+
1763
+ ```typescript
1764
+ public readonly ssmParameters: IFSxWindowsParameters;
1765
+ ```
1766
+
1767
+ - *Type:* cdk-skylight.storage.IFSxWindowsParameters
1768
+
1769
+ ---
1770
+
1771
+ ##### `throughputMbps`<sup>Optional</sup> <a name="throughputMbps" id="cdk-skylight.storage.IFSxWindowsProps.property.throughputMbps"></a>
1772
+
1773
+ ```typescript
1774
+ public readonly throughputMbps: number;
1775
+ ```
1776
+
1777
+ - *Type:* number
1778
+ - *Default:* 128.
1779
+
1780
+ The Filesystem throughput in MBps.
1781
+
1782
+ ---
1783
+
1784
+ ### IRuntimeNodes <a name="IRuntimeNodes" id="cdk-skylight.compute.IRuntimeNodes"></a>
1785
+
1786
+ - *Implemented By:* cdk-skylight.compute.WindowsEKSNodes, cdk-skylight.compute.IRuntimeNodes
1787
+
1788
+ #### Methods <a name="Methods" id="Methods"></a>
1789
+
1790
+ | **Name** | **Description** |
1791
+ | --- | --- |
1792
+ | <code><a href="#cdk-skylight.compute.IRuntimeNodes.addAdDependency">addAdDependency</a></code> | Method to configure the Nodes to part of AD Domain Secret: The secrets manager secret to use must be in format: '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}' (From cdk-skylight.AwsManagedMicrosoftAdR53 Object). |
1793
+ | <code><a href="#cdk-skylight.compute.IRuntimeNodes.addEKSDependency">addEKSDependency</a></code> | Method to add the nodes to specific Cluster. |
1794
+ | <code><a href="#cdk-skylight.compute.IRuntimeNodes.addLocalCredFile">addLocalCredFile</a></code> | Method to add support for LocalCredFile <Experimental>. |
1795
+ | <code><a href="#cdk-skylight.compute.IRuntimeNodes.addStorageDependency">addStorageDependency</a></code> | Method to configure persistent storage dependency to the hosts by using Global Mapping. |
1796
+ | <code><a href="#cdk-skylight.compute.IRuntimeNodes.addUserData">addUserData</a></code> | Method to add userData to the nodes. |
1797
+
1798
+ ---
1799
+
1800
+ ##### `addAdDependency` <a name="addAdDependency" id="cdk-skylight.compute.IRuntimeNodes.addAdDependency"></a>
1801
+
1802
+ ```typescript
1803
+ public addAdDependency(adParametersStore: IAwsManagedMicrosoftAdParameters): void
1804
+ ```
1805
+
1806
+ Method to configure the Nodes to part of AD Domain Secret: The secrets manager secret to use must be in format: '{Domain: <domain.name>, UserID: 'Admin', Password: '<password>'}' (From cdk-skylight.AwsManagedMicrosoftAdR53 Object).
1807
+
1808
+ ###### `adParametersStore`<sup>Required</sup> <a name="adParametersStore" id="cdk-skylight.compute.IRuntimeNodes.addAdDependency.parameter.adParametersStore"></a>
1809
+
1810
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1811
+
1812
+ ---
1813
+
1814
+ ##### `addEKSDependency` <a name="addEKSDependency" id="cdk-skylight.compute.IRuntimeNodes.addEKSDependency"></a>
1815
+
1816
+ ```typescript
1817
+ public addEKSDependency(eksCluster: Cluster): void
1818
+ ```
1819
+
1820
+ Method to add the nodes to specific Cluster.
1821
+
1822
+ ###### `eksCluster`<sup>Required</sup> <a name="eksCluster" id="cdk-skylight.compute.IRuntimeNodes.addEKSDependency.parameter.eksCluster"></a>
1823
+
1824
+ - *Type:* aws-cdk-lib.aws_eks.Cluster
1825
+
1826
+ ---
1827
+
1828
+ ##### `addLocalCredFile` <a name="addLocalCredFile" id="cdk-skylight.compute.IRuntimeNodes.addLocalCredFile"></a>
1829
+
1830
+ ```typescript
1831
+ public addLocalCredFile(adParametersStore: IAwsManagedMicrosoftAdParameters, ADGroupName: string, AccountName: string): void
1832
+ ```
1833
+
1834
+ Method to add support for LocalCredFile <Experimental>.
1835
+
1836
+ ###### `adParametersStore`<sup>Required</sup> <a name="adParametersStore" id="cdk-skylight.compute.IRuntimeNodes.addLocalCredFile.parameter.adParametersStore"></a>
1837
+
1838
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1839
+
1840
+ ---
1841
+
1842
+ ###### `ADGroupName`<sup>Required</sup> <a name="ADGroupName" id="cdk-skylight.compute.IRuntimeNodes.addLocalCredFile.parameter.ADGroupName"></a>
1843
+
1844
+ - *Type:* string
1845
+
1846
+ ---
1847
+
1848
+ ###### `AccountName`<sup>Required</sup> <a name="AccountName" id="cdk-skylight.compute.IRuntimeNodes.addLocalCredFile.parameter.AccountName"></a>
1849
+
1850
+ - *Type:* string
1851
+
1852
+ ---
1853
+
1854
+ ##### `addStorageDependency` <a name="addStorageDependency" id="cdk-skylight.compute.IRuntimeNodes.addStorageDependency"></a>
1855
+
1856
+ ```typescript
1857
+ public addStorageDependency(adParametersStore: IAwsManagedMicrosoftAdParameters, fsxParametersStore: IFSxWindowsParameters, folderName: string): void
1858
+ ```
1859
+
1860
+ Method to configure persistent storage dependency to the hosts by using Global Mapping.
1861
+
1862
+ ###### `adParametersStore`<sup>Required</sup> <a name="adParametersStore" id="cdk-skylight.compute.IRuntimeNodes.addStorageDependency.parameter.adParametersStore"></a>
1863
+
1864
+ - *Type:* cdk-skylight.authentication.IAwsManagedMicrosoftAdParameters
1865
+
1866
+ ---
1867
+
1868
+ ###### `fsxParametersStore`<sup>Required</sup> <a name="fsxParametersStore" id="cdk-skylight.compute.IRuntimeNodes.addStorageDependency.parameter.fsxParametersStore"></a>
1869
+
1870
+ - *Type:* cdk-skylight.storage.IFSxWindowsParameters
1871
+
1872
+ ---
1873
+
1874
+ ###### `folderName`<sup>Required</sup> <a name="folderName" id="cdk-skylight.compute.IRuntimeNodes.addStorageDependency.parameter.folderName"></a>
1875
+
1876
+ - *Type:* string
1877
+
1878
+ ---
1879
+
1880
+ ##### `addUserData` <a name="addUserData" id="cdk-skylight.compute.IRuntimeNodes.addUserData"></a>
1881
+
1882
+ ```typescript
1883
+ public addUserData(commands: string): void
1884
+ ```
1885
+
1886
+ Method to add userData to the nodes.
1887
+
1888
+ ###### `commands`<sup>Required</sup> <a name="commands" id="cdk-skylight.compute.IRuntimeNodes.addUserData.parameter.commands"></a>
1889
+
1890
+ - *Type:* string
1891
+
1892
+ ---
1893
+
1894
+
1895
+ ### IWindowsEKSClusterParameters <a name="IWindowsEKSClusterParameters" id="cdk-skylight.compute.IWindowsEKSClusterParameters"></a>
1896
+
1897
+ - *Implemented By:* cdk-skylight.compute.IWindowsEKSClusterParameters
1898
+
1899
+
1900
+ #### Properties <a name="Properties" id="Properties"></a>
1901
+
1902
+ | **Name** | **Type** | **Description** |
1903
+ | --- | --- | --- |
1904
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSClusterParameters.property.clusterNamePointer">clusterNamePointer</a></code> | <code>string</code> | The name of the SSM Object that contains the EKS Cluster name. |
1905
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSClusterParameters.property.namespace">namespace</a></code> | <code>string</code> | The SSM namespace to read/write parameters to. |
1906
+
1907
+ ---
1908
+
1909
+ ##### `clusterNamePointer`<sup>Optional</sup> <a name="clusterNamePointer" id="cdk-skylight.compute.IWindowsEKSClusterParameters.property.clusterNamePointer"></a>
1910
+
1911
+ ```typescript
1912
+ public readonly clusterNamePointer: string;
1913
+ ```
1914
+
1915
+ - *Type:* string
1916
+ - *Default:* 'windows-eks-cluster-name'.
1917
+
1918
+ The name of the SSM Object that contains the EKS Cluster name.
1919
+
1920
+ ---
1921
+
1922
+ ##### `namespace`<sup>Optional</sup> <a name="namespace" id="cdk-skylight.compute.IWindowsEKSClusterParameters.property.namespace"></a>
1923
+
1924
+ ```typescript
1925
+ public readonly namespace: string;
1926
+ ```
1927
+
1928
+ - *Type:* string
1929
+ - *Default:* 'cdk-skylight/compute/eks'.
1930
+
1931
+ The SSM namespace to read/write parameters to.
1932
+
1933
+ ---
1934
+
1935
+ ### IWindowsEKSClusterProps <a name="IWindowsEKSClusterProps" id="cdk-skylight.compute.IWindowsEKSClusterProps"></a>
1936
+
1937
+ - *Implemented By:* cdk-skylight.compute.IWindowsEKSClusterProps
1938
+
1939
+
1940
+ #### Properties <a name="Properties" id="Properties"></a>
1941
+
1942
+ | **Name** | **Type** | **Description** |
1943
+ | --- | --- | --- |
1944
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSClusterProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
1945
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSClusterProps.property.eksSsmParameters">eksSsmParameters</a></code> | <code>cdk-skylight.compute.IWindowsEKSClusterParameters</code> | The Windows EKS Cluster parameters. |
1946
+
1947
+ ---
1948
+
1949
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.compute.IWindowsEKSClusterProps.property.vpc"></a>
1950
+
1951
+ ```typescript
1952
+ public readonly vpc: IVpc;
1953
+ ```
1954
+
1955
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
1956
+
1957
+ ---
1958
+
1959
+ ##### `eksSsmParameters`<sup>Optional</sup> <a name="eksSsmParameters" id="cdk-skylight.compute.IWindowsEKSClusterProps.property.eksSsmParameters"></a>
1960
+
1961
+ ```typescript
1962
+ public readonly eksSsmParameters: IWindowsEKSClusterParameters;
1963
+ ```
1964
+
1965
+ - *Type:* cdk-skylight.compute.IWindowsEKSClusterParameters
1966
+ - *Default:* 'No default'.
1967
+
1968
+ The Windows EKS Cluster parameters.
1969
+
1970
+ ---
1971
+
1972
+ ### IWindowsEKSNodesProps <a name="IWindowsEKSNodesProps" id="cdk-skylight.compute.IWindowsEKSNodesProps"></a>
1973
+
1974
+ - *Implemented By:* cdk-skylight.compute.IWindowsEKSNodesProps
1975
+
1976
+
1977
+ #### Properties <a name="Properties" id="Properties"></a>
1978
+
1979
+ | **Name** | **Type** | **Description** |
1980
+ | --- | --- | --- |
1981
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSNodesProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | *No description.* |
1982
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSNodesProps.property.instanceType">instanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | The instance to use. |
1983
+ | <code><a href="#cdk-skylight.compute.IWindowsEKSNodesProps.property.namespace">namespace</a></code> | <code>string</code> | The SSM namespace to save parameters to. |
1984
+
1985
+ ---
1986
+
1987
+ ##### `vpc`<sup>Required</sup> <a name="vpc" id="cdk-skylight.compute.IWindowsEKSNodesProps.property.vpc"></a>
1988
+
1989
+ ```typescript
1990
+ public readonly vpc: IVpc;
1991
+ ```
1992
+
1993
+ - *Type:* aws-cdk-lib.aws_ec2.IVpc
1994
+
1995
+ ---
1996
+
1997
+ ##### `instanceType`<sup>Optional</sup> <a name="instanceType" id="cdk-skylight.compute.IWindowsEKSNodesProps.property.instanceType"></a>
1998
+
1999
+ ```typescript
2000
+ public readonly instanceType: InstanceType;
2001
+ ```
2002
+
2003
+ - *Type:* aws-cdk-lib.aws_ec2.InstanceType
2004
+ - *Default:* 'm5.large'.
2005
+
2006
+ The instance to use.
2007
+
2008
+ ---
2009
+
2010
+ ##### `namespace`<sup>Optional</sup> <a name="namespace" id="cdk-skylight.compute.IWindowsEKSNodesProps.property.namespace"></a>
2011
+
2012
+ ```typescript
2013
+ public readonly namespace: string;
2014
+ ```
2015
+
2016
+ - *Type:* string
2017
+ - *Default:* 'cdk-skylight'.
2018
+
2019
+ The SSM namespace to save parameters to.
2020
+
2021
+ ---
2022
+
2023
+ ## Enums <a name="Enums" id="Enums"></a>
2024
+
2025
+ ### AwsManagedMicrosoftConfigurationStoreType <a name="AwsManagedMicrosoftConfigurationStoreType" id="cdk-skylight.authentication.AwsManagedMicrosoftConfigurationStoreType"></a>
2026
+
2027
+ #### Members <a name="Members" id="Members"></a>
2028
+
2029
+ | **Name** | **Description** |
2030
+ | --- | --- |
2031
+ | <code><a href="#cdk-skylight.authentication.AwsManagedMicrosoftConfigurationStoreType.SSM">SSM</a></code> | *No description.* |
2032
+
2033
+ ---
2034
+
2035
+ ##### `SSM` <a name="SSM" id="cdk-skylight.authentication.AwsManagedMicrosoftConfigurationStoreType.SSM"></a>
2036
+
2037
+ ---
2038
+