cloudformation.d.ts
258 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CloudFormation extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CloudFormation.Types.ClientConfiguration)
config: Config & CloudFormation.Types.ClientConfiguration;
/**
* Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
*/
cancelUpdateStack(params: CloudFormation.Types.CancelUpdateStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
*/
cancelUpdateStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
*/
continueUpdateRollback(params: CloudFormation.Types.ContinueUpdateRollbackInput, callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request<CloudFormation.Types.ContinueUpdateRollbackOutput, AWSError>;
/**
* For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again. A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
*/
continueUpdateRollback(callback?: (err: AWSError, data: CloudFormation.Types.ContinueUpdateRollbackOutput) => void): Request<CloudFormation.Types.ContinueUpdateRollbackOutput, AWSError>;
/**
* Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
*/
createChangeSet(params: CloudFormation.Types.CreateChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request<CloudFormation.Types.CreateChangeSetOutput, AWSError>;
/**
* Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack. To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action. When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
*/
createChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateChangeSetOutput) => void): Request<CloudFormation.Types.CreateChangeSetOutput, AWSError>;
/**
* Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
*/
createStack(params: CloudFormation.Types.CreateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request<CloudFormation.Types.CreateStackOutput, AWSError>;
/**
* Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
*/
createStack(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackOutput) => void): Request<CloudFormation.Types.CreateStackOutput, AWSError>;
/**
* Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
*/
createStackInstances(params: CloudFormation.Types.CreateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackInstancesOutput) => void): Request<CloudFormation.Types.CreateStackInstancesOutput, AWSError>;
/**
* Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
*/
createStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackInstancesOutput) => void): Request<CloudFormation.Types.CreateStackInstancesOutput, AWSError>;
/**
* Creates a stack set.
*/
createStackSet(params: CloudFormation.Types.CreateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.CreateStackSetOutput) => void): Request<CloudFormation.Types.CreateStackSetOutput, AWSError>;
/**
* Creates a stack set.
*/
createStackSet(callback?: (err: AWSError, data: CloudFormation.Types.CreateStackSetOutput) => void): Request<CloudFormation.Types.CreateStackSetOutput, AWSError>;
/**
* Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set.
*/
deleteChangeSet(params: CloudFormation.Types.DeleteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request<CloudFormation.Types.DeleteChangeSetOutput, AWSError>;
/**
* Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, AWS CloudFormation successfully deleted the change set.
*/
deleteChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteChangeSetOutput) => void): Request<CloudFormation.Types.DeleteChangeSetOutput, AWSError>;
/**
* Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
*/
deleteStack(params: CloudFormation.Types.DeleteStackInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
*/
deleteStack(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes stack instances for the specified accounts, in the specified Regions.
*/
deleteStackInstances(params: CloudFormation.Types.DeleteStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackInstancesOutput) => void): Request<CloudFormation.Types.DeleteStackInstancesOutput, AWSError>;
/**
* Deletes stack instances for the specified accounts, in the specified Regions.
*/
deleteStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackInstancesOutput) => void): Request<CloudFormation.Types.DeleteStackInstancesOutput, AWSError>;
/**
* Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
*/
deleteStackSet(params: CloudFormation.Types.DeleteStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackSetOutput) => void): Request<CloudFormation.Types.DeleteStackSetOutput, AWSError>;
/**
* Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
*/
deleteStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DeleteStackSetOutput) => void): Request<CloudFormation.Types.DeleteStackSetOutput, AWSError>;
/**
* Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations. To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered. You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well.
*/
deregisterType(params: CloudFormation.Types.DeregisterTypeInput, callback?: (err: AWSError, data: CloudFormation.Types.DeregisterTypeOutput) => void): Request<CloudFormation.Types.DeregisterTypeOutput, AWSError>;
/**
* Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations. To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered. You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well.
*/
deregisterType(callback?: (err: AWSError, data: CloudFormation.Types.DeregisterTypeOutput) => void): Request<CloudFormation.Types.DeregisterTypeOutput, AWSError>;
/**
* Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
*/
describeAccountLimits(params: CloudFormation.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>;
/**
* Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
*/
describeAccountLimits(callback?: (err: AWSError, data: CloudFormation.Types.DescribeAccountLimitsOutput) => void): Request<CloudFormation.Types.DescribeAccountLimitsOutput, AWSError>;
/**
* Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
*/
describeChangeSet(params: CloudFormation.Types.DescribeChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
/**
* Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
*/
describeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
/**
* Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
*/
describeStackDriftDetectionStatus(params: CloudFormation.Types.DescribeStackDriftDetectionStatusInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request<CloudFormation.Types.DescribeStackDriftDetectionStatusOutput, AWSError>;
/**
* Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
*/
describeStackDriftDetectionStatus(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackDriftDetectionStatusOutput) => void): Request<CloudFormation.Types.DescribeStackDriftDetectionStatusOutput, AWSError>;
/**
* Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
*/
describeStackEvents(params: CloudFormation.Types.DescribeStackEventsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>;
/**
* Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
*/
describeStackEvents(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackEventsOutput) => void): Request<CloudFormation.Types.DescribeStackEventsOutput, AWSError>;
/**
* Returns the stack instance that's associated with the specified stack set, AWS account, and Region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
*/
describeStackInstance(params: CloudFormation.Types.DescribeStackInstanceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request<CloudFormation.Types.DescribeStackInstanceOutput, AWSError>;
/**
* Returns the stack instance that's associated with the specified stack set, AWS account, and Region. For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
*/
describeStackInstance(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackInstanceOutput) => void): Request<CloudFormation.Types.DescribeStackInstanceOutput, AWSError>;
/**
* Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
*/
describeStackResource(params: CloudFormation.Types.DescribeStackResourceInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>;
/**
* Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
*/
describeStackResource(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceOutput) => void): Request<CloudFormation.Types.DescribeStackResourceOutput, AWSError>;
/**
* Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
*/
describeStackResourceDrifts(params: CloudFormation.Types.DescribeStackResourceDriftsInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request<CloudFormation.Types.DescribeStackResourceDriftsOutput, AWSError>;
/**
* Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
*/
describeStackResourceDrifts(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourceDriftsOutput) => void): Request<CloudFormation.Types.DescribeStackResourceDriftsOutput, AWSError>;
/**
* Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
*/
describeStackResources(params: CloudFormation.Types.DescribeStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>;
/**
* Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned. Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead. For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted. You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide. A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
*/
describeStackResources(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackResourcesOutput) => void): Request<CloudFormation.Types.DescribeStackResourcesOutput, AWSError>;
/**
* Returns the description of the specified stack set.
*/
describeStackSet(params: CloudFormation.Types.DescribeStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request<CloudFormation.Types.DescribeStackSetOutput, AWSError>;
/**
* Returns the description of the specified stack set.
*/
describeStackSet(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOutput) => void): Request<CloudFormation.Types.DescribeStackSetOutput, AWSError>;
/**
* Returns the description of the specified stack set operation.
*/
describeStackSetOperation(params: CloudFormation.Types.DescribeStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request<CloudFormation.Types.DescribeStackSetOperationOutput, AWSError>;
/**
* Returns the description of the specified stack set operation.
*/
describeStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStackSetOperationOutput) => void): Request<CloudFormation.Types.DescribeStackSetOperationOutput, AWSError>;
/**
* Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an AmazonCloudFormationException is returned.
*/
describeStacks(params: CloudFormation.Types.DescribeStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. If the stack does not exist, an AmazonCloudFormationException is returned.
*/
describeStacks(callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Returns detailed information about a type that has been registered. If you specify a VersionId, DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.
*/
describeType(params: CloudFormation.Types.DescribeTypeInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeOutput) => void): Request<CloudFormation.Types.DescribeTypeOutput, AWSError>;
/**
* Returns detailed information about a type that has been registered. If you specify a VersionId, DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.
*/
describeType(callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeOutput) => void): Request<CloudFormation.Types.DescribeTypeOutput, AWSError>;
/**
* Returns information about a type's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed informaiton about a type.
*/
describeTypeRegistration(params: CloudFormation.Types.DescribeTypeRegistrationInput, callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
/**
* Returns information about a type's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType , you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed informaiton about a type.
*/
describeTypeRegistration(callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
/**
* Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
*/
detectStackDrift(params: CloudFormation.Types.DetectStackDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request<CloudFormation.Types.DetectStackDriftOutput, AWSError>;
/**
* Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources. For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection. DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources. When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
*/
detectStackDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackDriftOutput) => void): Request<CloudFormation.Types.DetectStackDriftOutput, AWSError>;
/**
* Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
*/
detectStackResourceDrift(params: CloudFormation.Types.DetectStackResourceDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request<CloudFormation.Types.DetectStackResourceDriftOutput, AWSError>;
/**
* Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources. Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection. Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
*/
detectStackResourceDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackResourceDriftOutput) => void): Request<CloudFormation.Types.DetectStackResourceDriftOutput, AWSError>;
/**
* Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set. DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed informaiton about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.) Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance. Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked. For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets. You can only run a single drift detection operation on a given stack set at one time. To stop a drift detection stack set operation, use StopStackSetOperation .
*/
detectStackSetDrift(params: CloudFormation.Types.DetectStackSetDriftInput, callback?: (err: AWSError, data: CloudFormation.Types.DetectStackSetDriftOutput) => void): Request<CloudFormation.Types.DetectStackSetDriftOutput, AWSError>;
/**
* Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set. DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information: Use DescribeStackSet to return detailed informaiton about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.) Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance. Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked. For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets. You can only run a single drift detection operation on a given stack set at one time. To stop a drift detection stack set operation, use StopStackSetOperation .
*/
detectStackSetDrift(callback?: (err: AWSError, data: CloudFormation.Types.DetectStackSetDriftOutput) => void): Request<CloudFormation.Types.DetectStackSetDriftOutput, AWSError>;
/**
* Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
*/
estimateTemplateCost(params: CloudFormation.Types.EstimateTemplateCostInput, callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>;
/**
* Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
*/
estimateTemplateCost(callback?: (err: AWSError, data: CloudFormation.Types.EstimateTemplateCostOutput) => void): Request<CloudFormation.Types.EstimateTemplateCostOutput, AWSError>;
/**
* Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
*/
executeChangeSet(params: CloudFormation.Types.ExecuteChangeSetInput, callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>;
/**
* Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update. When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
*/
executeChangeSet(callback?: (err: AWSError, data: CloudFormation.Types.ExecuteChangeSetOutput) => void): Request<CloudFormation.Types.ExecuteChangeSetOutput, AWSError>;
/**
* Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
*/
getStackPolicy(params: CloudFormation.Types.GetStackPolicyInput, callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>;
/**
* Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
*/
getStackPolicy(callback?: (err: AWSError, data: CloudFormation.Types.GetStackPolicyOutput) => void): Request<CloudFormation.Types.GetStackPolicyOutput, AWSError>;
/**
* Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
*/
getTemplate(params: CloudFormation.Types.GetTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>;
/**
* Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
*/
getTemplate(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateOutput) => void): Request<CloudFormation.Types.GetTemplateOutput, AWSError>;
/**
* Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
*/
getTemplateSummary(params: CloudFormation.Types.GetTemplateSummaryInput, callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>;
/**
* Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
*/
getTemplateSummary(callback?: (err: AWSError, data: CloudFormation.Types.GetTemplateSummaryOutput) => void): Request<CloudFormation.Types.GetTemplateSummaryOutput, AWSError>;
/**
* Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
*/
listChangeSets(params: CloudFormation.Types.ListChangeSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>;
/**
* Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
*/
listChangeSets(callback?: (err: AWSError, data: CloudFormation.Types.ListChangeSetsOutput) => void): Request<CloudFormation.Types.ListChangeSetsOutput, AWSError>;
/**
* Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see AWS CloudFormation Export Stack Output Values.
*/
listExports(params: CloudFormation.Types.ListExportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>;
/**
* Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function. For more information, see AWS CloudFormation Export Stack Output Values.
*/
listExports(callback?: (err: AWSError, data: CloudFormation.Types.ListExportsOutput) => void): Request<CloudFormation.Types.ListExportsOutput, AWSError>;
/**
* Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function.
*/
listImports(params: CloudFormation.Types.ListImportsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>;
/**
* Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports. For more information about importing an exported output value, see the Fn::ImportValue function.
*/
listImports(callback?: (err: AWSError, data: CloudFormation.Types.ListImportsOutput) => void): Request<CloudFormation.Types.ListImportsOutput, AWSError>;
/**
* Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.
*/
listStackInstances(params: CloudFormation.Types.ListStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request<CloudFormation.Types.ListStackInstancesOutput, AWSError>;
/**
* Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.
*/
listStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.ListStackInstancesOutput) => void): Request<CloudFormation.Types.ListStackInstancesOutput, AWSError>;
/**
* Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
*/
listStackResources(params: CloudFormation.Types.ListStackResourcesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>;
/**
* Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
*/
listStackResources(callback?: (err: AWSError, data: CloudFormation.Types.ListStackResourcesOutput) => void): Request<CloudFormation.Types.ListStackResourcesOutput, AWSError>;
/**
* Returns summary information about the results of a stack set operation.
*/
listStackSetOperationResults(params: CloudFormation.Types.ListStackSetOperationResultsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationResultsOutput, AWSError>;
/**
* Returns summary information about the results of a stack set operation.
*/
listStackSetOperationResults(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationResultsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationResultsOutput, AWSError>;
/**
* Returns summary information about operations performed on a stack set.
*/
listStackSetOperations(params: CloudFormation.Types.ListStackSetOperationsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationsOutput, AWSError>;
/**
* Returns summary information about operations performed on a stack set.
*/
listStackSetOperations(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetOperationsOutput) => void): Request<CloudFormation.Types.ListStackSetOperationsOutput, AWSError>;
/**
* Returns summary information about stack sets that are associated with the user.
*/
listStackSets(params: CloudFormation.Types.ListStackSetsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request<CloudFormation.Types.ListStackSetsOutput, AWSError>;
/**
* Returns summary information about stack sets that are associated with the user.
*/
listStackSets(callback?: (err: AWSError, data: CloudFormation.Types.ListStackSetsOutput) => void): Request<CloudFormation.Types.ListStackSetsOutput, AWSError>;
/**
* Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
*/
listStacks(params: CloudFormation.Types.ListStacksInput, callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>;
/**
* Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
*/
listStacks(callback?: (err: AWSError, data: CloudFormation.Types.ListStacksOutput) => void): Request<CloudFormation.Types.ListStacksOutput, AWSError>;
/**
* Returns a list of registration tokens for the specified type(s).
*/
listTypeRegistrations(params: CloudFormation.Types.ListTypeRegistrationsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListTypeRegistrationsOutput) => void): Request<CloudFormation.Types.ListTypeRegistrationsOutput, AWSError>;
/**
* Returns a list of registration tokens for the specified type(s).
*/
listTypeRegistrations(callback?: (err: AWSError, data: CloudFormation.Types.ListTypeRegistrationsOutput) => void): Request<CloudFormation.Types.ListTypeRegistrationsOutput, AWSError>;
/**
* Returns summary information about the versions of a type.
*/
listTypeVersions(params: CloudFormation.Types.ListTypeVersionsInput, callback?: (err: AWSError, data: CloudFormation.Types.ListTypeVersionsOutput) => void): Request<CloudFormation.Types.ListTypeVersionsOutput, AWSError>;
/**
* Returns summary information about the versions of a type.
*/
listTypeVersions(callback?: (err: AWSError, data: CloudFormation.Types.ListTypeVersionsOutput) => void): Request<CloudFormation.Types.ListTypeVersionsOutput, AWSError>;
/**
* Returns summary information about types that have been registered with CloudFormation.
*/
listTypes(params: CloudFormation.Types.ListTypesInput, callback?: (err: AWSError, data: CloudFormation.Types.ListTypesOutput) => void): Request<CloudFormation.Types.ListTypesOutput, AWSError>;
/**
* Returns summary information about types that have been registered with CloudFormation.
*/
listTypes(callback?: (err: AWSError, data: CloudFormation.Types.ListTypesOutput) => void): Request<CloudFormation.Types.ListTypesOutput, AWSError>;
/**
* Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI. Do not use this API in your code.
*/
recordHandlerProgress(params: CloudFormation.Types.RecordHandlerProgressInput, callback?: (err: AWSError, data: CloudFormation.Types.RecordHandlerProgressOutput) => void): Request<CloudFormation.Types.RecordHandlerProgressOutput, AWSError>;
/**
* Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI. Do not use this API in your code.
*/
recordHandlerProgress(callback?: (err: AWSError, data: CloudFormation.Types.RecordHandlerProgressOutput) => void): Request<CloudFormation.Types.RecordHandlerProgressOutput, AWSError>;
/**
* Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes: Validating the resource schema Determining which handlers have been specified for the resource Making the resource type available for use in your account For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide. You can have a maximum of 50 resource type versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific resource type versions if necessary. Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.
*/
registerType(params: CloudFormation.Types.RegisterTypeInput, callback?: (err: AWSError, data: CloudFormation.Types.RegisterTypeOutput) => void): Request<CloudFormation.Types.RegisterTypeOutput, AWSError>;
/**
* Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes: Validating the resource schema Determining which handlers have been specified for the resource Making the resource type available for use in your account For more information on how to develop types and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide. You can have a maximum of 50 resource type versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific resource type versions if necessary. Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.
*/
registerType(callback?: (err: AWSError, data: CloudFormation.Types.RegisterTypeOutput) => void): Request<CloudFormation.Types.RegisterTypeOutput, AWSError>;
/**
* Sets a stack policy for a specified stack.
*/
setStackPolicy(params: CloudFormation.Types.SetStackPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets a stack policy for a specified stack.
*/
setStackPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Specify the default version of a type. The default version of a type will be used in CloudFormation operations.
*/
setTypeDefaultVersion(params: CloudFormation.Types.SetTypeDefaultVersionInput, callback?: (err: AWSError, data: CloudFormation.Types.SetTypeDefaultVersionOutput) => void): Request<CloudFormation.Types.SetTypeDefaultVersionOutput, AWSError>;
/**
* Specify the default version of a type. The default version of a type will be used in CloudFormation operations.
*/
setTypeDefaultVersion(callback?: (err: AWSError, data: CloudFormation.Types.SetTypeDefaultVersionOutput) => void): Request<CloudFormation.Types.SetTypeDefaultVersionOutput, AWSError>;
/**
* Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
*/
signalResource(params: CloudFormation.Types.SignalResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
*/
signalResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Stops an in-progress operation on a stack set and its associated stack instances.
*/
stopStackSetOperation(params: CloudFormation.Types.StopStackSetOperationInput, callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request<CloudFormation.Types.StopStackSetOperationOutput, AWSError>;
/**
* Stops an in-progress operation on a stack set and its associated stack instances.
*/
stopStackSetOperation(callback?: (err: AWSError, data: CloudFormation.Types.StopStackSetOperationOutput) => void): Request<CloudFormation.Types.StopStackSetOperationOutput, AWSError>;
/**
* Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
*/
updateStack(params: CloudFormation.Types.UpdateStackInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>;
/**
* Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action. To get a copy of the template for an existing stack, you can use the GetTemplate action. For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
*/
updateStack(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackOutput) => void): Request<CloudFormation.Types.UpdateStackOutput, AWSError>;
/**
* Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
*/
updateStackInstances(params: CloudFormation.Types.UpdateStackInstancesInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request<CloudFormation.Types.UpdateStackInstancesOutput, AWSError>;
/**
* Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances. During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value. You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
*/
updateStackInstances(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackInstancesOutput) => void): Request<CloudFormation.Types.UpdateStackInstancesOutput, AWSError>;
/**
* Updates the stack set, and associated stack instances in the specified accounts and Regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
*/
updateStackSet(params: CloudFormation.Types.UpdateStackSetInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request<CloudFormation.Types.UpdateStackSetOutput, AWSError>;
/**
* Updates the stack set, and associated stack instances in the specified accounts and Regions. Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
*/
updateStackSet(callback?: (err: AWSError, data: CloudFormation.Types.UpdateStackSetOutput) => void): Request<CloudFormation.Types.UpdateStackSetOutput, AWSError>;
/**
* Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*/
updateTerminationProtection(params: CloudFormation.Types.UpdateTerminationProtectionInput, callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request<CloudFormation.Types.UpdateTerminationProtectionOutput, AWSError>;
/**
* Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*/
updateTerminationProtection(callback?: (err: AWSError, data: CloudFormation.Types.UpdateTerminationProtectionOutput) => void): Request<CloudFormation.Types.UpdateTerminationProtectionOutput, AWSError>;
/**
* Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
*/
validateTemplate(params: CloudFormation.Types.ValidateTemplateInput, callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>;
/**
* Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
*/
validateTemplate(callback?: (err: AWSError, data: CloudFormation.Types.ValidateTemplateOutput) => void): Request<CloudFormation.Types.ValidateTemplateOutput, AWSError>;
/**
* Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "stackExists", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackExists state by periodically calling the underlying CloudFormation.describeStacksoperation every 5 seconds (at most 20 times).
*/
waitFor(state: "stackExists", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is CREATE_COMPLETE.
*/
waitFor(state: "stackCreateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackCreateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is CREATE_COMPLETE.
*/
waitFor(state: "stackCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is DELETE_COMPLETE.
*/
waitFor(state: "stackDeleteComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackDeleteComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is DELETE_COMPLETE.
*/
waitFor(state: "stackDeleteComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_COMPLETE.
*/
waitFor(state: "stackUpdateComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackUpdateComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_COMPLETE.
*/
waitFor(state: "stackUpdateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackImportComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is IMPORT_COMPLETE.
*/
waitFor(state: "stackImportComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackImportComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is IMPORT_COMPLETE.
*/
waitFor(state: "stackImportComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackRollbackComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_ROLLBACK_COMPLETE.
*/
waitFor(state: "stackRollbackComplete", params: CloudFormation.Types.DescribeStacksInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the stackRollbackComplete state by periodically calling the underlying CloudFormation.describeStacksoperation every 30 seconds (at most 120 times). Wait until stack status is UPDATE_ROLLBACK_COMPLETE.
*/
waitFor(state: "stackRollbackComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeStacksOutput) => void): Request<CloudFormation.Types.DescribeStacksOutput, AWSError>;
/**
* Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSetoperation every 30 seconds (at most 120 times). Wait until change set status is CREATE_COMPLETE.
*/
waitFor(state: "changeSetCreateComplete", params: CloudFormation.Types.DescribeChangeSetInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
/**
* Waits for the changeSetCreateComplete state by periodically calling the underlying CloudFormation.describeChangeSetoperation every 30 seconds (at most 120 times). Wait until change set status is CREATE_COMPLETE.
*/
waitFor(state: "changeSetCreateComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeChangeSetOutput) => void): Request<CloudFormation.Types.DescribeChangeSetOutput, AWSError>;
/**
* Waits for the typeRegistrationComplete state by periodically calling the underlying CloudFormation.describeTypeRegistrationoperation every 30 seconds (at most 120 times). Wait until type registration is COMPLETE.
*/
waitFor(state: "typeRegistrationComplete", params: CloudFormation.Types.DescribeTypeRegistrationInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
/**
* Waits for the typeRegistrationComplete state by periodically calling the underlying CloudFormation.describeTypeRegistrationoperation every 30 seconds (at most 120 times). Wait until type registration is COMPLETE.
*/
waitFor(state: "typeRegistrationComplete", callback?: (err: AWSError, data: CloudFormation.Types.DescribeTypeRegistrationOutput) => void): Request<CloudFormation.Types.DescribeTypeRegistrationOutput, AWSError>;
}
declare namespace CloudFormation {
export type Account = string;
export interface AccountGateResult {
/**
* The status of the account gate function. SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and Region. FAILED: The account gate function has determined that the account and Region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED. SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons: An account gate function has not been specified for the account and Region. AWS CloudFormation proceeds with the stack set operation in this account and Region. The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and Region. Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and Region.
*/
Status?: AccountGateStatus;
/**
* The reason for the account gate status assigned to this account and Region for the stack set operation.
*/
StatusReason?: AccountGateStatusReason;
}
export type AccountGateStatus = "SUCCEEDED"|"FAILED"|"SKIPPED"|string;
export type AccountGateStatusReason = string;
export interface AccountLimit {
/**
* The name of the account limit. Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
*/
Name?: LimitName;
/**
* The value that is associated with the account limit name.
*/
Value?: LimitValue;
}
export type AccountLimitList = AccountLimit[];
export type AccountList = Account[];
export type AllowedValue = string;
export type AllowedValues = AllowedValue[];
export type Arn = string;
export interface AutoDeployment {
/**
* If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.
*/
Enabled?: AutoDeploymentNullable;
/**
* If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.
*/
RetainStacksOnAccountRemoval?: RetainStacksOnAccountRemovalNullable;
}
export type AutoDeploymentNullable = boolean;
export type BoxedInteger = number;
export type BoxedMaxResults = number;
export interface CancelUpdateStackInput {
/**
* The name or the unique stack ID that is associated with the stack.
*/
StackName: StackName;
/**
* A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them.
*/
ClientRequestToken?: ClientRequestToken;
}
export type Capabilities = Capability[];
export type CapabilitiesReason = string;
export type Capability = "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"|string;
export type CausingEntity = string;
export interface Change {
/**
* The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.
*/
Type?: ChangeType;
/**
* A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.
*/
ResourceChange?: ResourceChange;
}
export type ChangeAction = "Add"|"Modify"|"Remove"|"Import"|string;
export type ChangeSetId = string;
export type ChangeSetName = string;
export type ChangeSetNameOrId = string;
export type ChangeSetStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_COMPLETE"|"FAILED"|string;
export type ChangeSetStatusReason = string;
export type ChangeSetSummaries = ChangeSetSummary[];
export interface ChangeSetSummary {
/**
* The ID of the stack with which the change set is associated.
*/
StackId?: StackId;
/**
* The name of the stack with which the change set is associated.
*/
StackName?: StackName;
/**
* The ID of the change set.
*/
ChangeSetId?: ChangeSetId;
/**
* The name of the change set.
*/
ChangeSetName?: ChangeSetName;
/**
* If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
*/
ExecutionStatus?: ExecutionStatus;
/**
* The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
*/
Status?: ChangeSetStatus;
/**
* A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.
*/
StatusReason?: ChangeSetStatusReason;
/**
* The start time when the change set was created, in UTC.
*/
CreationTime?: CreationTime;
/**
* Descriptive information about the change set.
*/
Description?: Description;
}
export type ChangeSetType = "CREATE"|"UPDATE"|"IMPORT"|string;
export type ChangeSource = "ResourceReference"|"ParameterReference"|"ResourceAttribute"|"DirectModification"|"Automatic"|string;
export type ChangeType = "Resource"|string;
export type Changes = Change[];
export type ClientRequestToken = string;
export type ClientToken = string;
export interface ContinueUpdateRollbackInput {
/**
* The name or the unique ID of the stack that you want to continue rolling back. Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).
*/
StackName: StackNameOrId;
/**
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*/
RoleARN?: RoleARN;
/**
* A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason. Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
*/
ResourcesToSkip?: ResourcesToSkip;
/**
* A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface ContinueUpdateRollbackOutput {
}
export interface CreateChangeSetInput {
/**
* The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
*/
StackName: StackNameOrId;
/**
* A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL.
*/
TemplateBody?: TemplateBody;
/**
* The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified. Conditional: You must specify only TemplateBody or TemplateURL.
*/
TemplateURL?: TemplateURL;
/**
* Whether to reuse the template that is associated with the stack to create the change set.
*/
UsePreviousTemplate?: UsePreviousTemplate;
/**
* A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
*/
Parameters?: Parameters;
/**
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect. Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability. For more information on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
*/
Capabilities?: Capabilities;
/**
* The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
*/
ResourceTypes?: ResourceTypes;
/**
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*/
RoleARN?: RoleARN;
/**
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
*/
RollbackConfiguration?: RollbackConfiguration;
/**
* The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
*/
NotificationARNs?: NotificationARNs;
/**
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.
*/
Tags?: Tags;
/**
* The name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
*/
ChangeSetName: ChangeSetName;
/**
* A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.
*/
ClientToken?: ClientToken;
/**
* A description to help you identify this change set.
*/
Description?: Description;
/**
* The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE. To create a change set for an import operation, specify IMPORT. If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set. By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.
*/
ChangeSetType?: ChangeSetType;
/**
* The resources to import into your stack.
*/
ResourcesToImport?: ResourcesToImport;
}
export interface CreateChangeSetOutput {
/**
* The Amazon Resource Name (ARN) of the change set.
*/
Id?: ChangeSetId;
/**
* The unique ID of the stack.
*/
StackId?: StackId;
}
export interface CreateStackInput {
/**
* The name that is associated with the stack. The name must be unique in the Region in which you are creating the stack. A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
*/
StackName: StackName;
/**
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
*/
TemplateBody?: TemplateBody;
/**
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
*/
TemplateURL?: TemplateURL;
/**
* A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
*/
Parameters?: Parameters;
/**
* Set to true to disable rollback of the stack if stack creation failed. You can specify either DisableRollback or OnFailure, but not both. Default: false
*/
DisableRollback?: DisableRollback;
/**
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
*/
RollbackConfiguration?: RollbackConfiguration;
/**
* The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback is not set or is set to false, the stack will be rolled back.
*/
TimeoutInMinutes?: TimeoutMinutes;
/**
* The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
*/
NotificationARNs?: NotificationARNs;
/**
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability. You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs. Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
*/
Capabilities?: Capabilities;
/**
* The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource). If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
*/
ResourceTypes?: ResourceTypes;
/**
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*/
RoleARN?: RoleARN;
/**
* Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure or DisableRollback, but not both. Default: ROLLBACK
*/
OnFailure?: OnFailure;
/**
* Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
StackPolicyBody?: StackPolicyBody;
/**
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
StackPolicyURL?: StackPolicyURL;
/**
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
*/
Tags?: Tags;
/**
* A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
ClientRequestToken?: ClientRequestToken;
/**
* Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
*/
EnableTerminationProtection?: EnableTerminationProtection;
}
export interface CreateStackInstancesInput {
/**
* The name or unique ID of the stack set that you want to create stack instances from.
*/
StackSetName: StackSetName;
/**
* [Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for. You can specify Accounts or DeploymentTargets, but not both.
*/
Accounts?: AccountList;
/**
* [Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions. You can specify Accounts or DeploymentTargets, but not both.
*/
DeploymentTargets?: DeploymentTargets;
/**
* The names of one or more Regions where you want to create stack instances using the specified AWS account(s).
*/
Regions: RegionList;
/**
* A list of stack set parameters whose values you want to override in the selected stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations: To override the current value for a parameter, include the parameter and specify its value. To leave a parameter set to its present value, you can do one of the following: Do not include the parameter in the list. Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.) To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters. To leave all parameters set to their present values, do not specify this property at all. During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value. You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.
*/
ParameterOverrides?: Parameters;
/**
* Preferences for how AWS CloudFormation performs this stack set operation.
*/
OperationPreferences?: StackSetOperationPreferences;
/**
* The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
*/
OperationId?: ClientRequestToken;
}
export interface CreateStackInstancesOutput {
/**
* The unique identifier for this stack set operation.
*/
OperationId?: ClientRequestToken;
}
export interface CreateStackOutput {
/**
* Unique identifier of the stack.
*/
StackId?: StackId;
}
export interface CreateStackSetInput {
/**
* The name to associate with the stack set. The name must be unique in the Region where you create your stack set. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.
*/
StackSetName: StackSetName;
/**
* A description of the stack set. You can use the description to identify the stack set's purpose or other important information.
*/
Description?: Description;
/**
* The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
*/
TemplateBody?: TemplateBody;
/**
* The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
*/
TemplateURL?: TemplateURL;
/**
* The input parameters for the stack set template.
*/
Parameters?: Parameters;
/**
* In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
*/
Capabilities?: Capabilities;
/**
* The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.
*/
Tags?: Tags;
/**
* The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
*/
AdministrationRoleARN?: RoleARN;
/**
* The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.
*/
ExecutionRoleName?: ExecutionRoleName;
/**
* Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
*/
PermissionModel?: PermissionModels;
/**
* Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
*/
AutoDeployment?: AutoDeployment;
/**
* A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateStackSetOutput {
/**
* The ID of the stack set that you're creating.
*/
StackSetId?: StackSetId;
}
export type CreationTime = Date;
export interface DeleteChangeSetInput {
/**
* The name or Amazon Resource Name (ARN) of the change set that you want to delete.
*/
ChangeSetName: ChangeSetNameOrId;
/**
* If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.
*/
StackName?: StackNameOrId;
}
export interface DeleteChangeSetOutput {
}
export interface DeleteStackInput {
/**
* The name or the unique stack ID that is associated with the stack.
*/
StackName: StackName;
/**
* For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources. Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
*/
RetainResources?: RetainResources;
/**
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*/
RoleARN?: RoleARN;
/**
* A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface DeleteStackInstancesInput {
/**
* The name or unique ID of the stack set that you want to delete stack instances for.
*/
StackSetName: StackSetName;
/**
* [Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for. You can specify Accounts or DeploymentTargets, but not both.
*/
Accounts?: AccountList;
/**
* [Service-managed permissions] The AWS Organizations accounts from which to delete stack instances. You can specify Accounts or DeploymentTargets, but not both.
*/
DeploymentTargets?: DeploymentTargets;
/**
* The Regions where you want to delete stack set instances.
*/
Regions: RegionList;
/**
* Preferences for how AWS CloudFormation performs this stack set operation.
*/
OperationPreferences?: StackSetOperationPreferences;
/**
* Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set. For more information, see Stack set operation options.
*/
RetainStacks: RetainStacks;
/**
* The unique identifier for this stack set operation. If you don't specify an operation ID, the SDK generates one automatically. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
*/
OperationId?: ClientRequestToken;
}
export interface DeleteStackInstancesOutput {
/**
* The unique identifier for this stack set operation.
*/
OperationId?: ClientRequestToken;
}
export interface DeleteStackSetInput {
/**
* The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
*/
StackSetName: StackSetName;
}
export interface DeleteStackSetOutput {
}
export type DeletionTime = Date;
export interface DeploymentTargets {
/**
* The names of one or more AWS accounts for which you want to deploy stack set updates.
*/
Accounts?: AccountList;
/**
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
*/
OrganizationalUnitIds?: OrganizationalUnitIdList;
}
export type DeprecatedStatus = "LIVE"|"DEPRECATED"|string;
export interface DeregisterTypeInput {
/**
* The Amazon Resource Name (ARN) of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
Arn?: PrivateTypeArn;
/**
* The kind of type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
*/
Type?: RegistryType;
/**
* The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
TypeName?: TypeName;
/**
* The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
*/
VersionId?: TypeVersionId;
}
export interface DeregisterTypeOutput {
}
export interface DescribeAccountLimitsInput {
/**
* A string that identifies the next page of limits that you want to retrieve.
*/
NextToken?: NextToken;
}
export interface DescribeAccountLimitsOutput {
/**
* An account limit structure that contain a list of AWS CloudFormation account limits and their values.
*/
AccountLimits?: AccountLimitList;
/**
* If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.
*/
NextToken?: NextToken;
}
export interface DescribeChangeSetInput {
/**
* The name or Amazon Resource Name (ARN) of the change set that you want to describe.
*/
ChangeSetName: ChangeSetNameOrId;
/**
* If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
*/
StackName?: StackNameOrId;
/**
* A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.
*/
NextToken?: NextToken;
}
export interface DescribeChangeSetOutput {
/**
* The name of the change set.
*/
ChangeSetName?: ChangeSetName;
/**
* The ARN of the change set.
*/
ChangeSetId?: ChangeSetId;
/**
* The ARN of the stack that is associated with the change set.
*/
StackId?: StackId;
/**
* The name of the stack that is associated with the change set.
*/
StackName?: StackName;
/**
* Information about the change set.
*/
Description?: Description;
/**
* A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
*/
Parameters?: Parameters;
/**
* The start time when the change set was created, in UTC.
*/
CreationTime?: CreationTime;
/**
* If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.
*/
ExecutionStatus?: ExecutionStatus;
/**
* The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
*/
Status?: ChangeSetStatus;
/**
* A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
*/
StatusReason?: ChangeSetStatusReason;
/**
* The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
*/
NotificationARNs?: NotificationARNs;
/**
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
*/
RollbackConfiguration?: RollbackConfiguration;
/**
* If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
*/
Capabilities?: Capabilities;
/**
* If you execute the change set, the tags that will be associated with the stack.
*/
Tags?: Tags;
/**
* A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.
*/
Changes?: Changes;
/**
* If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
*/
NextToken?: NextToken;
}
export interface DescribeStackDriftDetectionStatusInput {
/**
* The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
*/
StackDriftDetectionId: StackDriftDetectionId;
}
export interface DescribeStackDriftDetectionStatusOutput {
/**
* The ID of the stack.
*/
StackId: StackId;
/**
* The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.
*/
StackDriftDetectionId: StackDriftDetectionId;
/**
* Status of the stack's actual configuration compared to its expected configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use.
*/
StackDriftStatus?: StackDriftStatus;
/**
* The status of the stack drift detection operation. DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.) If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift. DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection. DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
*/
DetectionStatus: StackDriftDetectionStatus;
/**
* The reason the stack drift detection operation has its current status.
*/
DetectionStatusReason?: StackDriftDetectionStatusReason;
/**
* Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.
*/
DriftedStackResourceCount?: BoxedInteger;
/**
* Time at which the stack drift detection operation was initiated.
*/
Timestamp: Timestamp;
}
export interface DescribeStackEventsInput {
/**
* The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
*/
StackName?: StackName;
/**
* A string that identifies the next page of events that you want to retrieve.
*/
NextToken?: NextToken;
}
export interface DescribeStackEventsOutput {
/**
* A list of StackEvents structures.
*/
StackEvents?: StackEvents;
/**
* If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.
*/
NextToken?: NextToken;
}
export interface DescribeStackInstanceInput {
/**
* The name or the unique stack ID of the stack set that you want to get stack instance information for.
*/
StackSetName: StackSetName;
/**
* The ID of an AWS account that's associated with this stack instance.
*/
StackInstanceAccount: Account;
/**
* The name of a Region that's associated with this stack instance.
*/
StackInstanceRegion: Region;
}
export interface DescribeStackInstanceOutput {
/**
* The stack instance that matches the specified request parameters.
*/
StackInstance?: StackInstance;
}
export interface DescribeStackResourceDriftsInput {
/**
* The name of the stack for which you want drift information.
*/
StackName: StackNameOrId;
/**
* The resource drift status values to use as filters for the resource drift results returned. DELETED: The resource differs from its expected template configuration in that the resource has been deleted. MODIFIED: One or more resource properties differ from their expected template values. IN_SYNC: The resources's actual configuration matches its expected template configuration. NOT_CHECKED: AWS CloudFormation does not currently return this value.
*/
StackResourceDriftStatusFilters?: StackResourceDriftStatusFilters;
/**
* A string that identifies the next page of stack resource drift results.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: BoxedMaxResults;
}
export interface DescribeStackResourceDriftsOutput {
/**
* Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects drift. For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.
*/
StackResourceDrifts: StackResourceDrifts;
/**
* If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface DescribeStackResourceInput {
/**
* The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
*/
StackName: StackName;
/**
* The logical name of the resource as specified in the template. Default: There is no default value.
*/
LogicalResourceId: LogicalResourceId;
}
export interface DescribeStackResourceOutput {
/**
* A StackResourceDetail structure containing the description of the specified resource in the specified stack.
*/
StackResourceDetail?: StackResourceDetail;
}
export interface DescribeStackResourcesInput {
/**
* The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value. Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.
*/
StackName?: StackName;
/**
* The logical name of the resource as specified in the template. Default: There is no default value.
*/
LogicalResourceId?: LogicalResourceId;
/**
* The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName. Default: There is no default value.
*/
PhysicalResourceId?: PhysicalResourceId;
}
export interface DescribeStackResourcesOutput {
/**
* A list of StackResource structures.
*/
StackResources?: StackResources;
}
export interface DescribeStackSetInput {
/**
* The name or unique ID of the stack set whose description you want.
*/
StackSetName: StackSetName;
}
export interface DescribeStackSetOperationInput {
/**
* The name or the unique stack ID of the stack set for the stack operation.
*/
StackSetName: StackSetName;
/**
* The unique ID of the stack set operation.
*/
OperationId: ClientRequestToken;
}
export interface DescribeStackSetOperationOutput {
/**
* The specified stack set operation.
*/
StackSetOperation?: StackSetOperation;
}
export interface DescribeStackSetOutput {
/**
* The specified stack set.
*/
StackSet?: StackSet;
}
export interface DescribeStacksInput {
/**
* The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
*/
StackName?: StackName;
/**
* A string that identifies the next page of stacks that you want to retrieve.
*/
NextToken?: NextToken;
}
export interface DescribeStacksOutput {
/**
* A list of stack structures.
*/
Stacks?: Stacks;
/**
* If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
*/
NextToken?: NextToken;
}
export interface DescribeTypeInput {
/**
* The kind of type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
*/
Type?: RegistryType;
/**
* The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
TypeName?: TypeName;
/**
* The Amazon Resource Name (ARN) of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
Arn?: TypeArn;
/**
* The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered. If you specify a VersionId, DescribeType returns information about that specific type version. Otherwise, it returns information about the default type version.
*/
VersionId?: TypeVersionId;
}
export interface DescribeTypeOutput {
/**
* The Amazon Resource Name (ARN) of the type.
*/
Arn?: TypeArn;
/**
* The kind of type. Currently the only valid value is RESOURCE.
*/
Type?: RegistryType;
/**
* The name of the registered type.
*/
TypeName?: TypeName;
/**
* The ID of the default version of the type. The default version is used when the type version is not specified. To set the default version of a type, use SetTypeDefaultVersion .
*/
DefaultVersionId?: TypeVersionId;
/**
* Whether the specified type version is set as the default version.
*/
IsDefaultVersion?: IsDefaultVersion;
/**
* The description of the registered type.
*/
Description?: Description;
/**
* The schema that defines the type. For more information on type schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
*/
Schema?: TypeSchema;
/**
* The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include: FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations. IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations. NON_PROVISIONABLE: The type does not include all of the following handlers, and therefore cannot actually be provisioned. create read delete
*/
ProvisioningType?: ProvisioningType;
/**
* The deprecation status of the type. Valid values include: LIVE: The type is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.
*/
DeprecatedStatus?: DeprecatedStatus;
/**
* Contains logging configuration information for a type.
*/
LoggingConfig?: LoggingConfig;
/**
* The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
*/
ExecutionRoleArn?: RoleArn;
/**
* The scope at which the type is visible and usable in CloudFormation operations. Valid values include: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE. PUBLIC: The type is publically visible and usable within any Amazon account.
*/
Visibility?: Visibility;
/**
* The URL of the source code for the type.
*/
SourceUrl?: OptionalSecureUrl;
/**
* The URL of a page providing detailed documentation for this type.
*/
DocumentationUrl?: OptionalSecureUrl;
/**
* When the specified type version was registered.
*/
LastUpdated?: Timestamp;
/**
* When the specified type version was registered.
*/
TimeCreated?: Timestamp;
}
export interface DescribeTypeRegistrationInput {
/**
* The identifier for this registration request. This registration token is generated by CloudFormation when you initiate a registration request using RegisterType .
*/
RegistrationToken: RegistrationToken;
}
export interface DescribeTypeRegistrationOutput {
/**
* The current status of the type registration request.
*/
ProgressStatus?: RegistrationStatus;
/**
* The description of the type registration request.
*/
Description?: Description;
/**
* The Amazon Resource Name (ARN) of the type being registered. For registration requests with a ProgressStatus of other than COMPLETE, this will be null.
*/
TypeArn?: TypeArn;
/**
* The Amazon Resource Name (ARN) of this specific version of the type being registered. For registration requests with a ProgressStatus of other than COMPLETE, this will be null.
*/
TypeVersionArn?: TypeArn;
}
export type Description = string;
export interface DetectStackDriftInput {
/**
* The name of the stack for which you want to detect drift.
*/
StackName: StackNameOrId;
/**
* The logical names of any resources you want to use as filters.
*/
LogicalResourceIds?: LogicalResourceIds;
}
export interface DetectStackDriftOutput {
/**
* The ID of the drift detection results of this operation. AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
*/
StackDriftDetectionId: StackDriftDetectionId;
}
export interface DetectStackResourceDriftInput {
/**
* The name of the stack to which the resource belongs.
*/
StackName: StackNameOrId;
/**
* The logical name of the resource for which to return drift information.
*/
LogicalResourceId: LogicalResourceId;
}
export interface DetectStackResourceDriftOutput {
/**
* Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.
*/
StackResourceDrift: StackResourceDrift;
}
export interface DetectStackSetDriftInput {
/**
* The name of the stack set on which to perform the drift detection operation.
*/
StackSetName: StackSetNameOrId;
OperationPreferences?: StackSetOperationPreferences;
/**
* The ID of the stack set operation.
*/
OperationId?: ClientRequestToken;
}
export interface DetectStackSetDriftOutput {
/**
* The ID of the drift detection stack set operation. you can use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation.
*/
OperationId?: ClientRequestToken;
}
export type DifferenceType = "ADD"|"REMOVE"|"NOT_EQUAL"|string;
export type DisableRollback = boolean;
export type DriftedStackInstancesCount = number;
export type EnableTerminationProtection = boolean;
export interface EstimateTemplateCostInput {
/**
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only TemplateBody is used.
*/
TemplateBody?: TemplateBody;
/**
* Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
*/
TemplateURL?: TemplateURL;
/**
* A list of Parameter structures that specify input parameters.
*/
Parameters?: Parameters;
}
export interface EstimateTemplateCostOutput {
/**
* An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
*/
Url?: Url;
}
export type EvaluationType = "Static"|"Dynamic"|string;
export type EventId = string;
export interface ExecuteChangeSetInput {
/**
* The name or ARN of the change set that you want use to update the specified stack.
*/
ChangeSetName: ChangeSetNameOrId;
/**
* If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.
*/
StackName?: StackNameOrId;
/**
* A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface ExecuteChangeSetOutput {
}
export type ExecutionRoleName = string;
export type ExecutionStatus = "UNAVAILABLE"|"AVAILABLE"|"EXECUTE_IN_PROGRESS"|"EXECUTE_COMPLETE"|"EXECUTE_FAILED"|"OBSOLETE"|string;
export interface Export {
/**
* The stack that contains the exported output name and value.
*/
ExportingStackId?: StackId;
/**
* The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.
*/
Name?: ExportName;
/**
* The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.
*/
Value?: ExportValue;
}
export type ExportName = string;
export type ExportValue = string;
export type Exports = Export[];
export type FailedStackInstancesCount = number;
export type FailureToleranceCount = number;
export type FailureTolerancePercentage = number;
export interface GetStackPolicyInput {
/**
* The name or unique stack ID that is associated with the stack whose policy you want to get.
*/
StackName: StackName;
}
export interface GetStackPolicyOutput {
/**
* Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
*/
StackPolicyBody?: StackPolicyBody;
}
export interface GetTemplateInput {
/**
* The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
*/
StackName?: StackName;
/**
* The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.
*/
ChangeSetName?: ChangeSetNameOrId;
/**
* For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed. If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.
*/
TemplateStage?: TemplateStage;
}
export interface GetTemplateOutput {
/**
* Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) AWS CloudFormation returns the same template that was used when the stack was created.
*/
TemplateBody?: TemplateBody;
/**
* The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.
*/
StagesAvailable?: StageList;
}
export interface GetTemplateSummaryInput {
/**
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
*/
TemplateBody?: TemplateBody;
/**
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
*/
TemplateURL?: TemplateURL;
/**
* The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
*/
StackName?: StackNameOrId;
/**
* The name or unique ID of the stack set from which the stack was created. Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.
*/
StackSetName?: StackSetNameOrId;
}
export interface GetTemplateSummaryOutput {
/**
* A list of parameter declarations that describe various properties for each parameter.
*/
Parameters?: ParameterDeclarations;
/**
* The value that is defined in the Description property of the template.
*/
Description?: Description;
/**
* The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*/
Capabilities?: Capabilities;
/**
* The list of resources that generated the values in the Capabilities response element.
*/
CapabilitiesReason?: CapabilitiesReason;
/**
* A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
*/
ResourceTypes?: ResourceTypes;
/**
* The AWS template format version, which identifies the capabilities of the template.
*/
Version?: Version;
/**
* The value that is defined for the Metadata property of the template.
*/
Metadata?: Metadata;
/**
* A list of the transforms that are declared in the template.
*/
DeclaredTransforms?: TransformsList;
/**
* A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.
*/
ResourceIdentifierSummaries?: ResourceIdentifierSummaries;
}
export type HandlerErrorCode = "NotUpdatable"|"InvalidRequest"|"AccessDenied"|"InvalidCredentials"|"AlreadyExists"|"NotFound"|"ResourceConflict"|"Throttling"|"ServiceLimitExceeded"|"NotStabilized"|"GeneralServiceException"|"ServiceInternalError"|"NetworkFailure"|"InternalFailure"|string;
export type Imports = StackName[];
export type InProgressStackInstancesCount = number;
export type InSyncStackInstancesCount = number;
export type IsDefaultVersion = boolean;
export type Key = string;
export type LastUpdatedTime = Date;
export type LimitName = string;
export type LimitValue = number;
export interface ListChangeSetsInput {
/**
* The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
*/
StackName: StackNameOrId;
/**
* A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.
*/
NextToken?: NextToken;
}
export interface ListChangeSetsOutput {
/**
* A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.
*/
Summaries?: ChangeSetSummaries;
/**
* If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.
*/
NextToken?: NextToken;
}
export interface ListExportsInput {
/**
* A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.
*/
NextToken?: NextToken;
}
export interface ListExportsOutput {
/**
* The output for the ListExports action.
*/
Exports?: Exports;
/**
* If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.
*/
NextToken?: NextToken;
}
export interface ListImportsInput {
/**
* The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.
*/
ExportName: ExportName;
/**
* A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.
*/
NextToken?: NextToken;
}
export interface ListImportsOutput {
/**
* A list of stack names that are importing the specified exported output value.
*/
Imports?: Imports;
/**
* A string that identifies the next page of exports. If there is no additional page, this value is null.
*/
NextToken?: NextToken;
}
export interface ListStackInstancesInput {
/**
* The name or unique ID of the stack set that you want to list stack instances for.
*/
StackSetName: StackSetName;
/**
* If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The status that stack instances are filtered by.
*/
Filters?: StackInstanceFilters;
/**
* The name of the AWS account that you want to list stack instances for.
*/
StackInstanceAccount?: Account;
/**
* The name of the Region where you want to list stack instances.
*/
StackInstanceRegion?: Region;
}
export interface ListStackInstancesOutput {
/**
* A list of StackInstanceSummary structures that contain information about the specified stack instances.
*/
Summaries?: StackInstanceSummaries;
/**
* If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface ListStackResourcesInput {
/**
* The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID. Default: There is no default value.
*/
StackName: StackName;
/**
* A string that identifies the next page of stack resources that you want to retrieve.
*/
NextToken?: NextToken;
}
export interface ListStackResourcesOutput {
/**
* A list of StackResourceSummary structures.
*/
StackResourceSummaries?: StackResourceSummaries;
/**
* If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.
*/
NextToken?: NextToken;
}
export interface ListStackSetOperationResultsInput {
/**
* The name or unique ID of the stack set that you want to get operation results for.
*/
StackSetName: StackSetName;
/**
* The ID of the stack set operation.
*/
OperationId: ClientRequestToken;
/**
* If the previous request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListStackSetOperationResultsOutput {
/**
* A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and Regions that are included in the operation.
*/
Summaries?: StackSetOperationResultSummaries;
/**
* If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface ListStackSetOperationsInput {
/**
* The name or unique ID of the stack set that you want to get operation summaries for.
*/
StackSetName: StackSetName;
/**
* If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
}
export interface ListStackSetOperationsOutput {
/**
* A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.
*/
Summaries?: StackSetOperationSummaries;
/**
* If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface ListStackSetsInput {
/**
* If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* The status of the stack sets that you want to get summary information about.
*/
Status?: StackSetStatus;
}
export interface ListStackSetsOutput {
/**
* A list of StackSetSummary structures that contain information about the user's stack sets.
*/
Summaries?: StackSetSummaries;
/**
* If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface ListStacksInput {
/**
* A string that identifies the next page of stacks that you want to retrieve.
*/
NextToken?: NextToken;
/**
* Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
*/
StackStatusFilter?: StackStatusFilter;
}
export interface ListStacksOutput {
/**
* A list of StackSummary structures containing information about the specified stacks.
*/
StackSummaries?: StackSummaries;
/**
* If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
*/
NextToken?: NextToken;
}
export interface ListTypeRegistrationsInput {
/**
* The kind of type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
*/
Type?: RegistryType;
/**
* The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
TypeName?: TypeName;
/**
* The Amazon Resource Name (ARN) of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
TypeArn?: TypeArn;
/**
* The current status of the type registration request. The default is IN_PROGRESS.
*/
RegistrationStatusFilter?: RegistrationStatus;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
}
export interface ListTypeRegistrationsOutput {
/**
* A list of type registration tokens. Use DescribeTypeRegistration to return detailed information about a type registration request.
*/
RegistrationTokenList?: RegistrationTokenList;
/**
* If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface ListTypeVersionsInput {
/**
* The kind of the type. Currently the only valid value is RESOURCE. Conditional: You must specify either TypeName and Type, or Arn.
*/
Type?: RegistryType;
/**
* The name of the type for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
*/
TypeName?: TypeName;
/**
* The Amazon Resource Name (ARN) of the type for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
*/
Arn?: PrivateTypeArn;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
/**
* The deprecation status of the type versions that you want to get summary information about. Valid values include: LIVE: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. DEPRECATED: The type version has been deregistered and can no longer be used in CloudFormation operations. The default is LIVE.
*/
DeprecatedStatus?: DeprecatedStatus;
}
export interface ListTypeVersionsOutput {
/**
* A list of TypeVersionSummary structures that contain information about the specified type's versions.
*/
TypeVersionSummaries?: TypeVersionSummaries;
/**
* If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export interface ListTypesInput {
/**
* The scope at which the type is visible and usable in CloudFormation operations. Valid values include: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as PRIVATE. PUBLIC: The type is publically visible and usable within any Amazon account. The default is PRIVATE.
*/
Visibility?: Visibility;
/**
* The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted. Valid values include: FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack update operations. IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations. NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.
*/
ProvisioningType?: ProvisioningType;
/**
* The deprecation status of the types that you want to get summary information about. Valid values include: LIVE: The type is registered for use in CloudFormation operations. DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.
*/
DeprecatedStatus?: DeprecatedStatus;
/**
* The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
*/
MaxResults?: MaxResults;
/**
* If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
*/
NextToken?: NextToken;
}
export interface ListTypesOutput {
/**
* A list of TypeSummary structures that contain information about the specified types.
*/
TypeSummaries?: TypeSummaries;
/**
* If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.
*/
NextToken?: NextToken;
}
export type LogGroupName = string;
export interface LoggingConfig {
/**
* The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
*/
LogRoleArn: RoleArn;
/**
* The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers.
*/
LogGroupName: LogGroupName;
}
export type LogicalResourceId = string;
export type LogicalResourceIds = LogicalResourceId[];
export type MaxConcurrentCount = number;
export type MaxConcurrentPercentage = number;
export type MaxResults = number;
export type Metadata = string;
export type MonitoringTimeInMinutes = number;
export type NextToken = string;
export type NoEcho = boolean;
export type NotificationARN = string;
export type NotificationARNs = NotificationARN[];
export type OnFailure = "DO_NOTHING"|"ROLLBACK"|"DELETE"|string;
export type OperationStatus = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|string;
export type OptionalSecureUrl = string;
export type OrganizationalUnitId = string;
export type OrganizationalUnitIdList = OrganizationalUnitId[];
export interface Output {
/**
* The key associated with the output.
*/
OutputKey?: OutputKey;
/**
* The value associated with the output.
*/
OutputValue?: OutputValue;
/**
* User defined description associated with the output.
*/
Description?: Description;
/**
* The name of the export associated with the output.
*/
ExportName?: ExportName;
}
export type OutputKey = string;
export type OutputValue = string;
export type Outputs = Output[];
export interface Parameter {
/**
* The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
*/
ParameterKey?: ParameterKey;
/**
* The input value associated with the parameter.
*/
ParameterValue?: ParameterValue;
/**
* During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.
*/
UsePreviousValue?: UsePreviousValue;
/**
* Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.
*/
ResolvedValue?: ParameterValue;
}
export interface ParameterConstraints {
/**
* A list of values that are permitted for a parameter.
*/
AllowedValues?: AllowedValues;
}
export interface ParameterDeclaration {
/**
* The name that is associated with the parameter.
*/
ParameterKey?: ParameterKey;
/**
* The default value of the parameter.
*/
DefaultValue?: ParameterValue;
/**
* The type of parameter.
*/
ParameterType?: ParameterType;
/**
* Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
*/
NoEcho?: NoEcho;
/**
* The description that is associate with the parameter.
*/
Description?: Description;
/**
* The criteria that AWS CloudFormation uses to validate parameter values.
*/
ParameterConstraints?: ParameterConstraints;
}
export type ParameterDeclarations = ParameterDeclaration[];
export type ParameterKey = string;
export type ParameterType = string;
export type ParameterValue = string;
export type Parameters = Parameter[];
export type PermissionModels = "SERVICE_MANAGED"|"SELF_MANAGED"|string;
export type PhysicalResourceId = string;
export type PhysicalResourceIdContext = PhysicalResourceIdContextKeyValuePair[];
export interface PhysicalResourceIdContextKeyValuePair {
/**
* The resource context key.
*/
Key: Key;
/**
* The resource context value.
*/
Value: Value;
}
export type PrivateTypeArn = string;
export type Properties = string;
export interface PropertyDifference {
/**
* The fully-qualified path to the resource property.
*/
PropertyPath: PropertyPath;
/**
* The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.
*/
ExpectedValue: PropertyValue;
/**
* The actual property value of the resource property.
*/
ActualValue: PropertyValue;
/**
* The type of property difference. ADD: A value has been added to a resource property that is an array or list data type. REMOVE: The property has been removed from the current resource configuration. NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).
*/
DifferenceType: DifferenceType;
}
export type PropertyDifferences = PropertyDifference[];
export type PropertyName = string;
export type PropertyPath = string;
export type PropertyValue = string;
export type ProvisioningType = "NON_PROVISIONABLE"|"IMMUTABLE"|"FULLY_MUTABLE"|string;
export type Reason = string;
export interface RecordHandlerProgressInput {
/**
* Reserved for use by the CloudFormation CLI.
*/
BearerToken: ClientToken;
/**
* Reserved for use by the CloudFormation CLI.
*/
OperationStatus: OperationStatus;
/**
* Reserved for use by the CloudFormation CLI.
*/
CurrentOperationStatus?: OperationStatus;
/**
* Reserved for use by the CloudFormation CLI.
*/
StatusMessage?: StatusMessage;
/**
* Reserved for use by the CloudFormation CLI.
*/
ErrorCode?: HandlerErrorCode;
/**
* Reserved for use by the CloudFormation CLI.
*/
ResourceModel?: ResourceModel;
/**
* Reserved for use by the CloudFormation CLI.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface RecordHandlerProgressOutput {
}
export type Region = string;
export type RegionList = Region[];
export interface RegisterTypeInput {
/**
* The kind of type. Currently, the only valid value is RESOURCE.
*/
Type?: RegistryType;
/**
* The name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type. The following organization namespaces are reserved and cannot be used in your resource type names: Alexa AMZN Amazon AWS Custom Dev
*/
TypeName: TypeName;
/**
* A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide. As part of registering a resource provider type, CloudFormation must be able to access the S3 bucket which contains the schema handler package for that resource provider. For more information, see IAM Permissions for Registering a Resource Provider in the AWS CloudFormation User Guide.
*/
SchemaHandlerPackage: S3Url;
/**
* Specifies logging configuration information for a type.
*/
LoggingConfig?: LoggingConfig;
/**
* The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.
*/
ExecutionRoleArn?: RoleArn;
/**
* A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times.
*/
ClientRequestToken?: RequestToken;
}
export interface RegisterTypeOutput {
/**
* The identifier for this registration request. Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the type registration.
*/
RegistrationToken?: RegistrationToken;
}
export type RegistrationStatus = "COMPLETE"|"IN_PROGRESS"|"FAILED"|string;
export type RegistrationToken = string;
export type RegistrationTokenList = RegistrationToken[];
export type RegistryType = "RESOURCE"|string;
export type Replacement = "True"|"False"|"Conditional"|string;
export type RequestToken = string;
export type RequiresRecreation = "Never"|"Conditionally"|"Always"|string;
export type ResourceAttribute = "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"Tags"|string;
export interface ResourceChange {
/**
* The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).
*/
Action?: ChangeAction;
/**
* The resource's logical ID, which is defined in the stack's template.
*/
LogicalResourceId?: LogicalResourceId;
/**
* The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
*/
PhysicalResourceId?: PhysicalResourceId;
/**
* The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
*/
ResourceType?: ResourceType;
/**
* For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally. If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.
*/
Replacement?: Replacement;
/**
* For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
*/
Scope?: Scope;
/**
* For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
*/
Details?: ResourceChangeDetails;
}
export interface ResourceChangeDetail {
/**
* A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
*/
Target?: ResourceTargetDefinition;
/**
* Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set. For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation. For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.
*/
Evaluation?: EvaluationType;
/**
* The group to which the CausingEntity value belongs. There are five entity groups: ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }. ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }. ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }. DirectModification entities are changes that are made directly to the template. Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.
*/
ChangeSource?: ChangeSource;
/**
* The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName). If the ChangeSource value is DirectModification, no value is given for CausingEntity.
*/
CausingEntity?: CausingEntity;
}
export type ResourceChangeDetails = ResourceChangeDetail[];
export type ResourceIdentifierProperties = {[key: string]: ResourceIdentifierPropertyValue};
export type ResourceIdentifierPropertyKey = string;
export type ResourceIdentifierPropertyValue = string;
export type ResourceIdentifierSummaries = ResourceIdentifierSummary[];
export interface ResourceIdentifierSummary {
/**
* The template resource type of the target resources, such as AWS::S3::Bucket.
*/
ResourceType?: ResourceType;
/**
* The logical IDs of the target resources of the specified ResourceType, as defined in the import template.
*/
LogicalResourceIds?: LogicalResourceIds;
/**
* The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.
*/
ResourceIdentifiers?: ResourceIdentifiers;
}
export type ResourceIdentifiers = ResourceIdentifierPropertyKey[];
export type ResourceModel = string;
export type ResourceProperties = string;
export type ResourceSignalStatus = "SUCCESS"|"FAILURE"|string;
export type ResourceSignalUniqueId = string;
export type ResourceStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"DELETE_SKIPPED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_COMPLETE"|"IMPORT_FAILED"|"IMPORT_COMPLETE"|"IMPORT_IN_PROGRESS"|"IMPORT_ROLLBACK_IN_PROGRESS"|"IMPORT_ROLLBACK_FAILED"|"IMPORT_ROLLBACK_COMPLETE"|string;
export type ResourceStatusReason = string;
export interface ResourceTargetDefinition {
/**
* Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
*/
Attribute?: ResourceAttribute;
/**
* If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.
*/
Name?: PropertyName;
/**
* If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.
*/
RequiresRecreation?: RequiresRecreation;
}
export interface ResourceToImport {
/**
* The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the AWS CloudFormation User Guide.
*/
ResourceType: ResourceType;
/**
* The logical ID of the target resource as specified in the template.
*/
LogicalResourceId: LogicalResourceId;
/**
* A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).
*/
ResourceIdentifier: ResourceIdentifierProperties;
}
export type ResourceToSkip = string;
export type ResourceType = string;
export type ResourceTypes = ResourceType[];
export type ResourcesToImport = ResourceToImport[];
export type ResourcesToSkip = ResourceToSkip[];
export type RetainResources = LogicalResourceId[];
export type RetainStacks = boolean;
export type RetainStacksNullable = boolean;
export type RetainStacksOnAccountRemovalNullable = boolean;
export type RoleARN = string;
export type RoleArn = string;
export interface RollbackConfiguration {
/**
* The triggers to monitor during stack creation or update actions. By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means: To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack. To remove all currently specified triggers, specify an empty list for this parameter. If a specified trigger is missing, the entire stack operation fails and is rolled back.
*/
RollbackTriggers?: RollbackTriggers;
/**
* The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. The default is 0 minutes. If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
*/
MonitoringTimeInMinutes?: MonitoringTimeInMinutes;
}
export interface RollbackTrigger {
/**
* The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back.
*/
Arn: Arn;
/**
* The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
*/
Type: Type;
}
export type RollbackTriggers = RollbackTrigger[];
export type S3Url = string;
export type Scope = ResourceAttribute[];
export interface SetStackPolicyInput {
/**
* The name or unique stack ID that you want to associate a policy with.
*/
StackName: StackName;
/**
* Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
StackPolicyBody?: StackPolicyBody;
/**
* Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.
*/
StackPolicyURL?: StackPolicyURL;
}
export interface SetTypeDefaultVersionInput {
/**
* The Amazon Resource Name (ARN) of the type for which you want version summary information. Conditional: You must specify either TypeName and Type, or Arn.
*/
Arn?: PrivateTypeArn;
/**
* The kind of type. Conditional: You must specify either TypeName and Type, or Arn.
*/
Type?: RegistryType;
/**
* The name of the type. Conditional: You must specify either TypeName and Type, or Arn.
*/
TypeName?: TypeName;
/**
* The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
*/
VersionId?: TypeVersionId;
}
export interface SetTypeDefaultVersionOutput {
}
export interface SignalResourceInput {
/**
* The stack name or unique stack ID that includes the resource that you want to signal.
*/
StackName: StackNameOrId;
/**
* The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
*/
LogicalResourceId: LogicalResourceId;
/**
* A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.
*/
UniqueId: ResourceSignalUniqueId;
/**
* The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
*/
Status: ResourceSignalStatus;
}
export interface Stack {
/**
* Unique identifier of the stack.
*/
StackId?: StackId;
/**
* The name associated with the stack.
*/
StackName: StackName;
/**
* The unique ID of the change set.
*/
ChangeSetId?: ChangeSetId;
/**
* A user-defined description associated with the stack.
*/
Description?: Description;
/**
* A list of Parameter structures.
*/
Parameters?: Parameters;
/**
* The time at which the stack was created.
*/
CreationTime: CreationTime;
/**
* The time the stack was deleted.
*/
DeletionTime?: DeletionTime;
/**
* The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
*/
LastUpdatedTime?: LastUpdatedTime;
/**
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
*/
RollbackConfiguration?: RollbackConfiguration;
/**
* Current status of the stack.
*/
StackStatus: StackStatus;
/**
* Success/failure message associated with the stack status.
*/
StackStatusReason?: StackStatusReason;
/**
* Boolean to enable or disable rollback on stack creation failures: true: disable rollback false: enable rollback
*/
DisableRollback?: DisableRollback;
/**
* SNS topic ARNs to which stack related events are published.
*/
NotificationARNs?: NotificationARNs;
/**
* The amount of time within which stack creation should complete.
*/
TimeoutInMinutes?: TimeoutMinutes;
/**
* The capabilities allowed in the stack.
*/
Capabilities?: Capabilities;
/**
* A list of output structures.
*/
Outputs?: Outputs;
/**
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
*/
RoleARN?: RoleARN;
/**
* A list of Tags that specify information about the stack.
*/
Tags?: Tags;
/**
* Whether termination protection is enabled for the stack. For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.
*/
EnableTerminationProtection?: EnableTerminationProtection;
/**
* For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
*/
ParentId?: StackId;
/**
* For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
*/
RootId?: StackId;
/**
* Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
*/
DriftInformation?: StackDriftInformation;
}
export type StackDriftDetectionId = string;
export type StackDriftDetectionStatus = "DETECTION_IN_PROGRESS"|"DETECTION_FAILED"|"DETECTION_COMPLETE"|string;
export type StackDriftDetectionStatusReason = string;
export interface StackDriftInformation {
/**
* Status of the stack's actual configuration compared to its expected template configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use.
*/
StackDriftStatus: StackDriftStatus;
/**
* Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
*/
LastCheckTimestamp?: Timestamp;
}
export interface StackDriftInformationSummary {
/**
* Status of the stack's actual configuration compared to its expected template configuration. DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration. IN_SYNC: The stack's actual configuration matches its expected template configuration. UNKNOWN: This value is reserved for future use.
*/
StackDriftStatus: StackDriftStatus;
/**
* Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
*/
LastCheckTimestamp?: Timestamp;
}
export type StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED"|string;
export interface StackEvent {
/**
* The unique ID name of the instance of the stack.
*/
StackId: StackId;
/**
* The unique ID of this event.
*/
EventId: EventId;
/**
* The name associated with a stack.
*/
StackName: StackName;
/**
* The logical name of the resource specified in the template.
*/
LogicalResourceId?: LogicalResourceId;
/**
* The name or unique identifier associated with the physical instance of the resource.
*/
PhysicalResourceId?: PhysicalResourceId;
/**
* Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
*/
ResourceType?: ResourceType;
/**
* Time the status was updated.
*/
Timestamp: Timestamp;
/**
* Current status of the resource.
*/
ResourceStatus?: ResourceStatus;
/**
* Success/failure message associated with the resource.
*/
ResourceStatusReason?: ResourceStatusReason;
/**
* BLOB of the properties used to create the resource.
*/
ResourceProperties?: ResourceProperties;
/**
* The token passed to the operation that generated this event. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
ClientRequestToken?: ClientRequestToken;
}
export type StackEvents = StackEvent[];
export type StackId = string;
export interface StackInstance {
/**
* The name or unique ID of the stack set that the stack instance is associated with.
*/
StackSetId?: StackSetId;
/**
* The name of the AWS Region that the stack instance is associated with.
*/
Region?: Region;
/**
* [Self-managed permissions] The name of the AWS account that the stack instance is associated with.
*/
Account?: Account;
/**
* The ID of the stack instance.
*/
StackId?: StackId;
/**
* A list of parameters from the stack set template whose values have been overridden in this stack instance.
*/
ParameterOverrides?: Parameters;
/**
* The status of the stack instance, in terms of its synchronization with its associated stack set. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. OUTDATED: The stack isn't currently up to date with the stack set because: The associated stack failed during a CreateStackSet or UpdateStackSet operation. The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set.
*/
Status?: StackInstanceStatus;
/**
* The detailed status of the stack instance.
*/
StackInstanceStatus?: StackInstanceComprehensiveStatus;
/**
* The explanation for the specific status code that is assigned to this stack instance.
*/
StatusReason?: Reason;
/**
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
*/
OrganizationalUnitId?: OrganizationalUnitId;
/**
* Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration. IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration. UNKNOWN: This value is reserved for future use.
*/
DriftStatus?: StackDriftStatus;
/**
* Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
*/
LastDriftCheckTimestamp?: Timestamp;
}
export interface StackInstanceComprehensiveStatus {
/**
* CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. PENDING: The operation in the specified account and Region has yet to start. RUNNING: The operation in the specified account and Region is currently in progress. SUCCEEDED: The operation in the specified account and Region completed successfully.
*/
DetailedStatus?: StackInstanceDetailedStatus;
}
export type StackInstanceDetailedStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|"INOPERABLE"|string;
export interface StackInstanceFilter {
/**
* The type of filter to apply.
*/
Name?: StackInstanceFilterName;
/**
* The status to filter by.
*/
Values?: StackInstanceFilterValues;
}
export type StackInstanceFilterName = "DETAILED_STATUS"|string;
export type StackInstanceFilterValues = string;
export type StackInstanceFilters = StackInstanceFilter[];
export type StackInstanceStatus = "CURRENT"|"OUTDATED"|"INOPERABLE"|string;
export type StackInstanceSummaries = StackInstanceSummary[];
export interface StackInstanceSummary {
/**
* The name or unique ID of the stack set that the stack instance is associated with.
*/
StackSetId?: StackSetId;
/**
* The name of the AWS Region that the stack instance is associated with.
*/
Region?: Region;
/**
* [Self-managed permissions] The name of the AWS account that the stack instance is associated with.
*/
Account?: Account;
/**
* The ID of the stack instance.
*/
StackId?: StackId;
/**
* The status of the stack instance, in terms of its synchronization with its associated stack set. INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually. OUTDATED: The stack isn't currently up to date with the stack set because: The associated stack failed during a CreateStackSet or UpdateStackSet operation. The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated. CURRENT: The stack is currently up to date with the stack set.
*/
Status?: StackInstanceStatus;
/**
* The explanation for the specific status code assigned to this stack instance.
*/
StatusReason?: Reason;
/**
* The detailed status of the stack instance.
*/
StackInstanceStatus?: StackInstanceComprehensiveStatus;
/**
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
*/
OrganizationalUnitId?: OrganizationalUnitId;
/**
* Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. DRIFTED: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration. IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration. UNKNOWN: This value is reserved for future use.
*/
DriftStatus?: StackDriftStatus;
/**
* Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL for any stack instance on which drift detection has not yet been performed.
*/
LastDriftCheckTimestamp?: Timestamp;
}
export type StackName = string;
export type StackNameOrId = string;
export type StackPolicyBody = string;
export type StackPolicyDuringUpdateBody = string;
export type StackPolicyDuringUpdateURL = string;
export type StackPolicyURL = string;
export interface StackResource {
/**
* The name associated with the stack.
*/
StackName?: StackName;
/**
* Unique identifier of the stack.
*/
StackId?: StackId;
/**
* The logical name of the resource specified in the template.
*/
LogicalResourceId: LogicalResourceId;
/**
* The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
*/
PhysicalResourceId?: PhysicalResourceId;
/**
* Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
*/
ResourceType: ResourceType;
/**
* Time the status was updated.
*/
Timestamp: Timestamp;
/**
* Current status of the resource.
*/
ResourceStatus: ResourceStatus;
/**
* Success/failure message associated with the resource.
*/
ResourceStatusReason?: ResourceStatusReason;
/**
* User defined description associated with the resource.
*/
Description?: Description;
/**
* Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
*/
DriftInformation?: StackResourceDriftInformation;
}
export interface StackResourceDetail {
/**
* The name associated with the stack.
*/
StackName?: StackName;
/**
* Unique identifier of the stack.
*/
StackId?: StackId;
/**
* The logical name of the resource specified in the template.
*/
LogicalResourceId: LogicalResourceId;
/**
* The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
*/
PhysicalResourceId?: PhysicalResourceId;
/**
* Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
*/
ResourceType: ResourceType;
/**
* Time the status was updated.
*/
LastUpdatedTimestamp: Timestamp;
/**
* Current status of the resource.
*/
ResourceStatus: ResourceStatus;
/**
* Success/failure message associated with the resource.
*/
ResourceStatusReason?: ResourceStatusReason;
/**
* User defined description associated with the resource.
*/
Description?: Description;
/**
* The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
*/
Metadata?: Metadata;
/**
* Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
*/
DriftInformation?: StackResourceDriftInformation;
}
export interface StackResourceDrift {
/**
* The ID of the stack.
*/
StackId: StackId;
/**
* The logical name of the resource specified in the template.
*/
LogicalResourceId: LogicalResourceId;
/**
* The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
*/
PhysicalResourceId?: PhysicalResourceId;
/**
* Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
*/
PhysicalResourceIdContext?: PhysicalResourceIdContext;
/**
* The type of the resource.
*/
ResourceType: ResourceType;
/**
* A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.
*/
ExpectedProperties?: Properties;
/**
* A JSON structure containing the actual property values of the stack resource. For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.
*/
ActualProperties?: Properties;
/**
* A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.
*/
PropertyDifferences?: PropertyDifferences;
/**
* Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected template configuration because the resource has been deleted. MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters). IN_SYNC: The resources's actual configuration matches its expected template configuration. NOT_CHECKED: AWS CloudFormation does not currently return this value.
*/
StackResourceDriftStatus: StackResourceDriftStatus;
/**
* Time at which AWS CloudFormation performed drift detection on the stack resource.
*/
Timestamp: Timestamp;
}
export interface StackResourceDriftInformation {
/**
* Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. IN_SYNC: The resources's actual configuration matches its expected configuration.
*/
StackResourceDriftStatus: StackResourceDriftStatus;
/**
* When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
*/
LastCheckTimestamp?: Timestamp;
}
export interface StackResourceDriftInformationSummary {
/**
* Status of the resource's actual configuration compared to its expected configuration DELETED: The resource differs from its expected configuration in that it has been deleted. MODIFIED: The resource differs from its expected configuration. NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration. Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the AWS CloudFormation User Guide. IN_SYNC: The resources's actual configuration matches its expected configuration.
*/
StackResourceDriftStatus: StackResourceDriftStatus;
/**
* When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
*/
LastCheckTimestamp?: Timestamp;
}
export type StackResourceDriftStatus = "IN_SYNC"|"MODIFIED"|"DELETED"|"NOT_CHECKED"|string;
export type StackResourceDriftStatusFilters = StackResourceDriftStatus[];
export type StackResourceDrifts = StackResourceDrift[];
export type StackResourceSummaries = StackResourceSummary[];
export interface StackResourceSummary {
/**
* The logical name of the resource specified in the template.
*/
LogicalResourceId: LogicalResourceId;
/**
* The name or unique identifier that corresponds to a physical instance ID of the resource.
*/
PhysicalResourceId?: PhysicalResourceId;
/**
* Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
*/
ResourceType: ResourceType;
/**
* Time the status was updated.
*/
LastUpdatedTimestamp: Timestamp;
/**
* Current status of the resource.
*/
ResourceStatus: ResourceStatus;
/**
* Success/failure message associated with the resource.
*/
ResourceStatusReason?: ResourceStatusReason;
/**
* Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
*/
DriftInformation?: StackResourceDriftInformationSummary;
}
export type StackResources = StackResource[];
export interface StackSet {
/**
* The name that's associated with the stack set.
*/
StackSetName?: StackSetName;
/**
* The ID of the stack set.
*/
StackSetId?: StackSetId;
/**
* A description of the stack set that you specify when the stack set is created or updated.
*/
Description?: Description;
/**
* The status of the stack set.
*/
Status?: StackSetStatus;
/**
* The structure that contains the body of the template that was used to create or update the stack set.
*/
TemplateBody?: TemplateBody;
/**
* A list of input parameters for a stack set.
*/
Parameters?: Parameters;
/**
* The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*/
Capabilities?: Capabilities;
/**
* A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
*/
Tags?: Tags;
/**
* The Amazon Resource Number (ARN) of the stack set.
*/
StackSetARN?: StackSetARN;
/**
* The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
*/
AdministrationRoleARN?: RoleARN;
/**
* The name of the IAM execution role used to create or update the stack set. Use customized execution roles to control which stack resources users and groups can include in their stack sets.
*/
ExecutionRoleName?: ExecutionRoleName;
/**
* Detailed information about the drift status of the stack set. For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations currently in progress is not included.
*/
StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
/**
* [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
*/
AutoDeployment?: AutoDeployment;
/**
* Describes how the IAM roles required for stack set operations are created. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
*/
PermissionModel?: PermissionModels;
/**
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
*/
OrganizationalUnitIds?: OrganizationalUnitIdList;
}
export type StackSetARN = string;
export interface StackSetDriftDetectionDetails {
/**
* Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration. DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift. IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.
*/
DriftStatus?: StackSetDriftStatus;
/**
* The status of the stack set drift detection operation. COMPLETED: The drift detection operation completed without failing on any stack instances. FAILED: The drift detection operation exceeded the specified failure tolerance. PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for the operation. IN_PROGRESS: The drift detection operation is currently being performed. STOPPED: The user has cancelled the drift detection operation.
*/
DriftDetectionStatus?: StackSetDriftDetectionStatus;
/**
* Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.
*/
LastDriftCheckTimestamp?: Timestamp;
/**
* The total number of stack instances belonging to this stack set. The total number of stack instances is equal to the total of: Stack instances that match the stack set configuration. Stack instances that have drifted from the stack set configuration. Stack instances where the drift detection operation has failed. Stack instances currently being checked for drift.
*/
TotalStackInstancesCount?: TotalStackInstancesCount;
/**
* The number of stack instances that have drifted from the expected template and parameter configuration of the stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack do not match their expected configuration.
*/
DriftedStackInstancesCount?: DriftedStackInstancesCount;
/**
* The number of stack instances which match the expected template and parameter configuration of the stack set.
*/
InSyncStackInstancesCount?: InSyncStackInstancesCount;
/**
* The number of stack instances that are currently being checked for drift.
*/
InProgressStackInstancesCount?: InProgressStackInstancesCount;
/**
* The number of stack instances for which the drift detection operation failed.
*/
FailedStackInstancesCount?: FailedStackInstancesCount;
}
export type StackSetDriftDetectionStatus = "COMPLETED"|"FAILED"|"PARTIAL_SUCCESS"|"IN_PROGRESS"|"STOPPED"|string;
export type StackSetDriftStatus = "DRIFTED"|"IN_SYNC"|"NOT_CHECKED"|string;
export type StackSetId = string;
export type StackSetName = string;
export type StackSetNameOrId = string;
export interface StackSetOperation {
/**
* The unique ID of a stack set operation.
*/
OperationId?: ClientRequestToken;
/**
* The ID of the stack set.
*/
StackSetId?: StackSetId;
/**
* The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.
*/
Action?: StackSetOperationAction;
/**
* The status of the operation. FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining Regions. QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide. RUNNING: The operation is currently being performed. STOPPED: The user has cancelled the operation. STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
*/
Status?: StackSetOperationStatus;
/**
* The preferences for how AWS CloudFormation performs this stack set operation.
*/
OperationPreferences?: StackSetOperationPreferences;
/**
* For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.
*/
RetainStacks?: RetainStacksNullable;
/**
* The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide.
*/
AdministrationRoleARN?: RoleARN;
/**
* The name of the IAM execution role used to create or update the stack set. Use customized execution roles to control which stack resources users and groups can include in their stack sets.
*/
ExecutionRoleName?: ExecutionRoleName;
/**
* The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
*/
CreationTimestamp?: Timestamp;
/**
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
*/
EndTimestamp?: Timestamp;
/**
* [Service-managed permissions] The AWS Organizations accounts affected by the stack operation.
*/
DeploymentTargets?: DeploymentTargets;
/**
* Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set. this information will only be present for stack set operations whose Action type is DETECT_DRIFT. For more information, see Detecting Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
*/
StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
}
export type StackSetOperationAction = "CREATE"|"UPDATE"|"DELETE"|"DETECT_DRIFT"|string;
export interface StackSetOperationPreferences {
/**
* The order of the Regions in where you want to perform the stack operation.
*/
RegionOrder?: RegionList;
/**
* The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).
*/
FailureToleranceCount?: FailureToleranceCount;
/**
* The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.
*/
FailureTolerancePercentage?: FailureTolerancePercentage;
/**
* The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
*/
MaxConcurrentCount?: MaxConcurrentCount;
/**
* The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.
*/
MaxConcurrentPercentage?: MaxConcurrentPercentage;
}
export type StackSetOperationResultStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|string;
export type StackSetOperationResultSummaries = StackSetOperationResultSummary[];
export interface StackSetOperationResultSummary {
/**
* [Self-managed permissions] The name of the AWS account for this operation result.
*/
Account?: Account;
/**
* The name of the AWS Region for this operation result.
*/
Region?: Region;
/**
* The result status of the stack set operation for the given account in the given Region. CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded. FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded. RUNNING: The operation in the specified account and Region is currently in progress. PENDING: The operation in the specified account and Region has yet to start. SUCCEEDED: The operation in the specified account and Region completed successfully.
*/
Status?: StackSetOperationResultStatus;
/**
* The reason for the assigned result status.
*/
StatusReason?: Reason;
/**
* The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account
*/
AccountGateResult?: AccountGateResult;
/**
* [Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
*/
OrganizationalUnitId?: OrganizationalUnitId;
}
export type StackSetOperationStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"STOPPING"|"STOPPED"|"QUEUED"|string;
export type StackSetOperationSummaries = StackSetOperationSummary[];
export interface StackSetOperationSummary {
/**
* The unique ID of the stack set operation.
*/
OperationId?: ClientRequestToken;
/**
* The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.
*/
Action?: StackSetOperationAction;
/**
* The overall status of the operation. FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining Regions. QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the stack set operation status codes in the AWS CloudFormation User Guide. RUNNING: The operation is currently being performed. STOPPED: The user has cancelled the operation. STOPPING: The operation is in the process of stopping, at user request. SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
*/
Status?: StackSetOperationStatus;
/**
* The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
*/
CreationTimestamp?: Timestamp;
/**
* The time at which the stack set operation ended, across all accounts and Regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or Region.
*/
EndTimestamp?: Timestamp;
}
export type StackSetStatus = "ACTIVE"|"DELETED"|string;
export type StackSetSummaries = StackSetSummary[];
export interface StackSetSummary {
/**
* The name of the stack set.
*/
StackSetName?: StackSetName;
/**
* The ID of the stack set.
*/
StackSetId?: StackSetId;
/**
* A description of the stack set that you specify when the stack set is created or updated.
*/
Description?: Description;
/**
* The status of the stack set.
*/
Status?: StackSetStatus;
/**
* [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).
*/
AutoDeployment?: AutoDeployment;
/**
* Describes how the IAM roles required for stack set operations are created. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
*/
PermissionModel?: PermissionModels;
/**
* Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration. DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift. IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration. UNKNOWN: This value is reserved for future use.
*/
DriftStatus?: StackDriftStatus;
/**
* Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be NULL for any stack set on which drift detection has not yet been performed.
*/
LastDriftCheckTimestamp?: Timestamp;
}
export type StackStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_FAILED"|"ROLLBACK_COMPLETE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_ROLLBACK_IN_PROGRESS"|"UPDATE_ROLLBACK_FAILED"|"UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"|"UPDATE_ROLLBACK_COMPLETE"|"REVIEW_IN_PROGRESS"|"IMPORT_IN_PROGRESS"|"IMPORT_COMPLETE"|"IMPORT_ROLLBACK_IN_PROGRESS"|"IMPORT_ROLLBACK_FAILED"|"IMPORT_ROLLBACK_COMPLETE"|string;
export type StackStatusFilter = StackStatus[];
export type StackStatusReason = string;
export type StackSummaries = StackSummary[];
export interface StackSummary {
/**
* Unique stack identifier.
*/
StackId?: StackId;
/**
* The name associated with the stack.
*/
StackName: StackName;
/**
* The template description of the template used to create the stack.
*/
TemplateDescription?: TemplateDescription;
/**
* The time the stack was created.
*/
CreationTime: CreationTime;
/**
* The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
*/
LastUpdatedTime?: LastUpdatedTime;
/**
* The time the stack was deleted.
*/
DeletionTime?: DeletionTime;
/**
* The current status of the stack.
*/
StackStatus: StackStatus;
/**
* Success/Failure message associated with the stack status.
*/
StackStatusReason?: StackStatusReason;
/**
* For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
*/
ParentId?: StackId;
/**
* For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.
*/
RootId?: StackId;
/**
* Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
*/
DriftInformation?: StackDriftInformationSummary;
}
export type Stacks = Stack[];
export type StageList = TemplateStage[];
export type StatusMessage = string;
export interface StopStackSetOperationInput {
/**
* The name or unique ID of the stack set that you want to stop the operation for.
*/
StackSetName: StackSetName;
/**
* The ID of the stack operation.
*/
OperationId: ClientRequestToken;
}
export interface StopStackSetOperationOutput {
}
export interface Tag {
/**
* Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.
*/
Key: TagKey;
/**
* Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
*/
Value: TagValue;
}
export type TagKey = string;
export type TagValue = string;
export type Tags = Tag[];
export type TemplateBody = string;
export type TemplateDescription = string;
export interface TemplateParameter {
/**
* The name associated with the parameter.
*/
ParameterKey?: ParameterKey;
/**
* The default value associated with the parameter.
*/
DefaultValue?: ParameterValue;
/**
* Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
*/
NoEcho?: NoEcho;
/**
* User defined description associated with the parameter.
*/
Description?: Description;
}
export type TemplateParameters = TemplateParameter[];
export type TemplateStage = "Original"|"Processed"|string;
export type TemplateURL = string;
export type TimeoutMinutes = number;
export type Timestamp = Date;
export type TotalStackInstancesCount = number;
export type TransformName = string;
export type TransformsList = TransformName[];
export type Type = string;
export type TypeArn = string;
export type TypeName = string;
export type TypeSchema = string;
export type TypeSummaries = TypeSummary[];
export interface TypeSummary {
/**
* The kind of type.
*/
Type?: RegistryType;
/**
* The name of the type.
*/
TypeName?: TypeName;
/**
* The ID of the default version of the type. The default version is used when the type version is not specified. To set the default version of a type, use SetTypeDefaultVersion .
*/
DefaultVersionId?: TypeVersionId;
/**
* The Amazon Resource Name (ARN) of the type.
*/
TypeArn?: TypeArn;
/**
* When the current default version of the type was registered.
*/
LastUpdated?: Timestamp;
/**
* The description of the type.
*/
Description?: Description;
}
export type TypeVersionId = string;
export type TypeVersionSummaries = TypeVersionSummary[];
export interface TypeVersionSummary {
/**
* The kind of type.
*/
Type?: RegistryType;
/**
* The name of the type.
*/
TypeName?: TypeName;
/**
* The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.
*/
VersionId?: TypeVersionId;
/**
* Whether the specified type version is set as the default version.
*/
IsDefaultVersion?: IsDefaultVersion;
/**
* The Amazon Resource Name (ARN) of the type version.
*/
Arn?: TypeArn;
/**
* When the version was registered.
*/
TimeCreated?: Timestamp;
/**
* The description of the type version.
*/
Description?: Description;
}
export interface UpdateStackInput {
/**
* The name or unique stack ID of the stack to update.
*/
StackName: StackName;
/**
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.) Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
*/
TemplateBody?: TemplateBody;
/**
* Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
*/
TemplateURL?: TemplateURL;
/**
* Reuse the existing template that is associated with the stack that you are updating. Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.
*/
UsePreviousTemplate?: UsePreviousTemplate;
/**
* Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
*/
StackPolicyDuringUpdateBody?: StackPolicyDuringUpdateBody;
/**
* Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
*/
StackPolicyDuringUpdateURL?: StackPolicyDuringUpdateURL;
/**
* A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.
*/
Parameters?: Parameters;
/**
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation. Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability. You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs. Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.
*/
Capabilities?: Capabilities;
/**
* The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
*/
ResourceTypes?: ResourceTypes;
/**
* The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege. If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
*/
RoleARN?: RoleARN;
/**
* The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
*/
RollbackConfiguration?: RollbackConfiguration;
/**
* Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
*/
StackPolicyBody?: StackPolicyBody;
/**
* Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
*/
StackPolicyURL?: StackPolicyURL;
/**
* Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
*/
NotificationARNs?: NotificationARNs;
/**
* Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
*/
Tags?: Tags;
/**
* A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them. All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1. In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface UpdateStackInstancesInput {
/**
* The name or unique ID of the stack set associated with the stack instances.
*/
StackSetName: StackSetNameOrId;
/**
* [Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions. You can specify Accounts or DeploymentTargets, but not both.
*/
Accounts?: AccountList;
/**
* [Service-managed permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values. You can specify Accounts or DeploymentTargets, but not both.
*/
DeploymentTargets?: DeploymentTargets;
/**
* The names of one or more Regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.
*/
Regions: RegionList;
/**
* A list of input parameters whose values you want to update for the specified stack instances. Any overridden parameter values will be applied to all stack instances in the specified accounts and Regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations: To override the current value for a parameter, include the parameter and specify its value. To leave a parameter set to its present value, you can do one of the following: Do not include the parameter in the list. Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.) To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters. To leave all parameters set to their present values, do not specify this property at all. During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value. You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
*/
ParameterOverrides?: Parameters;
/**
* Preferences for how AWS CloudFormation performs this stack set operation.
*/
OperationPreferences?: StackSetOperationPreferences;
/**
* The unique identifier for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, the SDK generates one automatically.
*/
OperationId?: ClientRequestToken;
}
export interface UpdateStackInstancesOutput {
/**
* The unique identifier for this stack set operation.
*/
OperationId?: ClientRequestToken;
}
export interface UpdateStackOutput {
/**
* Unique identifier of the stack.
*/
StackId?: StackId;
}
export interface UpdateStackSetInput {
/**
* The name or unique ID of the stack set that you want to update.
*/
StackSetName: StackSetName;
/**
* A brief description of updates that you are making.
*/
Description?: Description;
/**
* The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
*/
TemplateBody?: TemplateBody;
/**
* The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
*/
TemplateURL?: TemplateURL;
/**
* Use the existing template that's associated with the stack set that you're updating. Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.
*/
UsePreviousTemplate?: UsePreviousTemplate;
/**
* A list of input parameters for the stack set template.
*/
Parameters?: Parameters;
/**
* In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances. CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary. AWS::IAM::AccessKey AWS::IAM::Group AWS::IAM::InstanceProfile AWS::IAM::Policy AWS::IAM::Role AWS::IAM::User AWS::IAM::UserToGroupAddition For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates. CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates. Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
*/
Capabilities?: Capabilities;
/**
* The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags. If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means: If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well. If you specify an empty value, AWS CloudFormation removes all currently associated tags. If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.
*/
Tags?: Tags;
/**
* Preferences for how AWS CloudFormation performs this stack set operation.
*/
OperationPreferences?: StackSetOperationPreferences;
/**
* The Amazon Resource Number (ARN) of the IAM role to use to update this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide. If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.
*/
AdministrationRoleARN?: RoleARN;
/**
* The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.
*/
ExecutionRoleName?: ExecutionRoleName;
/**
* [Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances. To update all the stack instances associated with this stack set, do not specify DeploymentTargets or Regions. If the stack set update includes changes to the template (that is, if TemplateBody or TemplateURL is specified), or the Parameters, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
*/
DeploymentTargets?: DeploymentTargets;
/**
* Describes how the IAM roles required for stack set operations are created. You cannot modify PermissionModel if there are stack instances associated with your stack set. With self-managed permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant Self-Managed Stack Set Permissions. With service-managed permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations. For more information, see Grant Service-Managed Stack Set Permissions.
*/
PermissionModel?: PermissionModels;
/**
* [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). If you specify AutoDeployment, do not specify DeploymentTargets or Regions.
*/
AutoDeployment?: AutoDeployment;
/**
* The unique ID for this stack set operation. The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them. If you don't specify an operation ID, AWS CloudFormation generates one automatically. Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.
*/
OperationId?: ClientRequestToken;
/**
* [Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties. If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
*/
Accounts?: AccountList;
/**
* The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances. To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties. If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.
*/
Regions?: RegionList;
}
export interface UpdateStackSetOutput {
/**
* The unique ID for this stack set operation.
*/
OperationId?: ClientRequestToken;
}
export interface UpdateTerminationProtectionInput {
/**
* Whether to enable termination protection on the specified stack.
*/
EnableTerminationProtection: EnableTerminationProtection;
/**
* The name or unique ID of the stack for which you want to set termination protection.
*/
StackName: StackNameOrId;
}
export interface UpdateTerminationProtectionOutput {
/**
* The unique ID of the stack.
*/
StackId?: StackId;
}
export type Url = string;
export type UsePreviousTemplate = boolean;
export type UsePreviousValue = boolean;
export interface ValidateTemplateInput {
/**
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
*/
TemplateBody?: TemplateBody;
/**
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only TemplateBody is used.
*/
TemplateURL?: TemplateURL;
}
export interface ValidateTemplateOutput {
/**
* A list of TemplateParameter structures.
*/
Parameters?: TemplateParameters;
/**
* The description found within the template.
*/
Description?: Description;
/**
* The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
*/
Capabilities?: Capabilities;
/**
* The list of resources that generated the values in the Capabilities response element.
*/
CapabilitiesReason?: CapabilitiesReason;
/**
* A list of the transforms that are declared in the template.
*/
DeclaredTransforms?: TransformsList;
}
export type Value = string;
export type Version = string;
export type Visibility = "PUBLIC"|"PRIVATE"|string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2010-05-15"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the CloudFormation client.
*/
export import Types = CloudFormation;
}
export = CloudFormation;