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