@aws-mdaa/datawarehouse 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +191 -0
  2. package/SCHEMA.md +1263 -0
  3. package/bin/datawarehouse.d.ts +6 -0
  4. package/bin/datawarehouse.js +10 -0
  5. package/cdk.json +7 -0
  6. package/lib/config-schema.json +584 -0
  7. package/lib/datawarehouse-config.d.ts +329 -0
  8. package/lib/datawarehouse-config.js +50 -0
  9. package/lib/datawarehouse.d.ts +11 -0
  10. package/lib/datawarehouse.js +28 -0
  11. package/mdaa.config.json +3 -0
  12. package/package.json +55 -0
package/SCHEMA.md ADDED
@@ -0,0 +1,1263 @@
1
+ # Schema Docs
2
+
3
+ | | |
4
+ | ------------------------- | ------------------------------------------------------- |
5
+ | **Type** | `object` |
6
+ | **Required** | No |
7
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
8
+
9
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
10
+ | -------------------------------------------------------------------- | ------- | --------------- | ---------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | - [additionalBucketKmsKeyArns](#additionalBucketKmsKeyArns ) | No | array of string | No | - | Additional KMS keys which can be used to write to the cluster bucket |
12
+ | + [adminPasswordRotationDays](#adminPasswordRotationDays ) | No | number | No | - | Set the number of days between admin password rotations |
13
+ | + [adminUsername](#adminUsername ) | No | string | No | - | Set the admin user name for the cluster |
14
+ | - [automatedSnapshotRetentionDays](#automatedSnapshotRetentionDays ) | No | number | No | - | Number of days that automated snapshots are retained |
15
+ | - [clusterPort](#clusterPort ) | No | number | No | - | The cluster port (default: 54390) |
16
+ | - [createWarehouseBucket](#createWarehouseBucket ) | No | boolean | No | - | If true(default), a Data Warehouse bucket will be created |
17
+ | + [dataAdminRoles](#dataAdminRoles ) | No | array | No | - | List of admin roles which will be provided access to cluster resources (like KMS/Bucket) |
18
+ | - [databaseUsers](#databaseUsers ) | No | array | No | - | List of Users to be created in Redshift Database, then stored & rotated in secrets manager -> ssm |
19
+ | + [enableAuditLoggingToS3](#enableAuditLoggingToS3 ) | No | boolean | No | - | If enabled, cluster audit logging will be written to an S3 bucket created for this purpose.<br />Note that Redshift supports audit logging only to SSE-S3 encrypted buckets, so this audit bucket<br />will not be created with SSE-KMS or use a customer master key. |
20
+ | - [eventNotifications](#eventNotifications ) | No | object | No | In #/definitions/EventNotificationsProps | Configuration of cluster and scheduled action event notifications |
21
+ | - [executionRoles](#executionRoles ) | No | array | No | - | List of external roles which will be associated to the redshift cluster<br />If a role requires access to datawarehouse bucket, then role should be added to 'warehouseBucketUserRoles' in application config |
22
+ | - [federations](#federations ) | No | array | No | - | List of federations/roles to be created for federated access to the cluster |
23
+ | - [multiNode](#multiNode ) | No | boolean | No | - | If true, cluster will be of type MULTI_NODE, otherwise SINGLE_NODE |
24
+ | - [nag_suppressions](#nag_suppressions ) | No | object | No | In #/definitions/MdaaNagSuppressions | Nag suppressions |
25
+ | + [nodeType](#nodeType ) | No | string | No | - | Node type of the cluster. |
26
+ | + [numberOfNodes](#numberOfNodes ) | No | number | No | - | Number of cluster nodes |
27
+ | - [parameterGroupParams](#parameterGroupParams ) | No | object | No | - | Additional parameters for the cluster parameter group. Certain security-sensitive values will be overridden. |
28
+ | + [preferredMaintenanceWindow](#preferredMaintenanceWindow ) | No | string | No | - | The preferred maintenance window for the cluster<br />Example: 'Sun:23:45-Mon:00:15' |
29
+ | - [scheduledActions](#scheduledActions ) | No | array | No | - | List of scheduled actions (pause,resume) which can be applied to the cluster |
30
+ | + [securityGroupIngress](#securityGroupIngress ) | No | object | No | - | Additional ingress rules to be added to the cluster security group, permitting tcp traffic on the cluster port |
31
+ | - [service_catalog_product_config](#service_catalog_product_config ) | No | object | No | In #/definitions/MdaaServiceCatalogProductConfig | Service Catalog Config<br />If specified, the configured module will be deployed as a Service Catalog product instead of directly to the environment |
32
+ | + [subnetIds](#subnetIds ) | No | array of string | No | - | The ID of the subnets on which the cluster will be deployed. |
33
+ | + [vpcId](#vpcId ) | No | string | No | - | The ID of the VPC on which the cluster will be deployed. |
34
+ | - [warehouseBucketUserRoles](#warehouseBucketUserRoles ) | No | array | No | - | List of user roles which will be provided access to cluster resources (like KMS/Bucket) |
35
+ | - [workloadManagement](#workloadManagement ) | No | array of object | No | - | The cluster workload management configuration. |
36
+
37
+ ## <a name="additionalBucketKmsKeyArns"></a>1. Property `root > additionalBucketKmsKeyArns`
38
+
39
+ | | |
40
+ | ------------ | ----------------- |
41
+ | **Type** | `array of string` |
42
+ | **Required** | No |
43
+
44
+ **Description:** Additional KMS keys which can be used to write to the cluster bucket
45
+
46
+ | | Array restrictions |
47
+ | -------------------- | ------------------ |
48
+ | **Min items** | N/A |
49
+ | **Max items** | N/A |
50
+ | **Items unicity** | False |
51
+ | **Additional items** | False |
52
+ | **Tuple validation** | See below |
53
+
54
+ | Each item of this array must be | Description |
55
+ | --------------------------------------------------------------------- | ----------- |
56
+ | [additionalBucketKmsKeyArns items](#additionalBucketKmsKeyArns_items) | - |
57
+
58
+ ### <a name="autogenerated_heading_2"></a>1.1. root > additionalBucketKmsKeyArns > additionalBucketKmsKeyArns items
59
+
60
+ | | |
61
+ | ------------ | -------- |
62
+ | **Type** | `string` |
63
+ | **Required** | No |
64
+
65
+ ## <a name="adminPasswordRotationDays"></a>2. Property `root > adminPasswordRotationDays`
66
+
67
+ | | |
68
+ | ------------ | -------- |
69
+ | **Type** | `number` |
70
+ | **Required** | Yes |
71
+
72
+ **Description:** Set the number of days between admin password rotations
73
+
74
+ ## <a name="adminUsername"></a>3. Property `root > adminUsername`
75
+
76
+ | | |
77
+ | ------------ | -------- |
78
+ | **Type** | `string` |
79
+ | **Required** | Yes |
80
+
81
+ **Description:** Set the admin user name for the cluster
82
+
83
+ ## <a name="automatedSnapshotRetentionDays"></a>4. Property `root > automatedSnapshotRetentionDays`
84
+
85
+ | | |
86
+ | ------------ | -------- |
87
+ | **Type** | `number` |
88
+ | **Required** | No |
89
+
90
+ **Description:** Number of days that automated snapshots are retained
91
+
92
+ ## <a name="clusterPort"></a>5. Property `root > clusterPort`
93
+
94
+ | | |
95
+ | ------------ | -------- |
96
+ | **Type** | `number` |
97
+ | **Required** | No |
98
+
99
+ **Description:** The cluster port (default: 54390)
100
+
101
+ ## <a name="createWarehouseBucket"></a>6. Property `root > createWarehouseBucket`
102
+
103
+ | | |
104
+ | ------------ | --------- |
105
+ | **Type** | `boolean` |
106
+ | **Required** | No |
107
+
108
+ **Description:** If true(default), a Data Warehouse bucket will be created
109
+
110
+ ## <a name="dataAdminRoles"></a>7. Property `root > dataAdminRoles`
111
+
112
+ | | |
113
+ | ------------ | ------- |
114
+ | **Type** | `array` |
115
+ | **Required** | Yes |
116
+
117
+ **Description:** List of admin roles which will be provided access to cluster resources (like KMS/Bucket)
118
+
119
+ | | Array restrictions |
120
+ | -------------------- | ------------------ |
121
+ | **Min items** | N/A |
122
+ | **Max items** | N/A |
123
+ | **Items unicity** | False |
124
+ | **Additional items** | False |
125
+ | **Tuple validation** | See below |
126
+
127
+ | Each item of this array must be | Description |
128
+ | ------------------------------------ | ---------------------------------------------------------------------------- |
129
+ | [MdaaRoleRef](#dataAdminRoles_items) | A reference to an IAM role. Roles can be referenced by name, arn, and/or id. |
130
+
131
+ ### <a name="autogenerated_heading_3"></a>7.1. root > dataAdminRoles > MdaaRoleRef
132
+
133
+ | | |
134
+ | ------------------------- | ------------------------------------------------------- |
135
+ | **Type** | `object` |
136
+ | **Required** | No |
137
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
138
+ | **Defined in** | #/definitions/MdaaRoleRef |
139
+
140
+ **Description:** A reference to an IAM role. Roles can be referenced by name, arn, and/or id.
141
+
142
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
143
+ | ----------------------------------------------- | ------- | ------- | ---------- | ---------- | --------------------------------------------------------------------------------------------- |
144
+ | - [arn](#dataAdminRoles_items_arn ) | No | string | No | - | Reference role by arn |
145
+ | - [id](#dataAdminRoles_items_id ) | No | string | No | - | Reference role by id |
146
+ | - [immutable](#dataAdminRoles_items_immutable ) | No | boolean | No | - | Indicates whether the role should be considered immutable (defaults false) |
147
+ | - [name](#dataAdminRoles_items_name ) | No | string | No | - | Reference role by name |
148
+ | - [refId](#dataAdminRoles_items_refId ) | No | string | No | - | A string which uniquely identifies the MdaaRoleRef within a scope. |
149
+ | - [sso](#dataAdminRoles_items_sso ) | No | boolean | No | - | If true, role name will be resolved to an SSO auto-generated role. Also implies immutability. |
150
+
151
+ #### <a name="dataAdminRoles_items_arn"></a>7.1.1. Property `root > dataAdminRoles > dataAdminRoles items > arn`
152
+
153
+ | | |
154
+ | ------------ | -------- |
155
+ | **Type** | `string` |
156
+ | **Required** | No |
157
+
158
+ **Description:** Reference role by arn
159
+
160
+ #### <a name="dataAdminRoles_items_id"></a>7.1.2. Property `root > dataAdminRoles > dataAdminRoles items > id`
161
+
162
+ | | |
163
+ | ------------ | -------- |
164
+ | **Type** | `string` |
165
+ | **Required** | No |
166
+
167
+ **Description:** Reference role by id
168
+
169
+ #### <a name="dataAdminRoles_items_immutable"></a>7.1.3. Property `root > dataAdminRoles > dataAdminRoles items > immutable`
170
+
171
+ | | |
172
+ | ------------ | --------- |
173
+ | **Type** | `boolean` |
174
+ | **Required** | No |
175
+
176
+ **Description:** Indicates whether the role should be considered immutable (defaults false)
177
+
178
+ #### <a name="dataAdminRoles_items_name"></a>7.1.4. Property `root > dataAdminRoles > dataAdminRoles items > name`
179
+
180
+ | | |
181
+ | ------------ | -------- |
182
+ | **Type** | `string` |
183
+ | **Required** | No |
184
+
185
+ **Description:** Reference role by name
186
+
187
+ #### <a name="dataAdminRoles_items_refId"></a>7.1.5. Property `root > dataAdminRoles > dataAdminRoles items > refId`
188
+
189
+ | | |
190
+ | ------------ | -------- |
191
+ | **Type** | `string` |
192
+ | **Required** | No |
193
+
194
+ **Description:** A string which uniquely identifies the MdaaRoleRef within a scope.
195
+
196
+ #### <a name="dataAdminRoles_items_sso"></a>7.1.6. Property `root > dataAdminRoles > dataAdminRoles items > sso`
197
+
198
+ | | |
199
+ | ------------ | --------- |
200
+ | **Type** | `boolean` |
201
+ | **Required** | No |
202
+
203
+ **Description:** If true, role name will be resolved to an SSO auto-generated role. Also implies immutability.
204
+
205
+ ## <a name="databaseUsers"></a>8. Property `root > databaseUsers`
206
+
207
+ | | |
208
+ | ------------ | ------- |
209
+ | **Type** | `array` |
210
+ | **Required** | No |
211
+
212
+ **Description:** List of Users to be created in Redshift Database, then stored & rotated in secrets manager -> ssm
213
+
214
+ | | Array restrictions |
215
+ | -------------------- | ------------------ |
216
+ | **Min items** | N/A |
217
+ | **Max items** | N/A |
218
+ | **Items unicity** | False |
219
+ | **Additional items** | False |
220
+ | **Tuple validation** | See below |
221
+
222
+ | Each item of this array must be | Description |
223
+ | ------------------------------------------ | ----------- |
224
+ | [DatabaseUsersProps](#databaseUsers_items) | - |
225
+
226
+ ### <a name="autogenerated_heading_4"></a>8.1. root > databaseUsers > DatabaseUsersProps
227
+
228
+ | | |
229
+ | ------------------------- | ------------------------------------------------------- |
230
+ | **Type** | `object` |
231
+ | **Required** | No |
232
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
233
+ | **Defined in** | #/definitions/DatabaseUsersProps |
234
+
235
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
236
+ | ---------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- |
237
+ | + [dbName](#databaseUsers_items_dbName ) | No | string | No | - | The DB to which the user will be added |
238
+ | - [secretAccessRoles](#databaseUsers_items_secretAccessRoles ) | No | array | No | - | List of roles that need redshift secret access |
239
+ | + [secretRotationDays](#databaseUsers_items_secretRotationDays ) | No | number | No | - | Number of days between secret rotation |
240
+ | + [userName](#databaseUsers_items_userName ) | No | string | No | - | Name of the execution role |
241
+
242
+ #### <a name="databaseUsers_items_dbName"></a>8.1.1. Property `root > databaseUsers > databaseUsers items > dbName`
243
+
244
+ | | |
245
+ | ------------ | -------- |
246
+ | **Type** | `string` |
247
+ | **Required** | Yes |
248
+
249
+ **Description:** The DB to which the user will be added
250
+
251
+ #### <a name="databaseUsers_items_secretAccessRoles"></a>8.1.2. Property `root > databaseUsers > databaseUsers items > secretAccessRoles`
252
+
253
+ | | |
254
+ | ------------ | ------- |
255
+ | **Type** | `array` |
256
+ | **Required** | No |
257
+
258
+ **Description:** List of roles that need redshift secret access
259
+
260
+ | | Array restrictions |
261
+ | -------------------- | ------------------ |
262
+ | **Min items** | N/A |
263
+ | **Max items** | N/A |
264
+ | **Items unicity** | False |
265
+ | **Additional items** | False |
266
+ | **Tuple validation** | See below |
267
+
268
+ | Each item of this array must be | Description |
269
+ | ----------------------------------------------------------- | ---------------------------------------------------------------------------- |
270
+ | [MdaaRoleRef](#databaseUsers_items_secretAccessRoles_items) | A reference to an IAM role. Roles can be referenced by name, arn, and/or id. |
271
+
272
+ ##### <a name="autogenerated_heading_5"></a>8.1.2.1. root > databaseUsers > databaseUsers items > secretAccessRoles > MdaaRoleRef
273
+
274
+ | | |
275
+ | ------------------------- | ------------------------------------------------------- |
276
+ | **Type** | `object` |
277
+ | **Required** | No |
278
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
279
+ | **Same definition as** | [dataAdminRoles_items](#dataAdminRoles_items) |
280
+
281
+ **Description:** A reference to an IAM role. Roles can be referenced by name, arn, and/or id.
282
+
283
+ #### <a name="databaseUsers_items_secretRotationDays"></a>8.1.3. Property `root > databaseUsers > databaseUsers items > secretRotationDays`
284
+
285
+ | | |
286
+ | ------------ | -------- |
287
+ | **Type** | `number` |
288
+ | **Required** | Yes |
289
+
290
+ **Description:** Number of days between secret rotation
291
+
292
+ #### <a name="databaseUsers_items_userName"></a>8.1.4. Property `root > databaseUsers > databaseUsers items > userName`
293
+
294
+ | | |
295
+ | ------------ | -------- |
296
+ | **Type** | `string` |
297
+ | **Required** | Yes |
298
+
299
+ **Description:** Name of the execution role
300
+
301
+ ## <a name="enableAuditLoggingToS3"></a>9. Property `root > enableAuditLoggingToS3`
302
+
303
+ | | |
304
+ | ------------ | --------- |
305
+ | **Type** | `boolean` |
306
+ | **Required** | Yes |
307
+
308
+ **Description:** If enabled, cluster audit logging will be written to an S3 bucket created for this purpose.
309
+ Note that Redshift supports audit logging only to SSE-S3 encrypted buckets, so this audit bucket
310
+ will not be created with SSE-KMS or use a customer master key.
311
+
312
+ ## <a name="eventNotifications"></a>10. Property `root > eventNotifications`
313
+
314
+ | | |
315
+ | ------------------------- | ------------------------------------------------------- |
316
+ | **Type** | `object` |
317
+ | **Required** | No |
318
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
319
+ | **Defined in** | #/definitions/EventNotificationsProps |
320
+
321
+ **Description:** Configuration of cluster and scheduled action event notifications
322
+
323
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
324
+ | --------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ----------------- |
325
+ | - [email](#eventNotifications_email ) | No | array of string | No | - | - |
326
+ | - [eventCategories](#eventNotifications_eventCategories ) | No | array | No | - | - |
327
+ | - [severity](#eventNotifications_severity ) | No | enum (of string) | No | - | - |
328
+
329
+ ### <a name="eventNotifications_email"></a>10.1. Property `root > eventNotifications > email`
330
+
331
+ | | |
332
+ | ------------ | ----------------- |
333
+ | **Type** | `array of string` |
334
+ | **Required** | No |
335
+
336
+ | | Array restrictions |
337
+ | -------------------- | ------------------ |
338
+ | **Min items** | N/A |
339
+ | **Max items** | N/A |
340
+ | **Items unicity** | False |
341
+ | **Additional items** | False |
342
+ | **Tuple validation** | See below |
343
+
344
+ | Each item of this array must be | Description |
345
+ | ---------------------------------------------- | ----------- |
346
+ | [email items](#eventNotifications_email_items) | - |
347
+
348
+ #### <a name="autogenerated_heading_6"></a>10.1.1. root > eventNotifications > email > email items
349
+
350
+ | | |
351
+ | ------------ | -------- |
352
+ | **Type** | `string` |
353
+ | **Required** | No |
354
+
355
+ ### <a name="eventNotifications_eventCategories"></a>10.2. Property `root > eventNotifications > eventCategories`
356
+
357
+ | | |
358
+ | ------------ | ------- |
359
+ | **Type** | `array` |
360
+ | **Required** | No |
361
+
362
+ | | Array restrictions |
363
+ | -------------------- | ------------------ |
364
+ | **Min items** | N/A |
365
+ | **Max items** | N/A |
366
+ | **Items unicity** | False |
367
+ | **Additional items** | False |
368
+ | **Tuple validation** | See below |
369
+
370
+ | Each item of this array must be | Description |
371
+ | ------------------------------------------------------------ | ----------- |
372
+ | [EventCategories](#eventNotifications_eventCategories_items) | - |
373
+
374
+ #### <a name="autogenerated_heading_7"></a>10.2.1. root > eventNotifications > eventCategories > EventCategories
375
+
376
+ | | |
377
+ | -------------- | ----------------------------- |
378
+ | **Type** | `enum (of string)` |
379
+ | **Required** | No |
380
+ | **Defined in** | #/definitions/EventCategories |
381
+
382
+ Must be one of:
383
+ * "configuration"
384
+ * "management"
385
+ * "monitoring"
386
+ * "pending"
387
+ * "security"
388
+
389
+ ### <a name="eventNotifications_severity"></a>10.3. Property `root > eventNotifications > severity`
390
+
391
+ | | |
392
+ | ------------ | ------------------ |
393
+ | **Type** | `enum (of string)` |
394
+ | **Required** | No |
395
+
396
+ Must be one of:
397
+ * "ERROR"
398
+ * "INFO"
399
+
400
+ ## <a name="executionRoles"></a>11. Property `root > executionRoles`
401
+
402
+ | | |
403
+ | ------------ | ------- |
404
+ | **Type** | `array` |
405
+ | **Required** | No |
406
+
407
+ **Description:** List of external roles which will be associated to the redshift cluster
408
+ If a role requires access to datawarehouse bucket, then role should be added to 'warehouseBucketUserRoles' in application config
409
+
410
+ | | Array restrictions |
411
+ | -------------------- | ------------------ |
412
+ | **Min items** | N/A |
413
+ | **Max items** | N/A |
414
+ | **Items unicity** | False |
415
+ | **Additional items** | False |
416
+ | **Tuple validation** | See below |
417
+
418
+ | Each item of this array must be | Description |
419
+ | ------------------------------------ | ---------------------------------------------------------------------------- |
420
+ | [MdaaRoleRef](#executionRoles_items) | A reference to an IAM role. Roles can be referenced by name, arn, and/or id. |
421
+
422
+ ### <a name="autogenerated_heading_8"></a>11.1. root > executionRoles > MdaaRoleRef
423
+
424
+ | | |
425
+ | ------------------------- | ------------------------------------------------------- |
426
+ | **Type** | `object` |
427
+ | **Required** | No |
428
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
429
+ | **Same definition as** | [dataAdminRoles_items](#dataAdminRoles_items) |
430
+
431
+ **Description:** A reference to an IAM role. Roles can be referenced by name, arn, and/or id.
432
+
433
+ ## <a name="federations"></a>12. Property `root > federations`
434
+
435
+ | | |
436
+ | ------------ | ------- |
437
+ | **Type** | `array` |
438
+ | **Required** | No |
439
+
440
+ **Description:** List of federations/roles to be created for federated access to the cluster
441
+
442
+ | | Array restrictions |
443
+ | -------------------- | ------------------ |
444
+ | **Min items** | N/A |
445
+ | **Max items** | N/A |
446
+ | **Items unicity** | False |
447
+ | **Additional items** | False |
448
+ | **Tuple validation** | See below |
449
+
450
+ | Each item of this array must be | Description |
451
+ | ------------------------------------- | ----------- |
452
+ | [FederationProps](#federations_items) | - |
453
+
454
+ ### <a name="autogenerated_heading_9"></a>12.1. root > federations > FederationProps
455
+
456
+ | | |
457
+ | ------------------------- | ------------------------------------------------------- |
458
+ | **Type** | `object` |
459
+ | **Required** | No |
460
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
461
+ | **Defined in** | #/definitions/FederationProps |
462
+
463
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
464
+ | ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------- |
465
+ | + [federationName](#federations_items_federationName ) | No | string | No | - | Name of the federation for reference elsewhere in the config. |
466
+ | + [providerArn](#federations_items_providerArn ) | No | string | No | - | Arn of the IAM Identity Provider through which federation will occur |
467
+ | - [url](#federations_items_url ) | No | string | No | - | Deprecated. No Longer used. |
468
+
469
+ #### <a name="federations_items_federationName"></a>12.1.1. Property `root > federations > federations items > federationName`
470
+
471
+ | | |
472
+ | ------------ | -------- |
473
+ | **Type** | `string` |
474
+ | **Required** | Yes |
475
+
476
+ **Description:** Name of the federation for reference elsewhere in the config.
477
+
478
+ #### <a name="federations_items_providerArn"></a>12.1.2. Property `root > federations > federations items > providerArn`
479
+
480
+ | | |
481
+ | ------------ | -------- |
482
+ | **Type** | `string` |
483
+ | **Required** | Yes |
484
+
485
+ **Description:** Arn of the IAM Identity Provider through which federation will occur
486
+
487
+ #### <a name="federations_items_url"></a>12.1.3. Property `root > federations > federations items > url`
488
+
489
+ | | |
490
+ | ------------ | -------- |
491
+ | **Type** | `string` |
492
+ | **Required** | No |
493
+
494
+ **Description:** Deprecated. No Longer used.
495
+
496
+ ## <a name="multiNode"></a>13. Property `root > multiNode`
497
+
498
+ | | |
499
+ | ------------ | --------- |
500
+ | **Type** | `boolean` |
501
+ | **Required** | No |
502
+
503
+ **Description:** If true, cluster will be of type MULTI_NODE, otherwise SINGLE_NODE
504
+
505
+ ## <a name="nag_suppressions"></a>14. Property `root > nag_suppressions`
506
+
507
+ | | |
508
+ | ------------------------- | ------------------------------------------------------- |
509
+ | **Type** | `object` |
510
+ | **Required** | No |
511
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
512
+ | **Defined in** | #/definitions/MdaaNagSuppressions |
513
+
514
+ **Description:** Nag suppressions
515
+
516
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
517
+ | --------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- |
518
+ | + [by_path](#nag_suppressions_by_path ) | No | array | No | - | - |
519
+
520
+ ### <a name="nag_suppressions_by_path"></a>14.1. Property `root > nag_suppressions > by_path`
521
+
522
+ | | |
523
+ | ------------ | ------- |
524
+ | **Type** | `array` |
525
+ | **Required** | Yes |
526
+
527
+ | | Array restrictions |
528
+ | -------------------- | ------------------ |
529
+ | **Min items** | N/A |
530
+ | **Max items** | N/A |
531
+ | **Items unicity** | False |
532
+ | **Additional items** | False |
533
+ | **Tuple validation** | See below |
534
+
535
+ | Each item of this array must be | Description |
536
+ | ----------------------------------------------------------- | ----------- |
537
+ | [MdaaNagSuppressionByPath](#nag_suppressions_by_path_items) | - |
538
+
539
+ #### <a name="autogenerated_heading_10"></a>14.1.1. root > nag_suppressions > by_path > MdaaNagSuppressionByPath
540
+
541
+ | | |
542
+ | ------------------------- | ------------------------------------------------------- |
543
+ | **Type** | `object` |
544
+ | **Required** | No |
545
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
546
+ | **Defined in** | #/definitions/MdaaNagSuppressionByPath |
547
+
548
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
549
+ | --------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
550
+ | + [path](#nag_suppressions_by_path_items_path ) | No | string | No | - | - |
551
+ | + [suppressions](#nag_suppressions_by_path_items_suppressions ) | No | array of object | No | - | - |
552
+
553
+ ##### <a name="nag_suppressions_by_path_items_path"></a>14.1.1.1. Property `root > nag_suppressions > by_path > by_path items > path`
554
+
555
+ | | |
556
+ | ------------ | -------- |
557
+ | **Type** | `string` |
558
+ | **Required** | Yes |
559
+
560
+ ##### <a name="nag_suppressions_by_path_items_suppressions"></a>14.1.1.2. Property `root > nag_suppressions > by_path > by_path items > suppressions`
561
+
562
+ | | |
563
+ | ------------ | ----------------- |
564
+ | **Type** | `array of object` |
565
+ | **Required** | Yes |
566
+
567
+ | | Array restrictions |
568
+ | -------------------- | ------------------ |
569
+ | **Min items** | N/A |
570
+ | **Max items** | N/A |
571
+ | **Items unicity** | False |
572
+ | **Additional items** | False |
573
+ | **Tuple validation** | See below |
574
+
575
+ | Each item of this array must be | Description |
576
+ | ------------------------------------------------------------------------ | ----------- |
577
+ | [suppressions items](#nag_suppressions_by_path_items_suppressions_items) | - |
578
+
579
+ ###### <a name="autogenerated_heading_11"></a>14.1.1.2.1. root > nag_suppressions > by_path > by_path items > suppressions > suppressions items
580
+
581
+ | | |
582
+ | ------------------------- | ------------------------------------------------------- |
583
+ | **Type** | `object` |
584
+ | **Required** | No |
585
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
586
+
587
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
588
+ | ---------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
589
+ | + [id](#nag_suppressions_by_path_items_suppressions_items_id ) | No | string | No | - | - |
590
+ | + [reason](#nag_suppressions_by_path_items_suppressions_items_reason ) | No | string | No | - | - |
591
+
592
+ ###### <a name="nag_suppressions_by_path_items_suppressions_items_id"></a>14.1.1.2.1.1. Property `root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > id`
593
+
594
+ | | |
595
+ | ------------ | -------- |
596
+ | **Type** | `string` |
597
+ | **Required** | Yes |
598
+
599
+ ###### <a name="nag_suppressions_by_path_items_suppressions_items_reason"></a>14.1.1.2.1.2. Property `root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > reason`
600
+
601
+ | | |
602
+ | ------------ | -------- |
603
+ | **Type** | `string` |
604
+ | **Required** | Yes |
605
+
606
+ ## <a name="nodeType"></a>15. Property `root > nodeType`
607
+
608
+ | | |
609
+ | ------------ | -------- |
610
+ | **Type** | `string` |
611
+ | **Required** | Yes |
612
+
613
+ **Description:** Node type of the cluster.
614
+
615
+ ## <a name="numberOfNodes"></a>16. Property `root > numberOfNodes`
616
+
617
+ | | |
618
+ | ------------ | -------- |
619
+ | **Type** | `number` |
620
+ | **Required** | Yes |
621
+
622
+ **Description:** Number of cluster nodes
623
+
624
+ ## <a name="parameterGroupParams"></a>17. Property `root > parameterGroupParams`
625
+
626
+ | | |
627
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
628
+ | **Type** | `object` |
629
+ | **Required** | No |
630
+ | **Additional properties** | [[Should-conform]](#parameterGroupParams_additionalProperties "Each additional property must conform to the following schema") |
631
+
632
+ **Description:** Additional parameters for the cluster parameter group. Certain security-sensitive values will be overridden.
633
+
634
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
635
+ | ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
636
+ | - [](#parameterGroupParams_additionalProperties ) | No | object | No | - | - |
637
+
638
+ ### <a name="parameterGroupParams_additionalProperties"></a>17.1. Property `root > parameterGroupParams > additionalProperties`
639
+
640
+ | | |
641
+ | ------------------------- | ------------------------------------------------------------------------- |
642
+ | **Type** | `object` |
643
+ | **Required** | No |
644
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
645
+
646
+ ## <a name="preferredMaintenanceWindow"></a>18. Property `root > preferredMaintenanceWindow`
647
+
648
+ | | |
649
+ | ------------ | -------- |
650
+ | **Type** | `string` |
651
+ | **Required** | Yes |
652
+
653
+ **Description:** The preferred maintenance window for the cluster
654
+ Example: 'Sun:23:45-Mon:00:15'
655
+
656
+ ## <a name="scheduledActions"></a>19. Property `root > scheduledActions`
657
+
658
+ | | |
659
+ | ------------ | ------- |
660
+ | **Type** | `array` |
661
+ | **Required** | No |
662
+
663
+ **Description:** List of scheduled actions (pause,resume) which can be applied to the cluster
664
+
665
+ | | Array restrictions |
666
+ | -------------------- | ------------------ |
667
+ | **Min items** | N/A |
668
+ | **Max items** | N/A |
669
+ | **Items unicity** | False |
670
+ | **Additional items** | False |
671
+ | **Tuple validation** | See below |
672
+
673
+ | Each item of this array must be | Description |
674
+ | ----------------------------------------------- | ----------- |
675
+ | [ScheduledActionProps](#scheduledActions_items) | - |
676
+
677
+ ### <a name="autogenerated_heading_12"></a>19.1. root > scheduledActions > ScheduledActionProps
678
+
679
+ | | |
680
+ | ------------------------- | ------------------------------------------------------- |
681
+ | **Type** | `object` |
682
+ | **Required** | No |
683
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
684
+ | **Defined in** | #/definitions/ScheduledActionProps |
685
+
686
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
687
+ | ------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------- |
688
+ | + [enable](#scheduledActions_items_enable ) | No | boolean | No | - | Scheduled action is enabled if true |
689
+ | - [endTime](#scheduledActions_items_endTime ) | No | string | No | - | The scheduled action Start Date & Time in UTC format till when the scheduled action is effective. |
690
+ | + [name](#scheduledActions_items_name ) | No | string | No | - | Named of the scheduled action |
691
+ | + [schedule](#scheduledActions_items_schedule ) | No | string | No | - | The scheduled action schedule in cron format |
692
+ | - [startTime](#scheduledActions_items_startTime ) | No | string | No | - | The scheduled action Start Date & Time in UTC format from when the scheduled action is effective. |
693
+ | + [targetAction](#scheduledActions_items_targetAction ) | No | string | No | - | One of "pauseCluster", "resumeCluster" |
694
+
695
+ #### <a name="scheduledActions_items_enable"></a>19.1.1. Property `root > scheduledActions > scheduledActions items > enable`
696
+
697
+ | | |
698
+ | ------------ | --------- |
699
+ | **Type** | `boolean` |
700
+ | **Required** | Yes |
701
+
702
+ **Description:** Scheduled action is enabled if true
703
+
704
+ #### <a name="scheduledActions_items_endTime"></a>19.1.2. Property `root > scheduledActions > scheduledActions items > endTime`
705
+
706
+ | | |
707
+ | ------------ | -------- |
708
+ | **Type** | `string` |
709
+ | **Required** | No |
710
+
711
+ **Description:** The scheduled action Start Date & Time in UTC format till when the scheduled action is effective.
712
+
713
+ #### <a name="scheduledActions_items_name"></a>19.1.3. Property `root > scheduledActions > scheduledActions items > name`
714
+
715
+ | | |
716
+ | ------------ | -------- |
717
+ | **Type** | `string` |
718
+ | **Required** | Yes |
719
+
720
+ **Description:** Named of the scheduled action
721
+
722
+ #### <a name="scheduledActions_items_schedule"></a>19.1.4. Property `root > scheduledActions > scheduledActions items > schedule`
723
+
724
+ | | |
725
+ | ------------ | -------- |
726
+ | **Type** | `string` |
727
+ | **Required** | Yes |
728
+
729
+ **Description:** The scheduled action schedule in cron format
730
+
731
+ #### <a name="scheduledActions_items_startTime"></a>19.1.5. Property `root > scheduledActions > scheduledActions items > startTime`
732
+
733
+ | | |
734
+ | ------------ | -------- |
735
+ | **Type** | `string` |
736
+ | **Required** | No |
737
+
738
+ **Description:** The scheduled action Start Date & Time in UTC format from when the scheduled action is effective.
739
+
740
+ #### <a name="scheduledActions_items_targetAction"></a>19.1.6. Property `root > scheduledActions > scheduledActions items > targetAction`
741
+
742
+ | | |
743
+ | ------------ | -------- |
744
+ | **Type** | `string` |
745
+ | **Required** | Yes |
746
+
747
+ **Description:** One of "pauseCluster", "resumeCluster"
748
+
749
+ ## <a name="securityGroupIngress"></a>20. Property `root > securityGroupIngress`
750
+
751
+ | | |
752
+ | ------------------------- | ------------------------------------------------------- |
753
+ | **Type** | `object` |
754
+ | **Required** | Yes |
755
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
756
+
757
+ **Description:** Additional ingress rules to be added to the cluster security group, permitting tcp traffic on the cluster port
758
+
759
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
760
+ | ------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
761
+ | - [ipv4](#securityGroupIngress_ipv4 ) | No | array of string | No | - | - |
762
+ | - [sg](#securityGroupIngress_sg ) | No | array of string | No | - | - |
763
+
764
+ ### <a name="securityGroupIngress_ipv4"></a>20.1. Property `root > securityGroupIngress > ipv4`
765
+
766
+ | | |
767
+ | ------------ | ----------------- |
768
+ | **Type** | `array of string` |
769
+ | **Required** | No |
770
+
771
+ | | Array restrictions |
772
+ | -------------------- | ------------------ |
773
+ | **Min items** | N/A |
774
+ | **Max items** | N/A |
775
+ | **Items unicity** | False |
776
+ | **Additional items** | False |
777
+ | **Tuple validation** | See below |
778
+
779
+ | Each item of this array must be | Description |
780
+ | ---------------------------------------------- | ----------- |
781
+ | [ipv4 items](#securityGroupIngress_ipv4_items) | - |
782
+
783
+ #### <a name="autogenerated_heading_13"></a>20.1.1. root > securityGroupIngress > ipv4 > ipv4 items
784
+
785
+ | | |
786
+ | ------------ | -------- |
787
+ | **Type** | `string` |
788
+ | **Required** | No |
789
+
790
+ ### <a name="securityGroupIngress_sg"></a>20.2. Property `root > securityGroupIngress > sg`
791
+
792
+ | | |
793
+ | ------------ | ----------------- |
794
+ | **Type** | `array of string` |
795
+ | **Required** | No |
796
+
797
+ | | Array restrictions |
798
+ | -------------------- | ------------------ |
799
+ | **Min items** | N/A |
800
+ | **Max items** | N/A |
801
+ | **Items unicity** | False |
802
+ | **Additional items** | False |
803
+ | **Tuple validation** | See below |
804
+
805
+ | Each item of this array must be | Description |
806
+ | ------------------------------------------ | ----------- |
807
+ | [sg items](#securityGroupIngress_sg_items) | - |
808
+
809
+ #### <a name="autogenerated_heading_14"></a>20.2.1. root > securityGroupIngress > sg > sg items
810
+
811
+ | | |
812
+ | ------------ | -------- |
813
+ | **Type** | `string` |
814
+ | **Required** | No |
815
+
816
+ ## <a name="service_catalog_product_config"></a>21. Property `root > service_catalog_product_config`
817
+
818
+ | | |
819
+ | ------------------------- | ------------------------------------------------------- |
820
+ | **Type** | `object` |
821
+ | **Required** | No |
822
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
823
+ | **Defined in** | #/definitions/MdaaServiceCatalogProductConfig |
824
+
825
+ **Description:** Service Catalog Config
826
+ If specified, the configured module will be deployed as a Service Catalog product instead of directly to the environment
827
+
828
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
829
+ | ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
830
+ | - [launch_role_name](#service_catalog_product_config_launch_role_name ) | No | string | No | - | - |
831
+ | + [name](#service_catalog_product_config_name ) | No | string | No | - | - |
832
+ | + [owner](#service_catalog_product_config_owner ) | No | string | No | - | - |
833
+ | - [parameters](#service_catalog_product_config_parameters ) | No | object | No | - | - |
834
+ | + [portfolio_arn](#service_catalog_product_config_portfolio_arn ) | No | string | No | - | - |
835
+
836
+ ### <a name="service_catalog_product_config_launch_role_name"></a>21.1. Property `root > service_catalog_product_config > launch_role_name`
837
+
838
+ | | |
839
+ | ------------ | -------- |
840
+ | **Type** | `string` |
841
+ | **Required** | No |
842
+
843
+ ### <a name="service_catalog_product_config_name"></a>21.2. Property `root > service_catalog_product_config > name`
844
+
845
+ | | |
846
+ | ------------ | -------- |
847
+ | **Type** | `string` |
848
+ | **Required** | Yes |
849
+
850
+ ### <a name="service_catalog_product_config_owner"></a>21.3. Property `root > service_catalog_product_config > owner`
851
+
852
+ | | |
853
+ | ------------ | -------- |
854
+ | **Type** | `string` |
855
+ | **Required** | Yes |
856
+
857
+ ### <a name="service_catalog_product_config_parameters"></a>21.4. Property `root > service_catalog_product_config > parameters`
858
+
859
+ | | |
860
+ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
861
+ | **Type** | `object` |
862
+ | **Required** | No |
863
+ | **Additional properties** | [[Should-conform]](#service_catalog_product_config_parameters_additionalProperties "Each additional property must conform to the following schema") |
864
+
865
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
866
+ | ---------------------------------------------------------------------- | ------- | ------ | ---------- | -------------------------------------------------- | ----------------- |
867
+ | - [](#service_catalog_product_config_parameters_additionalProperties ) | No | object | No | In #/definitions/MdaaServiceCatalogParameterConfig | - |
868
+
869
+ #### <a name="service_catalog_product_config_parameters_additionalProperties"></a>21.4.1. Property `root > service_catalog_product_config > parameters > MdaaServiceCatalogParameterConfig`
870
+
871
+ | | |
872
+ | ------------------------- | ------------------------------------------------------- |
873
+ | **Type** | `object` |
874
+ | **Required** | No |
875
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
876
+ | **Defined in** | #/definitions/MdaaServiceCatalogParameterConfig |
877
+
878
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
879
+ | --------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------------- | ----------------- |
880
+ | - [constraints](#service_catalog_product_config_parameters_additionalProperties_constraints ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintConfig | - |
881
+ | + [props](#service_catalog_product_config_parameters_additionalProperties_props ) | No | object | No | In #/definitions/CfnParameterProps | - |
882
+
883
+ ##### <a name="service_catalog_product_config_parameters_additionalProperties_constraints"></a>21.4.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints`
884
+
885
+ | | |
886
+ | ------------------------- | ------------------------------------------------------- |
887
+ | **Type** | `object` |
888
+ | **Required** | No |
889
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
890
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintConfig |
891
+
892
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
893
+ | --------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
894
+ | + [description](#service_catalog_product_config_parameters_additionalProperties_constraints_description ) | No | string | No | - | - |
895
+ | + [rules](#service_catalog_product_config_parameters_additionalProperties_constraints_rules ) | No | object | No | - | - |
896
+
897
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_description"></a>21.4.1.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > description`
898
+
899
+ | | |
900
+ | ------------ | -------- |
901
+ | **Type** | `string` |
902
+ | **Required** | Yes |
903
+
904
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules"></a>21.4.1.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules`
905
+
906
+ | | |
907
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
908
+ | **Type** | `object` |
909
+ | **Required** | Yes |
910
+ | **Additional properties** | [[Should-conform]](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties "Each additional property must conform to the following schema") |
911
+
912
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
913
+ | ------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------- | ----------------- |
914
+ | - [](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleConfig | - |
915
+
916
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties"></a>21.4.1.1.2.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > MdaaServiceCatalogConstraintRuleConfig`
917
+
918
+ | | |
919
+ | ------------------------- | ------------------------------------------------------- |
920
+ | **Type** | `object` |
921
+ | **Required** | No |
922
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
923
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleConfig |
924
+
925
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
926
+ | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------ | ----------------- |
927
+ | + [assertions](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions ) | No | array | No | - | - |
928
+ | + [condition](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_condition ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig | - |
929
+
930
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions"></a>21.4.1.1.2.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions`
931
+
932
+ | | |
933
+ | ------------ | ------- |
934
+ | **Type** | `array` |
935
+ | **Required** | Yes |
936
+
937
+ | | Array restrictions |
938
+ | -------------------- | ------------------ |
939
+ | **Min items** | N/A |
940
+ | **Max items** | N/A |
941
+ | **Items unicity** | False |
942
+ | **Additional items** | False |
943
+ | **Tuple validation** | See below |
944
+
945
+ | Each item of this array must be | Description |
946
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
947
+ | [MdaaServiceCatalogConstraintRuleAssertionConfig](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items) | - |
948
+
949
+ ###### <a name="autogenerated_heading_15"></a>21.4.1.1.2.1.1.1. root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > MdaaServiceCatalogConstraintRuleAssertionConfig
950
+
951
+ | | |
952
+ | ------------------------- | ------------------------------------------------------------- |
953
+ | **Type** | `object` |
954
+ | **Required** | No |
955
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
956
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleAssertionConfig |
957
+
958
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
959
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
960
+ | + [assert](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_assert ) | No | string | No | - | - |
961
+ | + [description](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_description ) | No | string | No | - | - |
962
+
963
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_assert"></a>21.4.1.1.2.1.1.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > assert`
964
+
965
+ | | |
966
+ | ------------ | -------- |
967
+ | **Type** | `string` |
968
+ | **Required** | Yes |
969
+
970
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_description"></a>21.4.1.1.2.1.1.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > description`
971
+
972
+ | | |
973
+ | ------------ | -------- |
974
+ | **Type** | `string` |
975
+ | **Required** | Yes |
976
+
977
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_condition"></a>21.4.1.1.2.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > condition`
978
+
979
+ | | |
980
+ | ------------------------- | ------------------------------------------------------------------------- |
981
+ | **Type** | `object` |
982
+ | **Required** | Yes |
983
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
984
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig |
985
+
986
+ ##### <a name="service_catalog_product_config_parameters_additionalProperties_props"></a>21.4.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > props`
987
+
988
+ | | |
989
+ | ------------------------- | ------------------------------------------------------- |
990
+ | **Type** | `object` |
991
+ | **Required** | Yes |
992
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
993
+ | **Defined in** | #/definitions/CfnParameterProps |
994
+
995
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
996
+ | ----------------------------------------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
997
+ | - [allowedPattern](#service_catalog_product_config_parameters_additionalProperties_props_allowedPattern ) | No | string | No | - | A regular expression that represents the patterns to allow for String types. |
998
+ | - [allowedValues](#service_catalog_product_config_parameters_additionalProperties_props_allowedValues ) | No | array of string | No | - | An array containing the list of values allowed for the parameter. |
999
+ | - [constraintDescription](#service_catalog_product_config_parameters_additionalProperties_props_constraintDescription ) | No | string | No | - | A string that explains a constraint when the constraint is violated.<br />For example, without a constraint description, a parameter that has an allowed<br />pattern of [A-Za-z0-9]+ displays the following error message when the user specifies<br />an invalid value: |
1000
+ | - [default](#service_catalog_product_config_parameters_additionalProperties_props_default ) | No | object | No | - | A value of the appropriate type for the template to use if no value is specified<br />when a stack is created. If you define constraints for the parameter, you must specify<br />a value that adheres to those constraints. |
1001
+ | - [description](#service_catalog_product_config_parameters_additionalProperties_props_description ) | No | string | No | - | A string of up to 4000 characters that describes the parameter. |
1002
+ | - [maxLength](#service_catalog_product_config_parameters_additionalProperties_props_maxLength ) | No | number | No | - | An integer value that determines the largest number of characters you want to allow for String types. |
1003
+ | - [maxValue](#service_catalog_product_config_parameters_additionalProperties_props_maxValue ) | No | number | No | - | A numeric value that determines the largest numeric value you want to allow for Number types. |
1004
+ | - [minLength](#service_catalog_product_config_parameters_additionalProperties_props_minLength ) | No | number | No | - | An integer value that determines the smallest number of characters you want to allow for String types. |
1005
+ | - [minValue](#service_catalog_product_config_parameters_additionalProperties_props_minValue ) | No | number | No | - | A numeric value that determines the smallest numeric value you want to allow for Number types. |
1006
+ | - [noEcho](#service_catalog_product_config_parameters_additionalProperties_props_noEcho ) | No | boolean | No | - | Whether to mask the parameter value when anyone makes a call that describes the stack.<br />If you set the value to \`\`true\`\`, the parameter value is masked with asterisks (\`\`*****\`\`). |
1007
+ | - [type](#service_catalog_product_config_parameters_additionalProperties_props_type ) | No | string | No | - | The data type for the parameter (DataType). |
1008
+
1009
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_allowedPattern"></a>21.4.1.2.1. Property `root > service_catalog_product_config > parameters > additionalProperties > props > allowedPattern`
1010
+
1011
+ | | |
1012
+ | ------------ | ------------------------------------------------------- |
1013
+ | **Type** | `string` |
1014
+ | **Required** | No |
1015
+ | **Default** | `"- No constraints on patterns allowed for parameter."` |
1016
+
1017
+ **Description:** A regular expression that represents the patterns to allow for String types.
1018
+
1019
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_allowedValues"></a>21.4.1.2.2. Property `root > service_catalog_product_config > parameters > additionalProperties > props > allowedValues`
1020
+
1021
+ | | |
1022
+ | ------------ | ----------------------------------------------------- |
1023
+ | **Type** | `array of string` |
1024
+ | **Required** | No |
1025
+ | **Default** | `"- No constraints on values allowed for parameter."` |
1026
+
1027
+ **Description:** An array containing the list of values allowed for the parameter.
1028
+
1029
+ | | Array restrictions |
1030
+ | -------------------- | ------------------ |
1031
+ | **Min items** | N/A |
1032
+ | **Max items** | N/A |
1033
+ | **Items unicity** | False |
1034
+ | **Additional items** | False |
1035
+ | **Tuple validation** | See below |
1036
+
1037
+ | Each item of this array must be | Description |
1038
+ | ---------------------------------------------------------------------------------------------------------------- | ----------- |
1039
+ | [allowedValues items](#service_catalog_product_config_parameters_additionalProperties_props_allowedValues_items) | - |
1040
+
1041
+ ###### <a name="autogenerated_heading_16"></a>21.4.1.2.2.1. root > service_catalog_product_config > parameters > additionalProperties > props > allowedValues > allowedValues items
1042
+
1043
+ | | |
1044
+ | ------------ | -------- |
1045
+ | **Type** | `string` |
1046
+ | **Required** | No |
1047
+
1048
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_constraintDescription"></a>21.4.1.2.3. Property `root > service_catalog_product_config > parameters > additionalProperties > props > constraintDescription`
1049
+
1050
+ | | |
1051
+ | ------------ | -------------------------------------------------------------------------------------- |
1052
+ | **Type** | `string` |
1053
+ | **Required** | No |
1054
+ | **Default** | `"- No description with customized error message when user specifies invalid values."` |
1055
+
1056
+ **Description:** A string that explains a constraint when the constraint is violated.
1057
+ For example, without a constraint description, a parameter that has an allowed
1058
+ pattern of [A-Za-z0-9]+ displays the following error message when the user specifies
1059
+ an invalid value:
1060
+
1061
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_default"></a>21.4.1.2.4. Property `root > service_catalog_product_config > parameters > additionalProperties > props > default`
1062
+
1063
+ | | |
1064
+ | ------------------------- | ------------------------------------------------------------------------- |
1065
+ | **Type** | `object` |
1066
+ | **Required** | No |
1067
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
1068
+ | **Default** | `"- No default value for parameter."` |
1069
+
1070
+ **Description:** A value of the appropriate type for the template to use if no value is specified
1071
+ when a stack is created. If you define constraints for the parameter, you must specify
1072
+ a value that adheres to those constraints.
1073
+
1074
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_description"></a>21.4.1.2.5. Property `root > service_catalog_product_config > parameters > additionalProperties > props > description`
1075
+
1076
+ | | |
1077
+ | ------------ | --------------------------------------- |
1078
+ | **Type** | `string` |
1079
+ | **Required** | No |
1080
+ | **Default** | `"- No description for the parameter."` |
1081
+
1082
+ **Description:** A string of up to 4000 characters that describes the parameter.
1083
+
1084
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_maxLength"></a>21.4.1.2.6. Property `root > service_catalog_product_config > parameters > additionalProperties > props > maxLength`
1085
+
1086
+ | | |
1087
+ | ------------ | ----------- |
1088
+ | **Type** | `number` |
1089
+ | **Required** | No |
1090
+ | **Default** | `"- None."` |
1091
+
1092
+ **Description:** An integer value that determines the largest number of characters you want to allow for String types.
1093
+
1094
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_maxValue"></a>21.4.1.2.7. Property `root > service_catalog_product_config > parameters > additionalProperties > props > maxValue`
1095
+
1096
+ | | |
1097
+ | ------------ | ----------- |
1098
+ | **Type** | `number` |
1099
+ | **Required** | No |
1100
+ | **Default** | `"- None."` |
1101
+
1102
+ **Description:** A numeric value that determines the largest numeric value you want to allow for Number types.
1103
+
1104
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_minLength"></a>21.4.1.2.8. Property `root > service_catalog_product_config > parameters > additionalProperties > props > minLength`
1105
+
1106
+ | | |
1107
+ | ------------ | ----------- |
1108
+ | **Type** | `number` |
1109
+ | **Required** | No |
1110
+ | **Default** | `"- None."` |
1111
+
1112
+ **Description:** An integer value that determines the smallest number of characters you want to allow for String types.
1113
+
1114
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_minValue"></a>21.4.1.2.9. Property `root > service_catalog_product_config > parameters > additionalProperties > props > minValue`
1115
+
1116
+ | | |
1117
+ | ------------ | ----------- |
1118
+ | **Type** | `number` |
1119
+ | **Required** | No |
1120
+ | **Default** | `"- None."` |
1121
+
1122
+ **Description:** A numeric value that determines the smallest numeric value you want to allow for Number types.
1123
+
1124
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_noEcho"></a>21.4.1.2.10. Property `root > service_catalog_product_config > parameters > additionalProperties > props > noEcho`
1125
+
1126
+ | | |
1127
+ | ------------ | -------------------------------------- |
1128
+ | **Type** | `boolean` |
1129
+ | **Required** | No |
1130
+ | **Default** | `"- Parameter values are not masked."` |
1131
+
1132
+ **Description:** Whether to mask the parameter value when anyone makes a call that describes the stack.
1133
+ If you set the value to ``true``, the parameter value is masked with asterisks (``*****``).
1134
+
1135
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_type"></a>21.4.1.2.11. Property `root > service_catalog_product_config > parameters > additionalProperties > props > type`
1136
+
1137
+ | | |
1138
+ | ------------ | ---------- |
1139
+ | **Type** | `string` |
1140
+ | **Required** | No |
1141
+ | **Default** | `"String"` |
1142
+
1143
+ **Description:** The data type for the parameter (DataType).
1144
+
1145
+ ### <a name="service_catalog_product_config_portfolio_arn"></a>21.5. Property `root > service_catalog_product_config > portfolio_arn`
1146
+
1147
+ | | |
1148
+ | ------------ | -------- |
1149
+ | **Type** | `string` |
1150
+ | **Required** | Yes |
1151
+
1152
+ ## <a name="subnetIds"></a>22. Property `root > subnetIds`
1153
+
1154
+ | | |
1155
+ | ------------ | ----------------- |
1156
+ | **Type** | `array of string` |
1157
+ | **Required** | Yes |
1158
+
1159
+ **Description:** The ID of the subnets on which the cluster will be deployed.
1160
+
1161
+ | | Array restrictions |
1162
+ | -------------------- | ------------------ |
1163
+ | **Min items** | N/A |
1164
+ | **Max items** | N/A |
1165
+ | **Items unicity** | False |
1166
+ | **Additional items** | False |
1167
+ | **Tuple validation** | See below |
1168
+
1169
+ | Each item of this array must be | Description |
1170
+ | ----------------------------------- | ----------- |
1171
+ | [subnetIds items](#subnetIds_items) | - |
1172
+
1173
+ ### <a name="autogenerated_heading_17"></a>22.1. root > subnetIds > subnetIds items
1174
+
1175
+ | | |
1176
+ | ------------ | -------- |
1177
+ | **Type** | `string` |
1178
+ | **Required** | No |
1179
+
1180
+ ## <a name="vpcId"></a>23. Property `root > vpcId`
1181
+
1182
+ | | |
1183
+ | ------------ | -------- |
1184
+ | **Type** | `string` |
1185
+ | **Required** | Yes |
1186
+
1187
+ **Description:** The ID of the VPC on which the cluster will be deployed.
1188
+
1189
+ ## <a name="warehouseBucketUserRoles"></a>24. Property `root > warehouseBucketUserRoles`
1190
+
1191
+ | | |
1192
+ | ------------ | ------- |
1193
+ | **Type** | `array` |
1194
+ | **Required** | No |
1195
+
1196
+ **Description:** List of user roles which will be provided access to cluster resources (like KMS/Bucket)
1197
+
1198
+ | | Array restrictions |
1199
+ | -------------------- | ------------------ |
1200
+ | **Min items** | N/A |
1201
+ | **Max items** | N/A |
1202
+ | **Items unicity** | False |
1203
+ | **Additional items** | False |
1204
+ | **Tuple validation** | See below |
1205
+
1206
+ | Each item of this array must be | Description |
1207
+ | ---------------------------------------------- | ---------------------------------------------------------------------------- |
1208
+ | [MdaaRoleRef](#warehouseBucketUserRoles_items) | A reference to an IAM role. Roles can be referenced by name, arn, and/or id. |
1209
+
1210
+ ### <a name="autogenerated_heading_18"></a>24.1. root > warehouseBucketUserRoles > MdaaRoleRef
1211
+
1212
+ | | |
1213
+ | ------------------------- | ------------------------------------------------------- |
1214
+ | **Type** | `object` |
1215
+ | **Required** | No |
1216
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
1217
+ | **Same definition as** | [dataAdminRoles_items](#dataAdminRoles_items) |
1218
+
1219
+ **Description:** A reference to an IAM role. Roles can be referenced by name, arn, and/or id.
1220
+
1221
+ ## <a name="workloadManagement"></a>25. Property `root > workloadManagement`
1222
+
1223
+ | | |
1224
+ | ------------ | ----------------- |
1225
+ | **Type** | `array of object` |
1226
+ | **Required** | No |
1227
+
1228
+ **Description:** The cluster workload management configuration.
1229
+
1230
+ | | Array restrictions |
1231
+ | -------------------- | ------------------ |
1232
+ | **Min items** | N/A |
1233
+ | **Max items** | N/A |
1234
+ | **Items unicity** | False |
1235
+ | **Additional items** | False |
1236
+ | **Tuple validation** | See below |
1237
+
1238
+ | Each item of this array must be | Description |
1239
+ | ----------------------------------------------------- | ----------- |
1240
+ | [workloadManagement items](#workloadManagement_items) | - |
1241
+
1242
+ ### <a name="autogenerated_heading_19"></a>25.1. root > workloadManagement > workloadManagement items
1243
+
1244
+ | | |
1245
+ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
1246
+ | **Type** | `object` |
1247
+ | **Required** | No |
1248
+ | **Additional properties** | [[Should-conform]](#workloadManagement_items_additionalProperties "Each additional property must conform to the following schema") |
1249
+
1250
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
1251
+ | ----------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
1252
+ | - [](#workloadManagement_items_additionalProperties ) | No | object | No | - | - |
1253
+
1254
+ #### <a name="workloadManagement_items_additionalProperties"></a>25.1.1. Property `root > workloadManagement > workloadManagement items > additionalProperties`
1255
+
1256
+ | | |
1257
+ | ------------------------- | ------------------------------------------------------------------------- |
1258
+ | **Type** | `object` |
1259
+ | **Required** | No |
1260
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
1261
+
1262
+ ----------------------------------------------------------------------------------------------------------------------------
1263
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-08-16 at 13:40:47 -0400