@aws-mdaa/devops 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 (11) hide show
  1. package/SCHEMA.md +981 -0
  2. package/bin/devops.d.ts +6 -0
  3. package/bin/devops.js +10 -0
  4. package/cdk.json +7 -0
  5. package/lib/config-schema.json +431 -0
  6. package/lib/devops.d.ts +210 -0
  7. package/lib/devops.js +392 -0
  8. package/lib/index.d.ts +5 -0
  9. package/lib/index.js +24 -0
  10. package/mdaa.config.json +3 -0
  11. package/package.json +57 -0
package/SCHEMA.md ADDED
@@ -0,0 +1,981 @@
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
+ | - [cdkBootstrapContext](#cdkBootstrapContext ) | No | string | No | - | - |
12
+ | - [configsBranch](#configsBranch ) | No | string | No | - | - |
13
+ | + [configsCodeCommitRepo](#configsCodeCommitRepo ) | No | string | No | - | - |
14
+ | - [deploy](#deploy ) | No | object | No | In #/definitions/StageCommands | - |
15
+ | - [install](#install ) | No | array of string | No | - | - |
16
+ | - [mdaaBranch](#mdaaBranch ) | No | string | No | - | - |
17
+ | + [mdaaCodeCommitRepo](#mdaaCodeCommitRepo ) | No | string | No | - | - |
18
+ | - [nag_suppressions](#nag_suppressions ) | No | object | No | In #/definitions/MdaaNagSuppressions | Nag suppressions |
19
+ | - [pipelines](#pipelines ) | No | object | No | - | - |
20
+ | - [post](#post ) | No | array of string | No | - | - |
21
+ | - [postDeployValidate](#postDeployValidate ) | No | object | No | Same as [postDeployValidate](#pipelines_additionalProperties_postDeployValidate ) | - |
22
+ | - [pre](#pre ) | No | array of string | No | - | - |
23
+ | - [preDeploy](#preDeploy ) | No | object | No | Same as [deploy](#deploy ) | - |
24
+ | - [preDeployValidate](#preDeployValidate ) | No | object | No | Same as [postDeployValidate](#pipelines_additionalProperties_postDeployValidate ) | - |
25
+ | - [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 |
26
+
27
+ ## <a name="cdkBootstrapContext"></a>1. Property `root > cdkBootstrapContext`
28
+
29
+ | | |
30
+ | ------------ | -------- |
31
+ | **Type** | `string` |
32
+ | **Required** | No |
33
+
34
+ ## <a name="configsBranch"></a>2. Property `root > configsBranch`
35
+
36
+ | | |
37
+ | ------------ | -------- |
38
+ | **Type** | `string` |
39
+ | **Required** | No |
40
+
41
+ ## <a name="configsCodeCommitRepo"></a>3. Property `root > configsCodeCommitRepo`
42
+
43
+ | | |
44
+ | ------------ | -------- |
45
+ | **Type** | `string` |
46
+ | **Required** | Yes |
47
+
48
+ ## <a name="deploy"></a>4. Property `root > deploy`
49
+
50
+ | | |
51
+ | ------------------------- | ------------------------------------------------------- |
52
+ | **Type** | `object` |
53
+ | **Required** | No |
54
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
55
+ | **Defined in** | #/definitions/StageCommands |
56
+
57
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
58
+ | ----------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
59
+ | - [install](#deploy_install ) | No | array of string | No | - | - |
60
+ | - [post](#deploy_post ) | No | array of string | No | - | - |
61
+ | - [pre](#deploy_pre ) | No | array of string | No | - | - |
62
+
63
+ ### <a name="deploy_install"></a>4.1. Property `root > deploy > install`
64
+
65
+ | | |
66
+ | ------------ | ----------------- |
67
+ | **Type** | `array of string` |
68
+ | **Required** | No |
69
+
70
+ | | Array restrictions |
71
+ | -------------------- | ------------------ |
72
+ | **Min items** | N/A |
73
+ | **Max items** | N/A |
74
+ | **Items unicity** | False |
75
+ | **Additional items** | False |
76
+ | **Tuple validation** | See below |
77
+
78
+ | Each item of this array must be | Description |
79
+ | -------------------------------------- | ----------- |
80
+ | [install items](#deploy_install_items) | - |
81
+
82
+ #### <a name="autogenerated_heading_2"></a>4.1.1. root > deploy > install > install items
83
+
84
+ | | |
85
+ | ------------ | -------- |
86
+ | **Type** | `string` |
87
+ | **Required** | No |
88
+
89
+ ### <a name="deploy_post"></a>4.2. Property `root > deploy > post`
90
+
91
+ | | |
92
+ | ------------ | ----------------- |
93
+ | **Type** | `array of string` |
94
+ | **Required** | No |
95
+
96
+ | | Array restrictions |
97
+ | -------------------- | ------------------ |
98
+ | **Min items** | N/A |
99
+ | **Max items** | N/A |
100
+ | **Items unicity** | False |
101
+ | **Additional items** | False |
102
+ | **Tuple validation** | See below |
103
+
104
+ | Each item of this array must be | Description |
105
+ | -------------------------------- | ----------- |
106
+ | [post items](#deploy_post_items) | - |
107
+
108
+ #### <a name="autogenerated_heading_3"></a>4.2.1. root > deploy > post > post items
109
+
110
+ | | |
111
+ | ------------ | -------- |
112
+ | **Type** | `string` |
113
+ | **Required** | No |
114
+
115
+ ### <a name="deploy_pre"></a>4.3. Property `root > deploy > pre`
116
+
117
+ | | |
118
+ | ------------ | ----------------- |
119
+ | **Type** | `array of string` |
120
+ | **Required** | No |
121
+
122
+ | | Array restrictions |
123
+ | -------------------- | ------------------ |
124
+ | **Min items** | N/A |
125
+ | **Max items** | N/A |
126
+ | **Items unicity** | False |
127
+ | **Additional items** | False |
128
+ | **Tuple validation** | See below |
129
+
130
+ | Each item of this array must be | Description |
131
+ | ------------------------------- | ----------- |
132
+ | [pre items](#deploy_pre_items) | - |
133
+
134
+ #### <a name="autogenerated_heading_4"></a>4.3.1. root > deploy > pre > pre items
135
+
136
+ | | |
137
+ | ------------ | -------- |
138
+ | **Type** | `string` |
139
+ | **Required** | No |
140
+
141
+ ## <a name="install"></a>5. Property `root > install`
142
+
143
+ | | |
144
+ | ------------ | ----------------- |
145
+ | **Type** | `array of string` |
146
+ | **Required** | No |
147
+
148
+ | | Array restrictions |
149
+ | -------------------- | ------------------ |
150
+ | **Min items** | N/A |
151
+ | **Max items** | N/A |
152
+ | **Items unicity** | False |
153
+ | **Additional items** | False |
154
+ | **Tuple validation** | See below |
155
+
156
+ | Each item of this array must be | Description |
157
+ | ------------------------------- | ----------- |
158
+ | [install items](#install_items) | - |
159
+
160
+ ### <a name="autogenerated_heading_5"></a>5.1. root > install > install items
161
+
162
+ | | |
163
+ | ------------ | -------- |
164
+ | **Type** | `string` |
165
+ | **Required** | No |
166
+
167
+ ## <a name="mdaaBranch"></a>6. Property `root > mdaaBranch`
168
+
169
+ | | |
170
+ | ------------ | -------- |
171
+ | **Type** | `string` |
172
+ | **Required** | No |
173
+
174
+ ## <a name="mdaaCodeCommitRepo"></a>7. Property `root > mdaaCodeCommitRepo`
175
+
176
+ | | |
177
+ | ------------ | -------- |
178
+ | **Type** | `string` |
179
+ | **Required** | Yes |
180
+
181
+ ## <a name="nag_suppressions"></a>8. Property `root > nag_suppressions`
182
+
183
+ | | |
184
+ | ------------------------- | ------------------------------------------------------- |
185
+ | **Type** | `object` |
186
+ | **Required** | No |
187
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
188
+ | **Defined in** | #/definitions/MdaaNagSuppressions |
189
+
190
+ **Description:** Nag suppressions
191
+
192
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
193
+ | --------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- |
194
+ | + [by_path](#nag_suppressions_by_path ) | No | array | No | - | - |
195
+
196
+ ### <a name="nag_suppressions_by_path"></a>8.1. Property `root > nag_suppressions > by_path`
197
+
198
+ | | |
199
+ | ------------ | ------- |
200
+ | **Type** | `array` |
201
+ | **Required** | Yes |
202
+
203
+ | | Array restrictions |
204
+ | -------------------- | ------------------ |
205
+ | **Min items** | N/A |
206
+ | **Max items** | N/A |
207
+ | **Items unicity** | False |
208
+ | **Additional items** | False |
209
+ | **Tuple validation** | See below |
210
+
211
+ | Each item of this array must be | Description |
212
+ | ----------------------------------------------------------- | ----------- |
213
+ | [MdaaNagSuppressionByPath](#nag_suppressions_by_path_items) | - |
214
+
215
+ #### <a name="autogenerated_heading_6"></a>8.1.1. root > nag_suppressions > by_path > MdaaNagSuppressionByPath
216
+
217
+ | | |
218
+ | ------------------------- | ------------------------------------------------------- |
219
+ | **Type** | `object` |
220
+ | **Required** | No |
221
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
222
+ | **Defined in** | #/definitions/MdaaNagSuppressionByPath |
223
+
224
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
225
+ | --------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
226
+ | + [path](#nag_suppressions_by_path_items_path ) | No | string | No | - | - |
227
+ | + [suppressions](#nag_suppressions_by_path_items_suppressions ) | No | array of object | No | - | - |
228
+
229
+ ##### <a name="nag_suppressions_by_path_items_path"></a>8.1.1.1. Property `root > nag_suppressions > by_path > by_path items > path`
230
+
231
+ | | |
232
+ | ------------ | -------- |
233
+ | **Type** | `string` |
234
+ | **Required** | Yes |
235
+
236
+ ##### <a name="nag_suppressions_by_path_items_suppressions"></a>8.1.1.2. Property `root > nag_suppressions > by_path > by_path items > suppressions`
237
+
238
+ | | |
239
+ | ------------ | ----------------- |
240
+ | **Type** | `array of object` |
241
+ | **Required** | Yes |
242
+
243
+ | | Array restrictions |
244
+ | -------------------- | ------------------ |
245
+ | **Min items** | N/A |
246
+ | **Max items** | N/A |
247
+ | **Items unicity** | False |
248
+ | **Additional items** | False |
249
+ | **Tuple validation** | See below |
250
+
251
+ | Each item of this array must be | Description |
252
+ | ------------------------------------------------------------------------ | ----------- |
253
+ | [suppressions items](#nag_suppressions_by_path_items_suppressions_items) | - |
254
+
255
+ ###### <a name="autogenerated_heading_7"></a>8.1.1.2.1. root > nag_suppressions > by_path > by_path items > suppressions > suppressions items
256
+
257
+ | | |
258
+ | ------------------------- | ------------------------------------------------------- |
259
+ | **Type** | `object` |
260
+ | **Required** | No |
261
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
262
+
263
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
264
+ | ---------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
265
+ | + [id](#nag_suppressions_by_path_items_suppressions_items_id ) | No | string | No | - | - |
266
+ | + [reason](#nag_suppressions_by_path_items_suppressions_items_reason ) | No | string | No | - | - |
267
+
268
+ ###### <a name="nag_suppressions_by_path_items_suppressions_items_id"></a>8.1.1.2.1.1. Property `root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > id`
269
+
270
+ | | |
271
+ | ------------ | -------- |
272
+ | **Type** | `string` |
273
+ | **Required** | Yes |
274
+
275
+ ###### <a name="nag_suppressions_by_path_items_suppressions_items_reason"></a>8.1.1.2.1.2. Property `root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > reason`
276
+
277
+ | | |
278
+ | ------------ | -------- |
279
+ | **Type** | `string` |
280
+ | **Required** | Yes |
281
+
282
+ ## <a name="pipelines"></a>9. Property `root > pipelines`
283
+
284
+ | | |
285
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------- |
286
+ | **Type** | `object` |
287
+ | **Required** | No |
288
+ | **Additional properties** | [[Should-conform]](#pipelines_additionalProperties "Each additional property must conform to the following schema") |
289
+
290
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
291
+ | -------------------------------------- | ------- | ------ | ---------- | ------------------------------- | ----------------- |
292
+ | - [](#pipelines_additionalProperties ) | No | object | No | In #/definitions/PipelineConfig | - |
293
+
294
+ ### <a name="pipelines_additionalProperties"></a>9.1. Property `root > pipelines > PipelineConfig`
295
+
296
+ | | |
297
+ | ------------------------- | ------------------------------------------------------- |
298
+ | **Type** | `object` |
299
+ | **Required** | No |
300
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
301
+ | **Defined in** | #/definitions/PipelineConfig |
302
+
303
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
304
+ | --------------------------------------------------------------------------- | ------- | --------------- | ---------- | --------------------------------------------------------------------------------- | ----------------- |
305
+ | - [deploy](#pipelines_additionalProperties_deploy ) | No | object | No | Same as [deploy](#deploy ) | - |
306
+ | - [domainFilter](#pipelines_additionalProperties_domainFilter ) | No | array of string | No | - | - |
307
+ | - [envFilter](#pipelines_additionalProperties_envFilter ) | No | array of string | No | - | - |
308
+ | - [install](#pipelines_additionalProperties_install ) | No | array of string | No | - | - |
309
+ | - [moduleFilter](#pipelines_additionalProperties_moduleFilter ) | No | array of string | No | - | - |
310
+ | - [post](#pipelines_additionalProperties_post ) | No | array of string | No | - | - |
311
+ | - [postDeployValidate](#pipelines_additionalProperties_postDeployValidate ) | No | object | No | In #/definitions/ValidateStageCommands | - |
312
+ | - [pre](#pipelines_additionalProperties_pre ) | No | array of string | No | - | - |
313
+ | - [preDeploy](#pipelines_additionalProperties_preDeploy ) | No | object | No | Same as [deploy](#deploy ) | - |
314
+ | - [preDeployValidate](#pipelines_additionalProperties_preDeployValidate ) | No | object | No | Same as [postDeployValidate](#pipelines_additionalProperties_postDeployValidate ) | - |
315
+
316
+ #### <a name="pipelines_additionalProperties_deploy"></a>9.1.1. Property `root > pipelines > additionalProperties > deploy`
317
+
318
+ | | |
319
+ | ------------------------- | ------------------------------------------------------- |
320
+ | **Type** | `object` |
321
+ | **Required** | No |
322
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
323
+ | **Same definition as** | [deploy](#deploy) |
324
+
325
+ #### <a name="pipelines_additionalProperties_domainFilter"></a>9.1.2. Property `root > pipelines > additionalProperties > domainFilter`
326
+
327
+ | | |
328
+ | ------------ | ----------------- |
329
+ | **Type** | `array of string` |
330
+ | **Required** | No |
331
+
332
+ | | Array restrictions |
333
+ | -------------------- | ------------------ |
334
+ | **Min items** | N/A |
335
+ | **Max items** | N/A |
336
+ | **Items unicity** | False |
337
+ | **Additional items** | False |
338
+ | **Tuple validation** | See below |
339
+
340
+ | Each item of this array must be | Description |
341
+ | ------------------------------------------------------------------------ | ----------- |
342
+ | [domainFilter items](#pipelines_additionalProperties_domainFilter_items) | - |
343
+
344
+ ##### <a name="autogenerated_heading_8"></a>9.1.2.1. root > pipelines > additionalProperties > domainFilter > domainFilter items
345
+
346
+ | | |
347
+ | ------------ | -------- |
348
+ | **Type** | `string` |
349
+ | **Required** | No |
350
+
351
+ #### <a name="pipelines_additionalProperties_envFilter"></a>9.1.3. Property `root > pipelines > additionalProperties > envFilter`
352
+
353
+ | | |
354
+ | ------------ | ----------------- |
355
+ | **Type** | `array of string` |
356
+ | **Required** | No |
357
+
358
+ | | Array restrictions |
359
+ | -------------------- | ------------------ |
360
+ | **Min items** | N/A |
361
+ | **Max items** | N/A |
362
+ | **Items unicity** | False |
363
+ | **Additional items** | False |
364
+ | **Tuple validation** | See below |
365
+
366
+ | Each item of this array must be | Description |
367
+ | ------------------------------------------------------------------ | ----------- |
368
+ | [envFilter items](#pipelines_additionalProperties_envFilter_items) | - |
369
+
370
+ ##### <a name="autogenerated_heading_9"></a>9.1.3.1. root > pipelines > additionalProperties > envFilter > envFilter items
371
+
372
+ | | |
373
+ | ------------ | -------- |
374
+ | **Type** | `string` |
375
+ | **Required** | No |
376
+
377
+ #### <a name="pipelines_additionalProperties_install"></a>9.1.4. Property `root > pipelines > additionalProperties > install`
378
+
379
+ | | |
380
+ | ------------ | ----------------- |
381
+ | **Type** | `array of string` |
382
+ | **Required** | No |
383
+
384
+ | | Array restrictions |
385
+ | -------------------- | ------------------ |
386
+ | **Min items** | N/A |
387
+ | **Max items** | N/A |
388
+ | **Items unicity** | False |
389
+ | **Additional items** | False |
390
+ | **Tuple validation** | See below |
391
+
392
+ | Each item of this array must be | Description |
393
+ | -------------------------------------------------------------- | ----------- |
394
+ | [install items](#pipelines_additionalProperties_install_items) | - |
395
+
396
+ ##### <a name="autogenerated_heading_10"></a>9.1.4.1. root > pipelines > additionalProperties > install > install items
397
+
398
+ | | |
399
+ | ------------ | -------- |
400
+ | **Type** | `string` |
401
+ | **Required** | No |
402
+
403
+ #### <a name="pipelines_additionalProperties_moduleFilter"></a>9.1.5. Property `root > pipelines > additionalProperties > moduleFilter`
404
+
405
+ | | |
406
+ | ------------ | ----------------- |
407
+ | **Type** | `array of string` |
408
+ | **Required** | No |
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
+ | [moduleFilter items](#pipelines_additionalProperties_moduleFilter_items) | - |
421
+
422
+ ##### <a name="autogenerated_heading_11"></a>9.1.5.1. root > pipelines > additionalProperties > moduleFilter > moduleFilter items
423
+
424
+ | | |
425
+ | ------------ | -------- |
426
+ | **Type** | `string` |
427
+ | **Required** | No |
428
+
429
+ #### <a name="pipelines_additionalProperties_post"></a>9.1.6. Property `root > pipelines > additionalProperties > post`
430
+
431
+ | | |
432
+ | ------------ | ----------------- |
433
+ | **Type** | `array of string` |
434
+ | **Required** | No |
435
+
436
+ | | Array restrictions |
437
+ | -------------------- | ------------------ |
438
+ | **Min items** | N/A |
439
+ | **Max items** | N/A |
440
+ | **Items unicity** | False |
441
+ | **Additional items** | False |
442
+ | **Tuple validation** | See below |
443
+
444
+ | Each item of this array must be | Description |
445
+ | -------------------------------------------------------- | ----------- |
446
+ | [post items](#pipelines_additionalProperties_post_items) | - |
447
+
448
+ ##### <a name="autogenerated_heading_12"></a>9.1.6.1. root > pipelines > additionalProperties > post > post items
449
+
450
+ | | |
451
+ | ------------ | -------- |
452
+ | **Type** | `string` |
453
+ | **Required** | No |
454
+
455
+ #### <a name="pipelines_additionalProperties_postDeployValidate"></a>9.1.7. Property `root > pipelines > additionalProperties > postDeployValidate`
456
+
457
+ | | |
458
+ | ------------------------- | ------------------------------------------------------- |
459
+ | **Type** | `object` |
460
+ | **Required** | No |
461
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
462
+ | **Defined in** | #/definitions/ValidateStageCommands |
463
+
464
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
465
+ | -------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
466
+ | - [commands](#pipelines_additionalProperties_postDeployValidate_commands ) | No | array of string | No | - | - |
467
+ | - [install](#pipelines_additionalProperties_postDeployValidate_install ) | No | array of string | No | - | - |
468
+
469
+ ##### <a name="pipelines_additionalProperties_postDeployValidate_commands"></a>9.1.7.1. Property `root > pipelines > additionalProperties > postDeployValidate > commands`
470
+
471
+ | | |
472
+ | ------------ | ----------------- |
473
+ | **Type** | `array of string` |
474
+ | **Required** | No |
475
+
476
+ | | Array restrictions |
477
+ | -------------------- | ------------------ |
478
+ | **Min items** | N/A |
479
+ | **Max items** | N/A |
480
+ | **Items unicity** | False |
481
+ | **Additional items** | False |
482
+ | **Tuple validation** | See below |
483
+
484
+ | Each item of this array must be | Description |
485
+ | ----------------------------------------------------------------------------------- | ----------- |
486
+ | [commands items](#pipelines_additionalProperties_postDeployValidate_commands_items) | - |
487
+
488
+ ###### <a name="autogenerated_heading_13"></a>9.1.7.1.1. root > pipelines > additionalProperties > postDeployValidate > commands > commands items
489
+
490
+ | | |
491
+ | ------------ | -------- |
492
+ | **Type** | `string` |
493
+ | **Required** | No |
494
+
495
+ ##### <a name="pipelines_additionalProperties_postDeployValidate_install"></a>9.1.7.2. Property `root > pipelines > additionalProperties > postDeployValidate > install`
496
+
497
+ | | |
498
+ | ------------ | ----------------- |
499
+ | **Type** | `array of string` |
500
+ | **Required** | No |
501
+
502
+ | | Array restrictions |
503
+ | -------------------- | ------------------ |
504
+ | **Min items** | N/A |
505
+ | **Max items** | N/A |
506
+ | **Items unicity** | False |
507
+ | **Additional items** | False |
508
+ | **Tuple validation** | See below |
509
+
510
+ | Each item of this array must be | Description |
511
+ | --------------------------------------------------------------------------------- | ----------- |
512
+ | [install items](#pipelines_additionalProperties_postDeployValidate_install_items) | - |
513
+
514
+ ###### <a name="autogenerated_heading_14"></a>9.1.7.2.1. root > pipelines > additionalProperties > postDeployValidate > install > install items
515
+
516
+ | | |
517
+ | ------------ | -------- |
518
+ | **Type** | `string` |
519
+ | **Required** | No |
520
+
521
+ #### <a name="pipelines_additionalProperties_pre"></a>9.1.8. Property `root > pipelines > additionalProperties > pre`
522
+
523
+ | | |
524
+ | ------------ | ----------------- |
525
+ | **Type** | `array of string` |
526
+ | **Required** | No |
527
+
528
+ | | Array restrictions |
529
+ | -------------------- | ------------------ |
530
+ | **Min items** | N/A |
531
+ | **Max items** | N/A |
532
+ | **Items unicity** | False |
533
+ | **Additional items** | False |
534
+ | **Tuple validation** | See below |
535
+
536
+ | Each item of this array must be | Description |
537
+ | ------------------------------------------------------ | ----------- |
538
+ | [pre items](#pipelines_additionalProperties_pre_items) | - |
539
+
540
+ ##### <a name="autogenerated_heading_15"></a>9.1.8.1. root > pipelines > additionalProperties > pre > pre items
541
+
542
+ | | |
543
+ | ------------ | -------- |
544
+ | **Type** | `string` |
545
+ | **Required** | No |
546
+
547
+ #### <a name="pipelines_additionalProperties_preDeploy"></a>9.1.9. Property `root > pipelines > additionalProperties > preDeploy`
548
+
549
+ | | |
550
+ | ------------------------- | ------------------------------------------------------- |
551
+ | **Type** | `object` |
552
+ | **Required** | No |
553
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
554
+ | **Same definition as** | [deploy](#deploy) |
555
+
556
+ #### <a name="pipelines_additionalProperties_preDeployValidate"></a>9.1.10. Property `root > pipelines > additionalProperties > preDeployValidate`
557
+
558
+ | | |
559
+ | ------------------------- | ------------------------------------------------------------------------ |
560
+ | **Type** | `object` |
561
+ | **Required** | No |
562
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
563
+ | **Same definition as** | [postDeployValidate](#pipelines_additionalProperties_postDeployValidate) |
564
+
565
+ ## <a name="post"></a>10. Property `root > post`
566
+
567
+ | | |
568
+ | ------------ | ----------------- |
569
+ | **Type** | `array of string` |
570
+ | **Required** | No |
571
+
572
+ | | Array restrictions |
573
+ | -------------------- | ------------------ |
574
+ | **Min items** | N/A |
575
+ | **Max items** | N/A |
576
+ | **Items unicity** | False |
577
+ | **Additional items** | False |
578
+ | **Tuple validation** | See below |
579
+
580
+ | Each item of this array must be | Description |
581
+ | ------------------------------- | ----------- |
582
+ | [post items](#post_items) | - |
583
+
584
+ ### <a name="autogenerated_heading_16"></a>10.1. root > post > post items
585
+
586
+ | | |
587
+ | ------------ | -------- |
588
+ | **Type** | `string` |
589
+ | **Required** | No |
590
+
591
+ ## <a name="postDeployValidate"></a>11. Property `root > postDeployValidate`
592
+
593
+ | | |
594
+ | ------------------------- | ------------------------------------------------------------------------ |
595
+ | **Type** | `object` |
596
+ | **Required** | No |
597
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
598
+ | **Same definition as** | [postDeployValidate](#pipelines_additionalProperties_postDeployValidate) |
599
+
600
+ ## <a name="pre"></a>12. Property `root > pre`
601
+
602
+ | | |
603
+ | ------------ | ----------------- |
604
+ | **Type** | `array of string` |
605
+ | **Required** | No |
606
+
607
+ | | Array restrictions |
608
+ | -------------------- | ------------------ |
609
+ | **Min items** | N/A |
610
+ | **Max items** | N/A |
611
+ | **Items unicity** | False |
612
+ | **Additional items** | False |
613
+ | **Tuple validation** | See below |
614
+
615
+ | Each item of this array must be | Description |
616
+ | ------------------------------- | ----------- |
617
+ | [pre items](#pre_items) | - |
618
+
619
+ ### <a name="autogenerated_heading_17"></a>12.1. root > pre > pre items
620
+
621
+ | | |
622
+ | ------------ | -------- |
623
+ | **Type** | `string` |
624
+ | **Required** | No |
625
+
626
+ ## <a name="preDeploy"></a>13. Property `root > preDeploy`
627
+
628
+ | | |
629
+ | ------------------------- | ------------------------------------------------------- |
630
+ | **Type** | `object` |
631
+ | **Required** | No |
632
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
633
+ | **Same definition as** | [deploy](#deploy) |
634
+
635
+ ## <a name="preDeployValidate"></a>14. Property `root > preDeployValidate`
636
+
637
+ | | |
638
+ | ------------------------- | ------------------------------------------------------------------------ |
639
+ | **Type** | `object` |
640
+ | **Required** | No |
641
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
642
+ | **Same definition as** | [postDeployValidate](#pipelines_additionalProperties_postDeployValidate) |
643
+
644
+ ## <a name="service_catalog_product_config"></a>15. Property `root > service_catalog_product_config`
645
+
646
+ | | |
647
+ | ------------------------- | ------------------------------------------------------- |
648
+ | **Type** | `object` |
649
+ | **Required** | No |
650
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
651
+ | **Defined in** | #/definitions/MdaaServiceCatalogProductConfig |
652
+
653
+ **Description:** Service Catalog Config
654
+ If specified, the configured module will be deployed as a Service Catalog product instead of directly to the environment
655
+
656
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
657
+ | ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
658
+ | - [launch_role_name](#service_catalog_product_config_launch_role_name ) | No | string | No | - | - |
659
+ | + [name](#service_catalog_product_config_name ) | No | string | No | - | - |
660
+ | + [owner](#service_catalog_product_config_owner ) | No | string | No | - | - |
661
+ | - [parameters](#service_catalog_product_config_parameters ) | No | object | No | - | - |
662
+ | + [portfolio_arn](#service_catalog_product_config_portfolio_arn ) | No | string | No | - | - |
663
+
664
+ ### <a name="service_catalog_product_config_launch_role_name"></a>15.1. Property `root > service_catalog_product_config > launch_role_name`
665
+
666
+ | | |
667
+ | ------------ | -------- |
668
+ | **Type** | `string` |
669
+ | **Required** | No |
670
+
671
+ ### <a name="service_catalog_product_config_name"></a>15.2. Property `root > service_catalog_product_config > name`
672
+
673
+ | | |
674
+ | ------------ | -------- |
675
+ | **Type** | `string` |
676
+ | **Required** | Yes |
677
+
678
+ ### <a name="service_catalog_product_config_owner"></a>15.3. Property `root > service_catalog_product_config > owner`
679
+
680
+ | | |
681
+ | ------------ | -------- |
682
+ | **Type** | `string` |
683
+ | **Required** | Yes |
684
+
685
+ ### <a name="service_catalog_product_config_parameters"></a>15.4. Property `root > service_catalog_product_config > parameters`
686
+
687
+ | | |
688
+ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
689
+ | **Type** | `object` |
690
+ | **Required** | No |
691
+ | **Additional properties** | [[Should-conform]](#service_catalog_product_config_parameters_additionalProperties "Each additional property must conform to the following schema") |
692
+
693
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
694
+ | ---------------------------------------------------------------------- | ------- | ------ | ---------- | -------------------------------------------------- | ----------------- |
695
+ | - [](#service_catalog_product_config_parameters_additionalProperties ) | No | object | No | In #/definitions/MdaaServiceCatalogParameterConfig | - |
696
+
697
+ #### <a name="service_catalog_product_config_parameters_additionalProperties"></a>15.4.1. Property `root > service_catalog_product_config > parameters > MdaaServiceCatalogParameterConfig`
698
+
699
+ | | |
700
+ | ------------------------- | ------------------------------------------------------- |
701
+ | **Type** | `object` |
702
+ | **Required** | No |
703
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
704
+ | **Defined in** | #/definitions/MdaaServiceCatalogParameterConfig |
705
+
706
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
707
+ | --------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------------- | ----------------- |
708
+ | - [constraints](#service_catalog_product_config_parameters_additionalProperties_constraints ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintConfig | - |
709
+ | + [props](#service_catalog_product_config_parameters_additionalProperties_props ) | No | object | No | In #/definitions/CfnParameterProps | - |
710
+
711
+ ##### <a name="service_catalog_product_config_parameters_additionalProperties_constraints"></a>15.4.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints`
712
+
713
+ | | |
714
+ | ------------------------- | ------------------------------------------------------- |
715
+ | **Type** | `object` |
716
+ | **Required** | No |
717
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
718
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintConfig |
719
+
720
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
721
+ | --------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
722
+ | + [description](#service_catalog_product_config_parameters_additionalProperties_constraints_description ) | No | string | No | - | - |
723
+ | + [rules](#service_catalog_product_config_parameters_additionalProperties_constraints_rules ) | No | object | No | - | - |
724
+
725
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_description"></a>15.4.1.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > description`
726
+
727
+ | | |
728
+ | ------------ | -------- |
729
+ | **Type** | `string` |
730
+ | **Required** | Yes |
731
+
732
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules"></a>15.4.1.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules`
733
+
734
+ | | |
735
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
736
+ | **Type** | `object` |
737
+ | **Required** | Yes |
738
+ | **Additional properties** | [[Should-conform]](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties "Each additional property must conform to the following schema") |
739
+
740
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
741
+ | ------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------- | ----------------- |
742
+ | - [](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleConfig | - |
743
+
744
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties"></a>15.4.1.1.2.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > MdaaServiceCatalogConstraintRuleConfig`
745
+
746
+ | | |
747
+ | ------------------------- | ------------------------------------------------------- |
748
+ | **Type** | `object` |
749
+ | **Required** | No |
750
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
751
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleConfig |
752
+
753
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
754
+ | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------ | ----------------- |
755
+ | + [assertions](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions ) | No | array | No | - | - |
756
+ | + [condition](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_condition ) | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig | - |
757
+
758
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions"></a>15.4.1.1.2.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions`
759
+
760
+ | | |
761
+ | ------------ | ------- |
762
+ | **Type** | `array` |
763
+ | **Required** | Yes |
764
+
765
+ | | Array restrictions |
766
+ | -------------------- | ------------------ |
767
+ | **Min items** | N/A |
768
+ | **Max items** | N/A |
769
+ | **Items unicity** | False |
770
+ | **Additional items** | False |
771
+ | **Tuple validation** | See below |
772
+
773
+ | Each item of this array must be | Description |
774
+ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
775
+ | [MdaaServiceCatalogConstraintRuleAssertionConfig](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items) | - |
776
+
777
+ ###### <a name="autogenerated_heading_18"></a>15.4.1.1.2.1.1.1. root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > MdaaServiceCatalogConstraintRuleAssertionConfig
778
+
779
+ | | |
780
+ | ------------------------- | ------------------------------------------------------------- |
781
+ | **Type** | `object` |
782
+ | **Required** | No |
783
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
784
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleAssertionConfig |
785
+
786
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
787
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
788
+ | + [assert](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_assert ) | No | string | No | - | - |
789
+ | + [description](#service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_description ) | No | string | No | - | - |
790
+
791
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_assert"></a>15.4.1.1.2.1.1.1.1. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > assert`
792
+
793
+ | | |
794
+ | ------------ | -------- |
795
+ | **Type** | `string` |
796
+ | **Required** | Yes |
797
+
798
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_assertions_items_description"></a>15.4.1.1.2.1.1.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > description`
799
+
800
+ | | |
801
+ | ------------ | -------- |
802
+ | **Type** | `string` |
803
+ | **Required** | Yes |
804
+
805
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_constraints_rules_additionalProperties_condition"></a>15.4.1.1.2.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > condition`
806
+
807
+ | | |
808
+ | ------------------------- | ------------------------------------------------------------------------- |
809
+ | **Type** | `object` |
810
+ | **Required** | Yes |
811
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
812
+ | **Defined in** | #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig |
813
+
814
+ ##### <a name="service_catalog_product_config_parameters_additionalProperties_props"></a>15.4.1.2. Property `root > service_catalog_product_config > parameters > additionalProperties > props`
815
+
816
+ | | |
817
+ | ------------------------- | ------------------------------------------------------- |
818
+ | **Type** | `object` |
819
+ | **Required** | Yes |
820
+ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
821
+ | **Defined in** | #/definitions/CfnParameterProps |
822
+
823
+ | Property | Pattern | Type | Deprecated | Definition | Title/Description |
824
+ | ----------------------------------------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
825
+ | - [allowedPattern](#service_catalog_product_config_parameters_additionalProperties_props_allowedPattern ) | No | string | No | - | A regular expression that represents the patterns to allow for String types. |
826
+ | - [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. |
827
+ | - [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: |
828
+ | - [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. |
829
+ | - [description](#service_catalog_product_config_parameters_additionalProperties_props_description ) | No | string | No | - | A string of up to 4000 characters that describes the parameter. |
830
+ | - [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. |
831
+ | - [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. |
832
+ | - [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. |
833
+ | - [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. |
834
+ | - [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 (\`\`*****\`\`). |
835
+ | - [type](#service_catalog_product_config_parameters_additionalProperties_props_type ) | No | string | No | - | The data type for the parameter (DataType). |
836
+
837
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_allowedPattern"></a>15.4.1.2.1. Property `root > service_catalog_product_config > parameters > additionalProperties > props > allowedPattern`
838
+
839
+ | | |
840
+ | ------------ | ------------------------------------------------------- |
841
+ | **Type** | `string` |
842
+ | **Required** | No |
843
+ | **Default** | `"- No constraints on patterns allowed for parameter."` |
844
+
845
+ **Description:** A regular expression that represents the patterns to allow for String types.
846
+
847
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_allowedValues"></a>15.4.1.2.2. Property `root > service_catalog_product_config > parameters > additionalProperties > props > allowedValues`
848
+
849
+ | | |
850
+ | ------------ | ----------------------------------------------------- |
851
+ | **Type** | `array of string` |
852
+ | **Required** | No |
853
+ | **Default** | `"- No constraints on values allowed for parameter."` |
854
+
855
+ **Description:** An array containing the list of values allowed for the parameter.
856
+
857
+ | | Array restrictions |
858
+ | -------------------- | ------------------ |
859
+ | **Min items** | N/A |
860
+ | **Max items** | N/A |
861
+ | **Items unicity** | False |
862
+ | **Additional items** | False |
863
+ | **Tuple validation** | See below |
864
+
865
+ | Each item of this array must be | Description |
866
+ | ---------------------------------------------------------------------------------------------------------------- | ----------- |
867
+ | [allowedValues items](#service_catalog_product_config_parameters_additionalProperties_props_allowedValues_items) | - |
868
+
869
+ ###### <a name="autogenerated_heading_19"></a>15.4.1.2.2.1. root > service_catalog_product_config > parameters > additionalProperties > props > allowedValues > allowedValues items
870
+
871
+ | | |
872
+ | ------------ | -------- |
873
+ | **Type** | `string` |
874
+ | **Required** | No |
875
+
876
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_constraintDescription"></a>15.4.1.2.3. Property `root > service_catalog_product_config > parameters > additionalProperties > props > constraintDescription`
877
+
878
+ | | |
879
+ | ------------ | -------------------------------------------------------------------------------------- |
880
+ | **Type** | `string` |
881
+ | **Required** | No |
882
+ | **Default** | `"- No description with customized error message when user specifies invalid values."` |
883
+
884
+ **Description:** A string that explains a constraint when the constraint is violated.
885
+ For example, without a constraint description, a parameter that has an allowed
886
+ pattern of [A-Za-z0-9]+ displays the following error message when the user specifies
887
+ an invalid value:
888
+
889
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_default"></a>15.4.1.2.4. Property `root > service_catalog_product_config > parameters > additionalProperties > props > default`
890
+
891
+ | | |
892
+ | ------------------------- | ------------------------------------------------------------------------- |
893
+ | **Type** | `object` |
894
+ | **Required** | No |
895
+ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
896
+ | **Default** | `"- No default value for parameter."` |
897
+
898
+ **Description:** A value of the appropriate type for the template to use if no value is specified
899
+ when a stack is created. If you define constraints for the parameter, you must specify
900
+ a value that adheres to those constraints.
901
+
902
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_description"></a>15.4.1.2.5. Property `root > service_catalog_product_config > parameters > additionalProperties > props > description`
903
+
904
+ | | |
905
+ | ------------ | --------------------------------------- |
906
+ | **Type** | `string` |
907
+ | **Required** | No |
908
+ | **Default** | `"- No description for the parameter."` |
909
+
910
+ **Description:** A string of up to 4000 characters that describes the parameter.
911
+
912
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_maxLength"></a>15.4.1.2.6. Property `root > service_catalog_product_config > parameters > additionalProperties > props > maxLength`
913
+
914
+ | | |
915
+ | ------------ | ----------- |
916
+ | **Type** | `number` |
917
+ | **Required** | No |
918
+ | **Default** | `"- None."` |
919
+
920
+ **Description:** An integer value that determines the largest number of characters you want to allow for String types.
921
+
922
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_maxValue"></a>15.4.1.2.7. Property `root > service_catalog_product_config > parameters > additionalProperties > props > maxValue`
923
+
924
+ | | |
925
+ | ------------ | ----------- |
926
+ | **Type** | `number` |
927
+ | **Required** | No |
928
+ | **Default** | `"- None."` |
929
+
930
+ **Description:** A numeric value that determines the largest numeric value you want to allow for Number types.
931
+
932
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_minLength"></a>15.4.1.2.8. Property `root > service_catalog_product_config > parameters > additionalProperties > props > minLength`
933
+
934
+ | | |
935
+ | ------------ | ----------- |
936
+ | **Type** | `number` |
937
+ | **Required** | No |
938
+ | **Default** | `"- None."` |
939
+
940
+ **Description:** An integer value that determines the smallest number of characters you want to allow for String types.
941
+
942
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_minValue"></a>15.4.1.2.9. Property `root > service_catalog_product_config > parameters > additionalProperties > props > minValue`
943
+
944
+ | | |
945
+ | ------------ | ----------- |
946
+ | **Type** | `number` |
947
+ | **Required** | No |
948
+ | **Default** | `"- None."` |
949
+
950
+ **Description:** A numeric value that determines the smallest numeric value you want to allow for Number types.
951
+
952
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_noEcho"></a>15.4.1.2.10. Property `root > service_catalog_product_config > parameters > additionalProperties > props > noEcho`
953
+
954
+ | | |
955
+ | ------------ | -------------------------------------- |
956
+ | **Type** | `boolean` |
957
+ | **Required** | No |
958
+ | **Default** | `"- Parameter values are not masked."` |
959
+
960
+ **Description:** Whether to mask the parameter value when anyone makes a call that describes the stack.
961
+ If you set the value to ``true``, the parameter value is masked with asterisks (``*****``).
962
+
963
+ ###### <a name="service_catalog_product_config_parameters_additionalProperties_props_type"></a>15.4.1.2.11. Property `root > service_catalog_product_config > parameters > additionalProperties > props > type`
964
+
965
+ | | |
966
+ | ------------ | ---------- |
967
+ | **Type** | `string` |
968
+ | **Required** | No |
969
+ | **Default** | `"String"` |
970
+
971
+ **Description:** The data type for the parameter (DataType).
972
+
973
+ ### <a name="service_catalog_product_config_portfolio_arn"></a>15.5. Property `root > service_catalog_product_config > portfolio_arn`
974
+
975
+ | | |
976
+ | ------------ | -------- |
977
+ | **Type** | `string` |
978
+ | **Required** | Yes |
979
+
980
+ ----------------------------------------------------------------------------------------------------------------------------
981
+ Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-08-16 at 13:40:39 -0400