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 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469
|
# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
require 'seahorse/client/plugins/content_length.rb'
require 'aws-sdk-core/plugins/credentials_configuration.rb'
require 'aws-sdk-core/plugins/logging.rb'
require 'aws-sdk-core/plugins/param_converter.rb'
require 'aws-sdk-core/plugins/param_validator.rb'
require 'aws-sdk-core/plugins/user_agent.rb'
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
require 'aws-sdk-core/plugins/retry_errors.rb'
require 'aws-sdk-core/plugins/global_configuration.rb'
require 'aws-sdk-core/plugins/regional_endpoint.rb'
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
require 'aws-sdk-core/plugins/transfer_encoding.rb'
require 'aws-sdk-core/plugins/http_checksum.rb'
require 'aws-sdk-core/plugins/signature_v4.rb'
require 'aws-sdk-core/plugins/protocols/query.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:cloudformation)
module Aws::CloudFormation
# An API client for CloudFormation. To construct a client, you need to configure a `:region` and `:credentials`.
#
# client = Aws::CloudFormation::Client.new(
# region: region_name,
# credentials: credentials,
# # ...
# )
#
# For details on configuring region and credentials see
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
#
# See {#initialize} for a full list of supported configuration options.
class Client < Seahorse::Client::Base
include Aws::ClientStubs
@identifier = :cloudformation
set_api(ClientApi::API)
add_plugin(Seahorse::Client::Plugins::ContentLength)
add_plugin(Aws::Plugins::CredentialsConfiguration)
add_plugin(Aws::Plugins::Logging)
add_plugin(Aws::Plugins::ParamConverter)
add_plugin(Aws::Plugins::ParamValidator)
add_plugin(Aws::Plugins::UserAgent)
add_plugin(Aws::Plugins::HelpfulSocketErrors)
add_plugin(Aws::Plugins::RetryErrors)
add_plugin(Aws::Plugins::GlobalConfiguration)
add_plugin(Aws::Plugins::RegionalEndpoint)
add_plugin(Aws::Plugins::EndpointDiscovery)
add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
add_plugin(Aws::Plugins::TransferEncoding)
add_plugin(Aws::Plugins::HttpChecksum)
add_plugin(Aws::Plugins::SignatureV4)
add_plugin(Aws::Plugins::Protocols::Query)
# @overload initialize(options)
# @param [Hash] options
# @option options [required, Aws::CredentialProvider] :credentials
# Your AWS credentials. This can be an instance of any one of the
# following classes:
#
# * `Aws::Credentials` - Used for configuring static, non-refreshing
# credentials.
#
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
# from an EC2 IMDS on an EC2 instance.
#
# * `Aws::SharedCredentials` - Used for loading credentials from a
# shared file, such as `~/.aws/config`.
#
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
#
# When `:credentials` are not configured directly, the following
# locations will be searched for credentials:
#
# * `Aws.config[:credentials]`
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
# * `~/.aws/credentials`
# * `~/.aws/config`
# * EC2 IMDS instance profile - When used by default, the timeouts are
# very aggressive. Construct and pass an instance of
# `Aws::InstanceProfileCredentails` to enable retries and extended
# timeouts.
#
# @option options [required, String] :region
# The AWS region to connect to. The configured `:region` is
# used to determine the service `:endpoint`. When not passed,
# a default `:region` is searched for in the following locations:
#
# * `Aws.config[:region]`
# * `ENV['AWS_REGION']`
# * `ENV['AMAZON_REGION']`
# * `ENV['AWS_DEFAULT_REGION']`
# * `~/.aws/credentials`
# * `~/.aws/config`
#
# @option options [String] :access_key_id
#
# @option options [Boolean] :active_endpoint_cache (false)
# When set to `true`, a thread polling for endpoints will be running in
# the background every 60 secs (default). Defaults to `false`.
#
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
# Used only in `adaptive` retry mode. When true, the request will sleep
# until there is sufficent client side capacity to retry the request.
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
# not retry instead of sleeping.
#
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
#
# @option options [String] :client_side_monitoring_client_id ("")
# Allows you to provide an identifier for this client which will be attached to
# all generated client side metrics. Defaults to an empty string.
#
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
# side monitoring agent is running on, where client metrics will be published via UDP.
#
# @option options [Integer] :client_side_monitoring_port (31000)
# Required for publishing client metrics. The port that the client side monitoring
# agent is running on, where client metrics will be published via UDP.
#
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
# Allows you to provide a custom client-side monitoring publisher class. By default,
# will use the Client Side Monitoring Agent Publisher.
#
# @option options [Boolean] :convert_params (true)
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
# @option options [Boolean] :correct_clock_skew (true)
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
# a clock skew correction and retry requests with skewed client clocks.
#
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
#
# @option options [String] :endpoint
# The client endpoint is normally constructed from the `:region`
# option. You should only configure an `:endpoint` when connecting
# to test or custom endpoints. This should be a valid HTTP(S) URI.
#
# @option options [Integer] :endpoint_cache_max_entries (1000)
# Used for the maximum size limit of the LRU cache storing endpoints data
# for endpoint discovery enabled operations. Defaults to 1000.
#
# @option options [Integer] :endpoint_cache_max_threads (10)
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
#
# @option options [Integer] :endpoint_cache_poll_interval (60)
# When :endpoint_discovery and :active_endpoint_cache is enabled,
# Use this option to config the time interval in seconds for making
# requests fetching endpoints information. Defaults to 60 sec.
#
# @option options [Boolean] :endpoint_discovery (false)
# When set to `true`, endpoint discovery will be enabled for operations when available.
#
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
# The log formatter.
#
# @option options [Symbol] :log_level (:info)
# The log level to send messages to the `:logger` at.
#
# @option options [Logger] :logger
# The Logger instance to send log messages to. If this option
# is not set, logging will be disabled.
#
# @option options [Integer] :max_attempts (3)
# An integer representing the maximum number attempts that will be made for
# a single request, including the initial attempt. For example,
# setting this value to 5 will result in a request being retried up to
# 4 times. Used in `standard` and `adaptive` retry modes.
#
# @option options [String] :profile ("default")
# Used when loading credentials from the shared credentials file
# at HOME/.aws/credentials. When not specified, 'default' is used.
#
# @option options [Proc] :retry_backoff
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
# This option is only used in the `legacy` retry mode.
#
# @option options [Float] :retry_base_delay (0.3)
# The base delay in seconds used by the default backoff function. This option
# is only used in the `legacy` retry mode.
#
# @option options [Symbol] :retry_jitter (:none)
# A delay randomiser function used by the default backoff function.
# Some predefined functions can be referenced by name - :none, :equal, :full,
# otherwise a Proc that takes and returns a number. This option is only used
# in the `legacy` retry mode.
#
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
#
# @option options [Integer] :retry_limit (3)
# The maximum number of times to retry failed requests. Only
# ~ 500 level server errors and certain ~ 400 level client errors
# are retried. Generally, these are throttling errors, data
# checksum errors, networking errors, timeout errors, auth errors,
# endpoint discovery, and errors from expired credentials.
# This option is only used in the `legacy` retry mode.
#
# @option options [Integer] :retry_max_delay (0)
# The maximum number of seconds to delay between retries (0 for no limit)
# used by the default backoff function. This option is only used in the
# `legacy` retry mode.
#
# @option options [String] :retry_mode ("legacy")
# Specifies which retry algorithm to use. Values are:
#
# * `legacy` - The pre-existing retry behavior. This is default value if
# no retry mode is provided.
#
# * `standard` - A standardized set of retry rules across the AWS SDKs.
# This includes support for retry quotas, which limit the number of
# unsuccessful retries a client can make.
#
# * `adaptive` - An experimental retry mode that includes all the
# functionality of `standard` mode along with automatic client side
# throttling. This is a provisional mode that may change behavior
# in the future.
#
#
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Boolean] :stub_responses (false)
# Causes the client to return stubbed responses. By default
# fake responses are generated and returned. You can specify
# the response data to return or errors to raise by calling
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
#
# ** Please note ** When response stubbing is enabled, no HTTP
# requests are made, and retries are disabled.
#
# @option options [Boolean] :validate_params (true)
# When `true`, request parameters are validated before
# sending the request.
#
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_open_timeout (15) The number of
# seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
# @option options [Integer] :http_read_timeout (60) The default
# number of seconds to wait for response data. This value can
# safely be set per-request on the session.
#
# @option options [Float] :http_idle_timeout (5) The number of
# seconds a connection is allowed to sit idle before it is
# considered stale. Stale connections are closed and removed
# from the pool before making a request.
#
# @option options [Float] :http_continue_timeout (1) The number of
# seconds to wait for a 100-continue response before sending the
# request body. This option has no effect unless the request has
# "Expect" header set to "100-continue". Defaults to `nil` which
# disables this behaviour. This value can safely be set per
# request on the session.
#
# @option options [Boolean] :http_wire_trace (false) When `true`,
# HTTP debug output will be sent to the `:logger`.
#
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
# SSL peer certificates are verified when establishing a
# connection.
#
# @option options [String] :ssl_ca_bundle Full path to the SSL
# certificate authority bundle file that should be used when
# verifying peer certificates. If you do not pass
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
# will be used if available.
#
# @option options [String] :ssl_ca_directory Full path of the
# directory that contains the unbundled SSL certificate
# authority files for verifying peer certificates. If you do
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
# system default will be used if available.
#
def initialize(*args)
super
end
# @!group API Operations
# 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.
#
# <note markdown="1"> You can cancel only stacks that are in the UPDATE\_IN\_PROGRESS state.
#
# </note>
#
# @option params [required, String] :stack_name
# The name or the unique stack ID that is associated with the stack.
#
# @option params [String] :client_request_token
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.cancel_update_stack({
# stack_name: "StackName", # required
# client_request_token: "ClientRequestToken",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStack AWS API Documentation
#
# @overload cancel_update_stack(params = {})
# @param [Hash] params ({})
def cancel_update_stack(params = {}, options = {})
req = build_request(:cancel_update_stack, params)
req.send_request(options)
end
# 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][1] 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.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed
#
# @option params [required, String] :stack_name
# The name or the unique ID of the stack that you want to continue
# rolling back.
#
# <note markdown="1"> 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).
#
# </note>
#
# @option params [String] :role_arn
# 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.
#
# @option params [Array<String>] :resources_to_skip
# 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][1] 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`.
#
# <note markdown="1"> 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][2].
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks
#
# @option params [String] :client_request_token
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.continue_update_rollback({
# stack_name: "StackNameOrId", # required
# role_arn: "RoleARN",
# resources_to_skip: ["ResourceToSkip"],
# client_request_token: "ClientRequestToken",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ContinueUpdateRollback AWS API Documentation
#
# @overload continue_update_rollback(params = {})
# @param [Hash] params ({})
def continue_update_rollback(params = {}, options = {})
req = build_request(:continue_update_rollback, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# 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.
#
# @option params [String] :template_body
# 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`.
#
# @option params [String] :template_url
# 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`.
#
# @option params [Boolean] :use_previous_template
# Whether to reuse the template that is associated with the stack to
# create the change set.
#
# @option params [Array<Types::Parameter>] :parameters
# A list of `Parameter` structures that specify input parameters for the
# change set. For more information, see the Parameter data type.
#
# @option params [Array<String>] :capabilities
# 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][1]
#
# * [ AWS::IAM::Group][2]
#
# * [ AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
# * [ AWS::IAM::Role][5]
#
# * [ AWS::IAM::User][6]
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
# For more information, see [Acknowledging IAM Resources in AWS
# CloudFormation Templates][8].
#
# * `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][9] and
# [AWS::Serverless][10] transforms, which are macros hosted by AWS
# CloudFormation.
#
# <note markdown="1"> 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.
#
# </note>
#
# For more information on macros, see [Using AWS CloudFormation Macros
# to Perform Custom Processing on Templates][11].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
# [8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
# [9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
# [10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
# [11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
#
# @option params [Array<String>] :resource_types
# 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][1] in the
# AWS CloudFormation User Guide.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
#
# @option params [String] :role_arn
# 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.
#
# @option params [Types::RollbackConfiguration] :rollback_configuration
# The rollback triggers for AWS CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
#
# @option params [Array<String>] :notification_arns
# 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.
#
# @option params [Array<Types::Tag>] :tags
# 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.
#
# @option params [required, String] :change_set_name
# 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.
#
# @option params [String] :client_token
# 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.
#
# @option params [String] :description
# A description to help you identify this change set.
#
# @option params [String] :change_set_type
# 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` ][1] 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.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995
#
# @option params [Array<Types::ResourceToImport>] :resources_to_import
# The resources to import into your stack.
#
# @return [Types::CreateChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateChangeSetOutput#id #id} => String
# * {Types::CreateChangeSetOutput#stack_id #stack_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_change_set({
# stack_name: "StackNameOrId", # required
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# use_previous_template: false,
# parameters: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
# resource_types: ["ResourceType"],
# role_arn: "RoleARN",
# rollback_configuration: {
# rollback_triggers: [
# {
# arn: "Arn", # required
# type: "Type", # required
# },
# ],
# monitoring_time_in_minutes: 1,
# },
# notification_arns: ["NotificationARN"],
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
# },
# ],
# change_set_name: "ChangeSetName", # required
# client_token: "ClientToken",
# description: "Description",
# change_set_type: "CREATE", # accepts CREATE, UPDATE, IMPORT
# resources_to_import: [
# {
# resource_type: "ResourceType", # required
# logical_resource_id: "LogicalResourceId", # required
# resource_identifier: { # required
# "ResourceIdentifierPropertyKey" => "ResourceIdentifierPropertyValue",
# },
# },
# ],
# })
#
# @example Response structure
#
# resp.id #=> String
# resp.stack_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet AWS API Documentation
#
# @overload create_change_set(params = {})
# @param [Hash] params ({})
def create_change_set(params = {}, options = {})
req = build_request(:create_change_set, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# The name that is associated with the stack. The name must be unique in
# the Region in which you are creating the stack.
#
# <note markdown="1"> 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.
#
# </note>
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1] in the
# AWS CloudFormation User Guide.
#
# Conditional: You must specify either the `TemplateBody` or the
# `TemplateURL` parameter, but not both.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [Array<Types::Parameter>] :parameters
# A list of `Parameter` structures that specify input parameters for the
# stack. For more information, see the [Parameter][1] data type.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html
#
# @option params [Boolean] :disable_rollback
# 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`
#
# @option params [Types::RollbackConfiguration] :rollback_configuration
# The rollback triggers for AWS CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
#
# @option params [Integer] :timeout_in_minutes
# 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.
#
# @option params [Array<String>] :notification_arns
# 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).
#
# @option params [Array<String>] :capabilities
# 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][1]
#
# * [ AWS::IAM::Group][2]
#
# * [ AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
# * [ AWS::IAM::Role][5]
#
# * [ AWS::IAM::User][6]
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
# For more information, see [Acknowledging IAM Resources in AWS
# CloudFormation Templates][8].
#
# * `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][9] and
# [AWS::Serverless][10] 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][11].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
# [8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
# [9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
# [10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
# [11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
#
# @option params [Array<String>] :resource_types
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
#
# @option params [String] :role_arn
# 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.
#
# @option params [String] :on_failure
# 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`
#
# @option params [String] :stack_policy_body
# Structure containing the stack policy body. For more information, go
# to [ Prevent Updates to Stack Resources][1] in the *AWS CloudFormation
# User Guide*. You can specify either the `StackPolicyBody` or the
# `StackPolicyURL` parameter, but not both.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html
#
# @option params [String] :stack_policy_url
# 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.
#
# @option params [Array<Types::Tag>] :tags
# 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.
#
# @option params [String] :client_request_token
# 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`.
#
# @option params [Boolean] :enable_termination_protection
# 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][1] in the
# *AWS CloudFormation User Guide*. Termination protection is disabled on
# stacks by default.
#
# For [nested stacks][2], termination protection is set on the root
# stack and cannot be changed directly on the nested stack.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
# [2]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
#
# @return [Types::CreateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStackOutput#stack_id #stack_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_stack({
# stack_name: "StackName", # required
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# parameters: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# disable_rollback: false,
# rollback_configuration: {
# rollback_triggers: [
# {
# arn: "Arn", # required
# type: "Type", # required
# },
# ],
# monitoring_time_in_minutes: 1,
# },
# timeout_in_minutes: 1,
# notification_arns: ["NotificationARN"],
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
# resource_types: ["ResourceType"],
# role_arn: "RoleARN",
# on_failure: "DO_NOTHING", # accepts DO_NOTHING, ROLLBACK, DELETE
# stack_policy_body: "StackPolicyBody",
# stack_policy_url: "StackPolicyURL",
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
# },
# ],
# client_request_token: "ClientRequestToken",
# enable_termination_protection: false,
# })
#
# @example Response structure
#
# resp.stack_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStack AWS API Documentation
#
# @overload create_stack(params = {})
# @param [Hash] params ({})
def create_stack(params = {}, options = {})
req = build_request(:create_stack, params)
req.send_request(options)
end
# 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`.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to create stack
# instances from.
#
# @option params [Array<String>] :accounts
# \[`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.
#
# @option params [Types::DeploymentTargets] :deployment_targets
# \[`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.
#
# @option params [required, Array<String>] :regions
# The names of one or more Regions where you want to create stack
# instances using the specified AWS account(s).
#
# @option params [Array<Types::Parameter>] :parameter_overrides
# 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][1] to update the stack set template.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
# Preferences for how AWS CloudFormation performs this stack set
# operation.
#
# @option params [String] :operation_id
# 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`.
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
# @return [Types::CreateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStackInstancesOutput#operation_id #operation_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_stack_instances({
# stack_set_name: "StackSetName", # required
# accounts: ["Account"],
# deployment_targets: {
# accounts: ["Account"],
# organizational_unit_ids: ["OrganizationalUnitId"],
# },
# regions: ["Region"], # required
# parameter_overrides: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# operation_preferences: {
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
# max_concurrent_count: 1,
# max_concurrent_percentage: 1,
# },
# operation_id: "ClientRequestToken",
# })
#
# @example Response structure
#
# resp.operation_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstances AWS API Documentation
#
# @overload create_stack_instances(params = {})
# @param [Hash] params ({})
def create_stack_instances(params = {}, options = {})
req = build_request(:create_stack_instances, params)
req.send_request(options)
end
# Creates a stack set.
#
# @option params [required, String] :stack_set_name
# The name to associate with the stack set. The name must be unique in
# the Region where you create your stack set.
#
# <note markdown="1"> 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.
#
# </note>
#
# @option params [String] :description
# A description of the stack set. You can use the description to
# identify the stack set's purpose or other important information.
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must specify either the TemplateBody or the
# TemplateURL parameter, but not both.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1]
# in the AWS CloudFormation User Guide.
#
# Conditional: You must specify either the TemplateBody or the
# TemplateURL parameter, but not both.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [Array<Types::Parameter>] :parameters
# The input parameters for the stack set template.
#
# @option params [Array<String>] :capabilities
# 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][1]
#
# * [ AWS::IAM::Group][2]
#
# * [ AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
# * [ AWS::IAM::Role][5]
#
# * [ AWS::IAM::User][6]
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
# For more information, see [Acknowledging IAM Resources in AWS
# CloudFormation Templates][8].
#
# * `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][9].
#
# <note markdown="1"> Stack sets do not currently support macros in stack templates. (This
# includes the [AWS::Include][10] and [AWS::Serverless][11]
# 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.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
# [8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
# [9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
# [10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
# [11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
#
# @option params [Array<Types::Tag>] :tags
# 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.
#
# @option params [String] :administration_role_arn
# 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][1] in
# the *AWS CloudFormation User Guide*.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
#
# @option params [String] :execution_role_name
# 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.
#
# @option params [String] :permission_model
# 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][1].
#
# * 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][2].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
#
# @option params [Types::AutoDeployment] :auto_deployment
# 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`.
#
# @option params [String] :client_request_token
# 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.
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
# @return [Types::CreateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateStackSetOutput#stack_set_id #stack_set_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.create_stack_set({
# stack_set_name: "StackSetName", # required
# description: "Description",
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# parameters: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
# },
# ],
# administration_role_arn: "RoleARN",
# execution_role_name: "ExecutionRoleName",
# permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
# auto_deployment: {
# enabled: false,
# retain_stacks_on_account_removal: false,
# },
# client_request_token: "ClientRequestToken",
# })
#
# @example Response structure
#
# resp.stack_set_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSet AWS API Documentation
#
# @overload create_stack_set(params = {})
# @param [Hash] params ({})
def create_stack_set(params = {}, options = {})
req = build_request(:create_stack_set, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :change_set_name
# The name or Amazon Resource Name (ARN) of the change set that you want
# to delete.
#
# @option params [String] :stack_name
# If you specified the name of a change set to delete, specify the stack
# name or ID (ARN) that is associated with it.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_change_set({
# change_set_name: "ChangeSetNameOrId", # required
# stack_name: "StackNameOrId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteChangeSet AWS API Documentation
#
# @overload delete_change_set(params = {})
# @param [Hash] params ({})
def delete_change_set(params = {}, options = {})
req = build_request(:delete_change_set, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# The name or the unique stack ID that is associated with the stack.
#
# @option params [Array<String>] :retain_resources
# 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.
#
# @option params [String] :role_arn
# 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.
#
# @option params [String] :client_request_token
# 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`.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_stack({
# stack_name: "StackName", # required
# retain_resources: ["LogicalResourceId"],
# role_arn: "RoleARN",
# client_request_token: "ClientRequestToken",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStack AWS API Documentation
#
# @overload delete_stack(params = {})
# @param [Hash] params ({})
def delete_stack(params = {}, options = {})
req = build_request(:delete_stack, params)
req.send_request(options)
end
# Deletes stack instances for the specified accounts, in the specified
# Regions.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to delete stack
# instances for.
#
# @option params [Array<String>] :accounts
# \[`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.
#
# @option params [Types::DeploymentTargets] :deployment_targets
# \[`Service-managed` permissions\] The AWS Organizations accounts from
# which to delete stack instances.
#
# You can specify `Accounts` or `DeploymentTargets`, but not both.
#
# @option params [required, Array<String>] :regions
# The Regions where you want to delete stack set instances.
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
# Preferences for how AWS CloudFormation performs this stack set
# operation.
#
# @option params [required, Boolean] :retain_stacks
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
#
# @option params [String] :operation_id
# 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`.
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
# @return [Types::DeleteStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteStackInstancesOutput#operation_id #operation_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.delete_stack_instances({
# stack_set_name: "StackSetName", # required
# accounts: ["Account"],
# deployment_targets: {
# accounts: ["Account"],
# organizational_unit_ids: ["OrganizationalUnitId"],
# },
# regions: ["Region"], # required
# operation_preferences: {
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
# max_concurrent_count: 1,
# max_concurrent_percentage: 1,
# },
# retain_stacks: false, # required
# operation_id: "ClientRequestToken",
# })
#
# @example Response structure
#
# resp.operation_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstances AWS API Documentation
#
# @overload delete_stack_instances(params = {})
# @param [Hash] params ({})
def delete_stack_instances(params = {}, options = {})
req = build_request(:delete_stack_instances, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you're deleting. You can
# obtain this value by running ListStackSets.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.delete_stack_set({
# stack_set_name: "StackSetName", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet AWS API Documentation
#
# @overload delete_stack_set(params = {})
# @param [Hash] params ({})
def delete_stack_set(params = {}, options = {})
req = build_request(:delete_stack_set, params)
req.send_request(options)
end
# 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.
#
# @option params [String] :arn
# The Amazon Resource Name (ARN) of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type
# The kind of type.
#
# Currently the only valid value is `RESOURCE`.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
# The name of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :version_id
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.deregister_type({
# arn: "PrivateTypeArn",
# type: "RESOURCE", # accepts RESOURCE
# type_name: "TypeName",
# version_id: "TypeVersionId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeregisterType AWS API Documentation
#
# @overload deregister_type(params = {})
# @param [Hash] params ({})
def deregister_type(params = {}, options = {})
req = build_request(:deregister_type, params)
req.send_request(options)
end
# 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][1]
# in the *AWS CloudFormation User Guide*.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html
#
# @option params [String] :next_token
# A string that identifies the next page of limits that you want to
# retrieve.
#
# @return [Types::DescribeAccountLimitsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeAccountLimitsOutput#account_limits #account_limits} => Array<Types::AccountLimit>
# * {Types::DescribeAccountLimitsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.describe_account_limits({
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.account_limits #=> Array
# resp.account_limits[0].name #=> String
# resp.account_limits[0].value #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeAccountLimits AWS API Documentation
#
# @overload describe_account_limits(params = {})
# @param [Hash] params ({})
def describe_account_limits(params = {}, options = {})
req = build_request(:describe_account_limits, params)
req.send_request(options)
end
# 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][1] in the AWS
# CloudFormation User Guide.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html
#
# @option params [required, String] :change_set_name
# The name or Amazon Resource Name (ARN) of the change set that you want
# to describe.
#
# @option params [String] :stack_name
# If you specified the name of a change set, specify the stack name or
# ID (ARN) of the change set you want to describe.
#
# @option params [String] :next_token
# A string (provided by the DescribeChangeSet response output) that
# identifies the next page of information that you want to retrieve.
#
# @return [Types::DescribeChangeSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeChangeSetOutput#change_set_name #change_set_name} => String
# * {Types::DescribeChangeSetOutput#change_set_id #change_set_id} => String
# * {Types::DescribeChangeSetOutput#stack_id #stack_id} => String
# * {Types::DescribeChangeSetOutput#stack_name #stack_name} => String
# * {Types::DescribeChangeSetOutput#description #description} => String
# * {Types::DescribeChangeSetOutput#parameters #parameters} => Array<Types::Parameter>
# * {Types::DescribeChangeSetOutput#creation_time #creation_time} => Time
# * {Types::DescribeChangeSetOutput#execution_status #execution_status} => String
# * {Types::DescribeChangeSetOutput#status #status} => String
# * {Types::DescribeChangeSetOutput#status_reason #status_reason} => String
# * {Types::DescribeChangeSetOutput#notification_arns #notification_arns} => Array<String>
# * {Types::DescribeChangeSetOutput#rollback_configuration #rollback_configuration} => Types::RollbackConfiguration
# * {Types::DescribeChangeSetOutput#capabilities #capabilities} => Array<String>
# * {Types::DescribeChangeSetOutput#tags #tags} => Array<Types::Tag>
# * {Types::DescribeChangeSetOutput#changes #changes} => Array<Types::Change>
# * {Types::DescribeChangeSetOutput#next_token #next_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.describe_change_set({
# change_set_name: "ChangeSetNameOrId", # required
# stack_name: "StackNameOrId",
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.change_set_name #=> String
# resp.change_set_id #=> String
# resp.stack_id #=> String
# resp.stack_name #=> String
# resp.description #=> String
# resp.parameters #=> Array
# resp.parameters[0].parameter_key #=> String
# resp.parameters[0].parameter_value #=> String
# resp.parameters[0].use_previous_value #=> Boolean
# resp.parameters[0].resolved_value #=> String
# resp.creation_time #=> Time
# resp.execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
# resp.status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED"
# resp.status_reason #=> String
# resp.notification_arns #=> Array
# resp.notification_arns[0] #=> String
# resp.rollback_configuration.rollback_triggers #=> Array
# resp.rollback_configuration.rollback_triggers[0].arn #=> String
# resp.rollback_configuration.rollback_triggers[0].type #=> String
# resp.rollback_configuration.monitoring_time_in_minutes #=> Integer
# resp.capabilities #=> Array
# resp.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
# resp.tags #=> Array
# resp.tags[0].key #=> String
# resp.tags[0].value #=> String
# resp.changes #=> Array
# resp.changes[0].type #=> String, one of "Resource"
# resp.changes[0].resource_change.action #=> String, one of "Add", "Modify", "Remove", "Import"
# resp.changes[0].resource_change.logical_resource_id #=> String
# resp.changes[0].resource_change.physical_resource_id #=> String
# resp.changes[0].resource_change.resource_type #=> String
# resp.changes[0].resource_change.replacement #=> String, one of "True", "False", "Conditional"
# resp.changes[0].resource_change.scope #=> Array
# resp.changes[0].resource_change.scope[0] #=> String, one of "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "Tags"
# resp.changes[0].resource_change.details #=> Array
# resp.changes[0].resource_change.details[0].target.attribute #=> String, one of "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "Tags"
# resp.changes[0].resource_change.details[0].target.name #=> String
# resp.changes[0].resource_change.details[0].target.requires_recreation #=> String, one of "Never", "Conditionally", "Always"
# resp.changes[0].resource_change.details[0].evaluation #=> String, one of "Static", "Dynamic"
# resp.changes[0].resource_change.details[0].change_source #=> String, one of "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic"
# resp.changes[0].resource_change.details[0].causing_entity #=> String
# resp.next_token #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * change_set_create_complete
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSet AWS API Documentation
#
# @overload describe_change_set(params = {})
# @param [Hash] params ({})
def describe_change_set(params = {}, options = {})
req = build_request(:describe_change_set, params)
req.send_request(options)
end
# 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][1].
#
# 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.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
#
# @option params [required, String] :stack_drift_detection_id
# 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.
#
# @return [Types::DescribeStackDriftDetectionStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackDriftDetectionStatusOutput#stack_id #stack_id} => String
# * {Types::DescribeStackDriftDetectionStatusOutput#stack_drift_detection_id #stack_drift_detection_id} => String
# * {Types::DescribeStackDriftDetectionStatusOutput#stack_drift_status #stack_drift_status} => String
# * {Types::DescribeStackDriftDetectionStatusOutput#detection_status #detection_status} => String
# * {Types::DescribeStackDriftDetectionStatusOutput#detection_status_reason #detection_status_reason} => String
# * {Types::DescribeStackDriftDetectionStatusOutput#drifted_stack_resource_count #drifted_stack_resource_count} => Integer
# * {Types::DescribeStackDriftDetectionStatusOutput#timestamp #timestamp} => Time
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_drift_detection_status({
# stack_drift_detection_id: "StackDriftDetectionId", # required
# })
#
# @example Response structure
#
# resp.stack_id #=> String
# resp.stack_drift_detection_id #=> String
# resp.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.detection_status #=> String, one of "DETECTION_IN_PROGRESS", "DETECTION_FAILED", "DETECTION_COMPLETE"
# resp.detection_status_reason #=> String
# resp.drifted_stack_resource_count #=> Integer
# resp.timestamp #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus AWS API Documentation
#
# @overload describe_stack_drift_detection_status(params = {})
# @param [Hash] params ({})
def describe_stack_drift_detection_status(params = {}, options = {})
req = build_request(:describe_stack_drift_detection_status, params)
req.send_request(options)
end
# 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][1] in the AWS CloudFormation User Guide.
#
# <note markdown="1"> You can list events for stacks that have failed to create or have been
# deleted by specifying the unique stack identifier (stack ID).
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
#
# @option params [String] :stack_name
# 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.
#
# @option params [String] :next_token
# A string that identifies the next page of events that you want to
# retrieve.
#
# @return [Types::DescribeStackEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackEventsOutput#stack_events #stack_events} => Array<Types::StackEvent>
# * {Types::DescribeStackEventsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_events({
# stack_name: "StackName",
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.stack_events #=> Array
# resp.stack_events[0].stack_id #=> String
# resp.stack_events[0].event_id #=> String
# resp.stack_events[0].stack_name #=> String
# resp.stack_events[0].logical_resource_id #=> String
# resp.stack_events[0].physical_resource_id #=> String
# resp.stack_events[0].resource_type #=> String
# resp.stack_events[0].timestamp #=> Time
# resp.stack_events[0].resource_status #=> String, one of "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"
# resp.stack_events[0].resource_status_reason #=> String
# resp.stack_events[0].resource_properties #=> String
# resp.stack_events[0].client_request_token #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents AWS API Documentation
#
# @overload describe_stack_events(params = {})
# @param [Hash] params ({})
def describe_stack_events(params = {}, options = {})
req = build_request(:describe_stack_events, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_set_name
# The name or the unique stack ID of the stack set that you want to get
# stack instance information for.
#
# @option params [required, String] :stack_instance_account
# The ID of an AWS account that's associated with this stack instance.
#
# @option params [required, String] :stack_instance_region
# The name of a Region that's associated with this stack instance.
#
# @return [Types::DescribeStackInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackInstanceOutput#stack_instance #stack_instance} => Types::StackInstance
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_instance({
# stack_set_name: "StackSetName", # required
# stack_instance_account: "Account", # required
# stack_instance_region: "Region", # required
# })
#
# @example Response structure
#
# resp.stack_instance.stack_set_id #=> String
# resp.stack_instance.region #=> String
# resp.stack_instance.account #=> String
# resp.stack_instance.stack_id #=> String
# resp.stack_instance.parameter_overrides #=> Array
# resp.stack_instance.parameter_overrides[0].parameter_key #=> String
# resp.stack_instance.parameter_overrides[0].parameter_value #=> String
# resp.stack_instance.parameter_overrides[0].use_previous_value #=> Boolean
# resp.stack_instance.parameter_overrides[0].resolved_value #=> String
# resp.stack_instance.status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
# resp.stack_instance.stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE"
# resp.stack_instance.status_reason #=> String
# resp.stack_instance.organizational_unit_id #=> String
# resp.stack_instance.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.stack_instance.last_drift_check_timestamp #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstance AWS API Documentation
#
# @overload describe_stack_instance(params = {})
# @param [Hash] params ({})
def describe_stack_instance(params = {}, options = {})
req = build_request(:describe_stack_instance, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# 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.
#
# @option params [required, String] :logical_resource_id
# The logical name of the resource as specified in the template.
#
# Default: There is no default value.
#
# @return [Types::DescribeStackResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackResourceOutput#stack_resource_detail #stack_resource_detail} => Types::StackResourceDetail
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_resource({
# stack_name: "StackName", # required
# logical_resource_id: "LogicalResourceId", # required
# })
#
# @example Response structure
#
# resp.stack_resource_detail.stack_name #=> String
# resp.stack_resource_detail.stack_id #=> String
# resp.stack_resource_detail.logical_resource_id #=> String
# resp.stack_resource_detail.physical_resource_id #=> String
# resp.stack_resource_detail.resource_type #=> String
# resp.stack_resource_detail.last_updated_timestamp #=> Time
# resp.stack_resource_detail.resource_status #=> String, one of "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"
# resp.stack_resource_detail.resource_status_reason #=> String
# resp.stack_resource_detail.description #=> String
# resp.stack_resource_detail.metadata #=> String
# resp.stack_resource_detail.drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_detail.drift_information.last_check_timestamp #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResource AWS API Documentation
#
# @overload describe_stack_resource(params = {})
# @param [Hash] params ({})
def describe_stack_resource(params = {}, options = {})
req = build_request(:describe_stack_resource, params)
req.send_request(options)
end
# 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][1].
#
# Use DetectStackResourceDrift to detect drift on individual resources,
# or DetectStackDrift to detect drift on all supported resources for a
# given stack.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html
#
# @option params [required, String] :stack_name
# The name of the stack for which you want drift information.
#
# @option params [Array<String>] :stack_resource_drift_status_filters
# 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.
#
# @option params [String] :next_token
# A string that identifies the next page of stack resource drift
# results.
#
# @option params [Integer] :max_results
# 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.
#
# @return [Types::DescribeStackResourceDriftsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackResourceDriftsOutput#stack_resource_drifts #stack_resource_drifts} => Array<Types::StackResourceDrift>
# * {Types::DescribeStackResourceDriftsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_resource_drifts({
# stack_name: "StackNameOrId", # required
# stack_resource_drift_status_filters: ["IN_SYNC"], # accepts IN_SYNC, MODIFIED, DELETED, NOT_CHECKED
# next_token: "NextToken",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.stack_resource_drifts #=> Array
# resp.stack_resource_drifts[0].stack_id #=> String
# resp.stack_resource_drifts[0].logical_resource_id #=> String
# resp.stack_resource_drifts[0].physical_resource_id #=> String
# resp.stack_resource_drifts[0].physical_resource_id_context #=> Array
# resp.stack_resource_drifts[0].physical_resource_id_context[0].key #=> String
# resp.stack_resource_drifts[0].physical_resource_id_context[0].value #=> String
# resp.stack_resource_drifts[0].resource_type #=> String
# resp.stack_resource_drifts[0].expected_properties #=> String
# resp.stack_resource_drifts[0].actual_properties #=> String
# resp.stack_resource_drifts[0].property_differences #=> Array
# resp.stack_resource_drifts[0].property_differences[0].property_path #=> String
# resp.stack_resource_drifts[0].property_differences[0].expected_value #=> String
# resp.stack_resource_drifts[0].property_differences[0].actual_value #=> String
# resp.stack_resource_drifts[0].property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
# resp.stack_resource_drifts[0].stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_drifts[0].timestamp #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResourceDrifts AWS API Documentation
#
# @overload describe_stack_resource_drifts(params = {})
# @param [Hash] params ({})
def describe_stack_resource_drifts(params = {}, options = {})
req = build_request(:describe_stack_resource_drifts, params)
req.send_request(options)
end
# 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.
#
# <note markdown="1"> Only the first 100 resources will be returned. If your stack has more
# resources than this, you should use `ListStackResources` instead.
#
# </note>
#
# 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][1].
#
# <note markdown="1"> A `ValidationError` is returned if you specify both `StackName` and
# `PhysicalResourceId` in the same request.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/
#
# @option params [String] :stack_name
# 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`.
#
# @option params [String] :logical_resource_id
# The logical name of the resource as specified in the template.
#
# Default: There is no default value.
#
# @option params [String] :physical_resource_id
# 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.
#
# @return [Types::DescribeStackResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackResourcesOutput#stack_resources #stack_resources} => Array<Types::StackResource>
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_resources({
# stack_name: "StackName",
# logical_resource_id: "LogicalResourceId",
# physical_resource_id: "PhysicalResourceId",
# })
#
# @example Response structure
#
# resp.stack_resources #=> Array
# resp.stack_resources[0].stack_name #=> String
# resp.stack_resources[0].stack_id #=> String
# resp.stack_resources[0].logical_resource_id #=> String
# resp.stack_resources[0].physical_resource_id #=> String
# resp.stack_resources[0].resource_type #=> String
# resp.stack_resources[0].timestamp #=> Time
# resp.stack_resources[0].resource_status #=> String, one of "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"
# resp.stack_resources[0].resource_status_reason #=> String
# resp.stack_resources[0].description #=> String
# resp.stack_resources[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resources[0].drift_information.last_check_timestamp #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResources AWS API Documentation
#
# @overload describe_stack_resources(params = {})
# @param [Hash] params ({})
def describe_stack_resources(params = {}, options = {})
req = build_request(:describe_stack_resources, params)
req.send_request(options)
end
# Returns the description of the specified stack set.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set whose description you want.
#
# @return [Types::DescribeStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackSetOutput#stack_set #stack_set} => Types::StackSet
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_set({
# stack_set_name: "StackSetName", # required
# })
#
# @example Response structure
#
# resp.stack_set.stack_set_name #=> String
# resp.stack_set.stack_set_id #=> String
# resp.stack_set.description #=> String
# resp.stack_set.status #=> String, one of "ACTIVE", "DELETED"
# resp.stack_set.template_body #=> String
# resp.stack_set.parameters #=> Array
# resp.stack_set.parameters[0].parameter_key #=> String
# resp.stack_set.parameters[0].parameter_value #=> String
# resp.stack_set.parameters[0].use_previous_value #=> Boolean
# resp.stack_set.parameters[0].resolved_value #=> String
# resp.stack_set.capabilities #=> Array
# resp.stack_set.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
# resp.stack_set.tags #=> Array
# resp.stack_set.tags[0].key #=> String
# resp.stack_set.tags[0].value #=> String
# resp.stack_set.stack_set_arn #=> String
# resp.stack_set.administration_role_arn #=> String
# resp.stack_set.execution_role_name #=> String
# resp.stack_set.stack_set_drift_detection_details.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKED"
# resp.stack_set.stack_set_drift_detection_details.drift_detection_status #=> String, one of "COMPLETED", "FAILED", "PARTIAL_SUCCESS", "IN_PROGRESS", "STOPPED"
# resp.stack_set.stack_set_drift_detection_details.last_drift_check_timestamp #=> Time
# resp.stack_set.stack_set_drift_detection_details.total_stack_instances_count #=> Integer
# resp.stack_set.stack_set_drift_detection_details.drifted_stack_instances_count #=> Integer
# resp.stack_set.stack_set_drift_detection_details.in_sync_stack_instances_count #=> Integer
# resp.stack_set.stack_set_drift_detection_details.in_progress_stack_instances_count #=> Integer
# resp.stack_set.stack_set_drift_detection_details.failed_stack_instances_count #=> Integer
# resp.stack_set.auto_deployment.enabled #=> Boolean
# resp.stack_set.auto_deployment.retain_stacks_on_account_removal #=> Boolean
# resp.stack_set.permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
# resp.stack_set.organizational_unit_ids #=> Array
# resp.stack_set.organizational_unit_ids[0] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSet AWS API Documentation
#
# @overload describe_stack_set(params = {})
# @param [Hash] params ({})
def describe_stack_set(params = {}, options = {})
req = build_request(:describe_stack_set, params)
req.send_request(options)
end
# Returns the description of the specified stack set operation.
#
# @option params [required, String] :stack_set_name
# The name or the unique stack ID of the stack set for the stack
# operation.
#
# @option params [required, String] :operation_id
# The unique ID of the stack set operation.
#
# @return [Types::DescribeStackSetOperationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStackSetOperationOutput#stack_set_operation #stack_set_operation} => Types::StackSetOperation
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stack_set_operation({
# stack_set_name: "StackSetName", # required
# operation_id: "ClientRequestToken", # required
# })
#
# @example Response structure
#
# resp.stack_set_operation.operation_id #=> String
# resp.stack_set_operation.stack_set_id #=> String
# resp.stack_set_operation.action #=> String, one of "CREATE", "UPDATE", "DELETE", "DETECT_DRIFT"
# resp.stack_set_operation.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED", "QUEUED"
# resp.stack_set_operation.operation_preferences.region_order #=> Array
# resp.stack_set_operation.operation_preferences.region_order[0] #=> String
# resp.stack_set_operation.operation_preferences.failure_tolerance_count #=> Integer
# resp.stack_set_operation.operation_preferences.failure_tolerance_percentage #=> Integer
# resp.stack_set_operation.operation_preferences.max_concurrent_count #=> Integer
# resp.stack_set_operation.operation_preferences.max_concurrent_percentage #=> Integer
# resp.stack_set_operation.retain_stacks #=> Boolean
# resp.stack_set_operation.administration_role_arn #=> String
# resp.stack_set_operation.execution_role_name #=> String
# resp.stack_set_operation.creation_timestamp #=> Time
# resp.stack_set_operation.end_timestamp #=> Time
# resp.stack_set_operation.deployment_targets.accounts #=> Array
# resp.stack_set_operation.deployment_targets.accounts[0] #=> String
# resp.stack_set_operation.deployment_targets.organizational_unit_ids #=> Array
# resp.stack_set_operation.deployment_targets.organizational_unit_ids[0] #=> String
# resp.stack_set_operation.stack_set_drift_detection_details.drift_status #=> String, one of "DRIFTED", "IN_SYNC", "NOT_CHECKED"
# resp.stack_set_operation.stack_set_drift_detection_details.drift_detection_status #=> String, one of "COMPLETED", "FAILED", "PARTIAL_SUCCESS", "IN_PROGRESS", "STOPPED"
# resp.stack_set_operation.stack_set_drift_detection_details.last_drift_check_timestamp #=> Time
# resp.stack_set_operation.stack_set_drift_detection_details.total_stack_instances_count #=> Integer
# resp.stack_set_operation.stack_set_drift_detection_details.drifted_stack_instances_count #=> Integer
# resp.stack_set_operation.stack_set_drift_detection_details.in_sync_stack_instances_count #=> Integer
# resp.stack_set_operation.stack_set_drift_detection_details.in_progress_stack_instances_count #=> Integer
# resp.stack_set_operation.stack_set_drift_detection_details.failed_stack_instances_count #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperation AWS API Documentation
#
# @overload describe_stack_set_operation(params = {})
# @param [Hash] params ({})
def describe_stack_set_operation(params = {}, options = {})
req = build_request(:describe_stack_set_operation, params)
req.send_request(options)
end
# Returns the description for the specified stack; if no stack name was
# specified, then it returns the description for all the stacks created.
#
# <note markdown="1"> If the stack does not exist, an `AmazonCloudFormationException` is
# returned.
#
# </note>
#
# @option params [String] :stack_name
# 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.
#
# @option params [String] :next_token
# A string that identifies the next page of stacks that you want to
# retrieve.
#
# @return [Types::DescribeStacksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeStacksOutput#stacks #stacks} => Array<Types::Stack>
# * {Types::DescribeStacksOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.describe_stacks({
# stack_name: "StackName",
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.stacks #=> Array
# resp.stacks[0].stack_id #=> String
# resp.stacks[0].stack_name #=> String
# resp.stacks[0].change_set_id #=> String
# resp.stacks[0].description #=> String
# resp.stacks[0].parameters #=> Array
# resp.stacks[0].parameters[0].parameter_key #=> String
# resp.stacks[0].parameters[0].parameter_value #=> String
# resp.stacks[0].parameters[0].use_previous_value #=> Boolean
# resp.stacks[0].parameters[0].resolved_value #=> String
# resp.stacks[0].creation_time #=> Time
# resp.stacks[0].deletion_time #=> Time
# resp.stacks[0].last_updated_time #=> Time
# resp.stacks[0].rollback_configuration.rollback_triggers #=> Array
# resp.stacks[0].rollback_configuration.rollback_triggers[0].arn #=> String
# resp.stacks[0].rollback_configuration.rollback_triggers[0].type #=> String
# resp.stacks[0].rollback_configuration.monitoring_time_in_minutes #=> Integer
# resp.stacks[0].stack_status #=> String, one of "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"
# resp.stacks[0].stack_status_reason #=> String
# resp.stacks[0].disable_rollback #=> Boolean
# resp.stacks[0].notification_arns #=> Array
# resp.stacks[0].notification_arns[0] #=> String
# resp.stacks[0].timeout_in_minutes #=> Integer
# resp.stacks[0].capabilities #=> Array
# resp.stacks[0].capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
# resp.stacks[0].outputs #=> Array
# resp.stacks[0].outputs[0].output_key #=> String
# resp.stacks[0].outputs[0].output_value #=> String
# resp.stacks[0].outputs[0].description #=> String
# resp.stacks[0].outputs[0].export_name #=> String
# resp.stacks[0].role_arn #=> String
# resp.stacks[0].tags #=> Array
# resp.stacks[0].tags[0].key #=> String
# resp.stacks[0].tags[0].value #=> String
# resp.stacks[0].enable_termination_protection #=> Boolean
# resp.stacks[0].parent_id #=> String
# resp.stacks[0].root_id #=> String
# resp.stacks[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.stacks[0].drift_information.last_check_timestamp #=> Time
# resp.next_token #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * stack_create_complete
# * stack_delete_complete
# * stack_exists
# * stack_import_complete
# * stack_rollback_complete
# * stack_update_complete
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStacks AWS API Documentation
#
# @overload describe_stacks(params = {})
# @param [Hash] params ({})
def describe_stacks(params = {}, options = {})
req = build_request(:describe_stacks, params)
req.send_request(options)
end
# 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.
#
# @option params [String] :type
# The kind of type.
#
# Currently the only valid value is `RESOURCE`.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
# The name of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :arn
# The Amazon Resource Name (ARN) of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :version_id
# 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.
#
# @return [Types::DescribeTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeTypeOutput#arn #arn} => String
# * {Types::DescribeTypeOutput#type #type} => String
# * {Types::DescribeTypeOutput#type_name #type_name} => String
# * {Types::DescribeTypeOutput#default_version_id #default_version_id} => String
# * {Types::DescribeTypeOutput#is_default_version #is_default_version} => Boolean
# * {Types::DescribeTypeOutput#description #description} => String
# * {Types::DescribeTypeOutput#schema #schema} => String
# * {Types::DescribeTypeOutput#provisioning_type #provisioning_type} => String
# * {Types::DescribeTypeOutput#deprecated_status #deprecated_status} => String
# * {Types::DescribeTypeOutput#logging_config #logging_config} => Types::LoggingConfig
# * {Types::DescribeTypeOutput#execution_role_arn #execution_role_arn} => String
# * {Types::DescribeTypeOutput#visibility #visibility} => String
# * {Types::DescribeTypeOutput#source_url #source_url} => String
# * {Types::DescribeTypeOutput#documentation_url #documentation_url} => String
# * {Types::DescribeTypeOutput#last_updated #last_updated} => Time
# * {Types::DescribeTypeOutput#time_created #time_created} => Time
#
# @example Request syntax with placeholder values
#
# resp = client.describe_type({
# type: "RESOURCE", # accepts RESOURCE
# type_name: "TypeName",
# arn: "TypeArn",
# version_id: "TypeVersionId",
# })
#
# @example Response structure
#
# resp.arn #=> String
# resp.type #=> String, one of "RESOURCE"
# resp.type_name #=> String
# resp.default_version_id #=> String
# resp.is_default_version #=> Boolean
# resp.description #=> String
# resp.schema #=> String
# resp.provisioning_type #=> String, one of "NON_PROVISIONABLE", "IMMUTABLE", "FULLY_MUTABLE"
# resp.deprecated_status #=> String, one of "LIVE", "DEPRECATED"
# resp.logging_config.log_role_arn #=> String
# resp.logging_config.log_group_name #=> String
# resp.execution_role_arn #=> String
# resp.visibility #=> String, one of "PUBLIC", "PRIVATE"
# resp.source_url #=> String
# resp.documentation_url #=> String
# resp.last_updated #=> Time
# resp.time_created #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeType AWS API Documentation
#
# @overload describe_type(params = {})
# @param [Hash] params ({})
def describe_type(params = {}, options = {})
req = build_request(:describe_type, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :registration_token
# The identifier for this registration request.
#
# This registration token is generated by CloudFormation when you
# initiate a registration request using ` RegisterType `.
#
# @return [Types::DescribeTypeRegistrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DescribeTypeRegistrationOutput#progress_status #progress_status} => String
# * {Types::DescribeTypeRegistrationOutput#description #description} => String
# * {Types::DescribeTypeRegistrationOutput#type_arn #type_arn} => String
# * {Types::DescribeTypeRegistrationOutput#type_version_arn #type_version_arn} => String
#
# @example Request syntax with placeholder values
#
# resp = client.describe_type_registration({
# registration_token: "RegistrationToken", # required
# })
#
# @example Response structure
#
# resp.progress_status #=> String, one of "COMPLETE", "IN_PROGRESS", "FAILED"
# resp.description #=> String
# resp.type_arn #=> String
# resp.type_version_arn #=> String
#
#
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
#
# * type_registration_complete
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeRegistration AWS API Documentation
#
# @overload describe_type_registration(params = {})
# @param [Hash] params ({})
def describe_type_registration(params = {}, options = {})
req = build_request(:describe_type_registration, params)
req.send_request(options)
end
# 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][1].
#
# 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][2].
#
# `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.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html
#
# @option params [required, String] :stack_name
# The name of the stack for which you want to detect drift.
#
# @option params [Array<String>] :logical_resource_ids
# The logical names of any resources you want to use as filters.
#
# @return [Types::DetectStackDriftOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DetectStackDriftOutput#stack_drift_detection_id #stack_drift_detection_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.detect_stack_drift({
# stack_name: "StackNameOrId", # required
# logical_resource_ids: ["LogicalResourceId"],
# })
#
# @example Response structure
#
# resp.stack_drift_detection_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackDrift AWS API Documentation
#
# @overload detect_stack_drift(params = {})
# @param [Hash] params ({})
def detect_stack_drift(params = {}, options = {})
req = build_request(:detect_stack_drift, params)
req.send_request(options)
end
# 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][1].
#
# 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][2].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html
#
# @option params [required, String] :stack_name
# The name of the stack to which the resource belongs.
#
# @option params [required, String] :logical_resource_id
# The logical name of the resource for which to return drift
# information.
#
# @return [Types::DetectStackResourceDriftOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DetectStackResourceDriftOutput#stack_resource_drift #stack_resource_drift} => Types::StackResourceDrift
#
# @example Request syntax with placeholder values
#
# resp = client.detect_stack_resource_drift({
# stack_name: "StackNameOrId", # required
# logical_resource_id: "LogicalResourceId", # required
# })
#
# @example Response structure
#
# resp.stack_resource_drift.stack_id #=> String
# resp.stack_resource_drift.logical_resource_id #=> String
# resp.stack_resource_drift.physical_resource_id #=> String
# resp.stack_resource_drift.physical_resource_id_context #=> Array
# resp.stack_resource_drift.physical_resource_id_context[0].key #=> String
# resp.stack_resource_drift.physical_resource_id_context[0].value #=> String
# resp.stack_resource_drift.resource_type #=> String
# resp.stack_resource_drift.expected_properties #=> String
# resp.stack_resource_drift.actual_properties #=> String
# resp.stack_resource_drift.property_differences #=> Array
# resp.stack_resource_drift.property_differences[0].property_path #=> String
# resp.stack_resource_drift.property_differences[0].expected_value #=> String
# resp.stack_resource_drift.property_differences[0].actual_value #=> String
# resp.stack_resource_drift.property_differences[0].difference_type #=> String, one of "ADD", "REMOVE", "NOT_EQUAL"
# resp.stack_resource_drift.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_drift.timestamp #=> Time
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackResourceDrift AWS API Documentation
#
# @overload detect_stack_resource_drift(params = {})
# @param [Hash] params ({})
def detect_stack_resource_drift(params = {}, options = {})
req = build_request(:detect_stack_resource_drift, params)
req.send_request(options)
end
# 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][1].
#
# `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][1].
#
# 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 `.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
#
# @option params [required, String] :stack_set_name
# The name of the stack set on which to perform the drift detection
# operation.
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
# The user-specified preferences for how AWS CloudFormation performs a
# stack set operation.
#
# For more information on maximum concurrent accounts and failure
# tolerance, see [Stack set operation options][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
#
# @option params [String] :operation_id
# *The ID of the stack set operation.*
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
# @return [Types::DetectStackSetDriftOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DetectStackSetDriftOutput#operation_id #operation_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.detect_stack_set_drift({
# stack_set_name: "StackSetNameOrId", # required
# operation_preferences: {
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
# max_concurrent_count: 1,
# max_concurrent_percentage: 1,
# },
# operation_id: "ClientRequestToken",
# })
#
# @example Response structure
#
# resp.operation_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackSetDrift AWS API Documentation
#
# @overload detect_stack_set_drift(params = {})
# @param [Hash] params ({})
def detect_stack_set_drift(params = {}, options = {})
req = build_request(:detect_stack_set_drift, params)
req.send_request(options)
end
# 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.
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User Guide.)
#
# Conditional: You must pass `TemplateBody` or `TemplateURL`. If both
# are passed, only `TemplateBody` is used.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [Array<Types::Parameter>] :parameters
# A list of `Parameter` structures that specify input parameters.
#
# @return [Types::EstimateTemplateCostOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::EstimateTemplateCostOutput#url #url} => String
#
# @example Request syntax with placeholder values
#
# resp = client.estimate_template_cost({
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# parameters: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# })
#
# @example Response structure
#
# resp.url #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCost AWS API Documentation
#
# @overload estimate_template_cost(params = {})
# @param [Hash] params ({})
def estimate_template_cost(params = {}, options = {})
req = build_request(:estimate_template_cost, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :change_set_name
# The name or ARN of the change set that you want use to update the
# specified stack.
#
# @option params [String] :stack_name
# 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.
#
# @option params [String] :client_request_token
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.execute_change_set({
# change_set_name: "ChangeSetNameOrId", # required
# stack_name: "StackNameOrId",
# client_request_token: "ClientRequestToken",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSet AWS API Documentation
#
# @overload execute_change_set(params = {})
# @param [Hash] params ({})
def execute_change_set(params = {}, options = {})
req = build_request(:execute_change_set, params)
req.send_request(options)
end
# Returns the stack policy for a specified stack. If a stack doesn't
# have a policy, a null value is returned.
#
# @option params [required, String] :stack_name
# The name or unique stack ID that is associated with the stack whose
# policy you want to get.
#
# @return [Types::GetStackPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetStackPolicyOutput#stack_policy_body #stack_policy_body} => String
#
# @example Request syntax with placeholder values
#
# resp = client.get_stack_policy({
# stack_name: "StackName", # required
# })
#
# @example Response structure
#
# resp.stack_policy_body #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetStackPolicy AWS API Documentation
#
# @overload get_stack_policy(params = {})
# @param [Hash] params ({})
def get_stack_policy(params = {}, options = {})
req = build_request(:get_stack_policy, params)
req.send_request(options)
end
# 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.
#
# <note markdown="1"> If the template does not exist, a `ValidationError` is returned.
#
# </note>
#
# @option params [String] :stack_name
# 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.
#
# @option params [String] :change_set_name
# 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`.
#
# @option params [String] :template_stage
# 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`.
#
# @return [Types::GetTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTemplateOutput#template_body #template_body} => String
# * {Types::GetTemplateOutput#stages_available #stages_available} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.get_template({
# stack_name: "StackName",
# change_set_name: "ChangeSetNameOrId",
# template_stage: "Original", # accepts Original, Processed
# })
#
# @example Response structure
#
# resp.template_body #=> String
# resp.stages_available #=> Array
# resp.stages_available[0] #=> String, one of "Original", "Processed"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplate AWS API Documentation
#
# @overload get_template(params = {})
# @param [Hash] params ({})
def get_template(params = {}, options = {})
req = build_request(:get_template, params)
req.send_request(options)
end
# 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.
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User
# Guide.
#
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `StackName`, `StackSetName`, `TemplateBody`, or `TemplateURL`.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :stack_name
# 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`.
#
# @option params [String] :stack_set_name
# 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`.
#
# @return [Types::GetTemplateSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetTemplateSummaryOutput#parameters #parameters} => Array<Types::ParameterDeclaration>
# * {Types::GetTemplateSummaryOutput#description #description} => String
# * {Types::GetTemplateSummaryOutput#capabilities #capabilities} => Array<String>
# * {Types::GetTemplateSummaryOutput#capabilities_reason #capabilities_reason} => String
# * {Types::GetTemplateSummaryOutput#resource_types #resource_types} => Array<String>
# * {Types::GetTemplateSummaryOutput#version #version} => String
# * {Types::GetTemplateSummaryOutput#metadata #metadata} => String
# * {Types::GetTemplateSummaryOutput#declared_transforms #declared_transforms} => Array<String>
# * {Types::GetTemplateSummaryOutput#resource_identifier_summaries #resource_identifier_summaries} => Array<Types::ResourceIdentifierSummary>
#
# @example Request syntax with placeholder values
#
# resp = client.get_template_summary({
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# stack_name: "StackNameOrId",
# stack_set_name: "StackSetNameOrId",
# })
#
# @example Response structure
#
# resp.parameters #=> Array
# resp.parameters[0].parameter_key #=> String
# resp.parameters[0].default_value #=> String
# resp.parameters[0].parameter_type #=> String
# resp.parameters[0].no_echo #=> Boolean
# resp.parameters[0].description #=> String
# resp.parameters[0].parameter_constraints.allowed_values #=> Array
# resp.parameters[0].parameter_constraints.allowed_values[0] #=> String
# resp.description #=> String
# resp.capabilities #=> Array
# resp.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
# resp.capabilities_reason #=> String
# resp.resource_types #=> Array
# resp.resource_types[0] #=> String
# resp.version #=> String
# resp.metadata #=> String
# resp.declared_transforms #=> Array
# resp.declared_transforms[0] #=> String
# resp.resource_identifier_summaries #=> Array
# resp.resource_identifier_summaries[0].resource_type #=> String
# resp.resource_identifier_summaries[0].logical_resource_ids #=> Array
# resp.resource_identifier_summaries[0].logical_resource_ids[0] #=> String
# resp.resource_identifier_summaries[0].resource_identifiers #=> Array
# resp.resource_identifier_summaries[0].resource_identifiers[0] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateSummary AWS API Documentation
#
# @overload get_template_summary(params = {})
# @param [Hash] params ({})
def get_template_summary(params = {}, options = {})
req = build_request(:get_template_summary, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# The name or the Amazon Resource Name (ARN) of the stack for which you
# want to list change sets.
#
# @option params [String] :next_token
# A string (provided by the ListChangeSets response output) that
# identifies the next page of change sets that you want to retrieve.
#
# @return [Types::ListChangeSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListChangeSetsOutput#summaries #summaries} => Array<Types::ChangeSetSummary>
# * {Types::ListChangeSetsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_change_sets({
# stack_name: "StackNameOrId", # required
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.summaries #=> Array
# resp.summaries[0].stack_id #=> String
# resp.summaries[0].stack_name #=> String
# resp.summaries[0].change_set_id #=> String
# resp.summaries[0].change_set_name #=> String
# resp.summaries[0].execution_status #=> String, one of "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE"
# resp.summaries[0].status #=> String, one of "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED"
# resp.summaries[0].status_reason #=> String
# resp.summaries[0].creation_time #=> Time
# resp.summaries[0].description #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSets AWS API Documentation
#
# @overload list_change_sets(params = {})
# @param [Hash] params ({})
def list_change_sets(params = {}, options = {})
req = build_request(:list_change_sets, params)
req.send_request(options)
end
# 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` ][1] function.
#
# For more information, see [ AWS CloudFormation Export Stack Output
# Values][2].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html
#
# @option params [String] :next_token
# A string (provided by the ListExports response output) that identifies
# the next page of exported output values that you asked to retrieve.
#
# @return [Types::ListExportsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListExportsOutput#exports #exports} => Array<Types::Export>
# * {Types::ListExportsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_exports({
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.exports #=> Array
# resp.exports[0].exporting_stack_id #=> String
# resp.exports[0].name #=> String
# resp.exports[0].value #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListExports AWS API Documentation
#
# @overload list_exports(params = {})
# @param [Hash] params ({})
def list_exports(params = {}, options = {})
req = build_request(:list_exports, params)
req.send_request(options)
end
# 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` ][1] function.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html
#
# @option params [required, String] :export_name
# The name of the exported output value. AWS CloudFormation returns the
# stack names that are importing this value.
#
# @option params [String] :next_token
# A string (provided by the ListImports response output) that identifies
# the next page of stacks that are importing the specified exported
# output value.
#
# @return [Types::ListImportsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListImportsOutput#imports #imports} => Array<String>
# * {Types::ListImportsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_imports({
# export_name: "ExportName", # required
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.imports #=> Array
# resp.imports[0] #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListImports AWS API Documentation
#
# @overload list_imports(params = {})
# @param [Hash] params ({})
def list_imports(params = {}, options = {})
req = build_request(:list_imports, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to list stack
# instances for.
#
# @option params [String] :next_token
# 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`.
#
# @option params [Integer] :max_results
# 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.
#
# @option params [Array<Types::StackInstanceFilter>] :filters
# The status that stack instances are filtered by.
#
# @option params [String] :stack_instance_account
# The name of the AWS account that you want to list stack instances for.
#
# @option params [String] :stack_instance_region
# The name of the Region where you want to list stack instances.
#
# @return [Types::ListStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackInstancesOutput#summaries #summaries} => Array<Types::StackInstanceSummary>
# * {Types::ListStackInstancesOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_stack_instances({
# stack_set_name: "StackSetName", # required
# next_token: "NextToken",
# max_results: 1,
# filters: [
# {
# name: "DETAILED_STATUS", # accepts DETAILED_STATUS
# values: "StackInstanceFilterValues",
# },
# ],
# stack_instance_account: "Account",
# stack_instance_region: "Region",
# })
#
# @example Response structure
#
# resp.summaries #=> Array
# resp.summaries[0].stack_set_id #=> String
# resp.summaries[0].region #=> String
# resp.summaries[0].account #=> String
# resp.summaries[0].stack_id #=> String
# resp.summaries[0].status #=> String, one of "CURRENT", "OUTDATED", "INOPERABLE"
# resp.summaries[0].status_reason #=> String
# resp.summaries[0].stack_instance_status.detailed_status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INOPERABLE"
# resp.summaries[0].organizational_unit_id #=> String
# resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.summaries[0].last_drift_check_timestamp #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstances AWS API Documentation
#
# @overload list_stack_instances(params = {})
# @param [Hash] params ({})
def list_stack_instances(params = {}, options = {})
req = build_request(:list_stack_instances, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# 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.
#
# @option params [String] :next_token
# A string that identifies the next page of stack resources that you
# want to retrieve.
#
# @return [Types::ListStackResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackResourcesOutput#stack_resource_summaries #stack_resource_summaries} => Array<Types::StackResourceSummary>
# * {Types::ListStackResourcesOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_stack_resources({
# stack_name: "StackName", # required
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.stack_resource_summaries #=> Array
# resp.stack_resource_summaries[0].logical_resource_id #=> String
# resp.stack_resource_summaries[0].physical_resource_id #=> String
# resp.stack_resource_summaries[0].resource_type #=> String
# resp.stack_resource_summaries[0].last_updated_timestamp #=> Time
# resp.stack_resource_summaries[0].resource_status #=> String, one of "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"
# resp.stack_resource_summaries[0].resource_status_reason #=> String
# resp.stack_resource_summaries[0].drift_information.stack_resource_drift_status #=> String, one of "IN_SYNC", "MODIFIED", "DELETED", "NOT_CHECKED"
# resp.stack_resource_summaries[0].drift_information.last_check_timestamp #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackResources AWS API Documentation
#
# @overload list_stack_resources(params = {})
# @param [Hash] params ({})
def list_stack_resources(params = {}, options = {})
req = build_request(:list_stack_resources, params)
req.send_request(options)
end
# Returns summary information about the results of a stack set
# operation.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to get operation
# results for.
#
# @option params [required, String] :operation_id
# The ID of the stack set operation.
#
# @option params [String] :next_token
# 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`.
#
# @option params [Integer] :max_results
# 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.
#
# @return [Types::ListStackSetOperationResultsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackSetOperationResultsOutput#summaries #summaries} => Array<Types::StackSetOperationResultSummary>
# * {Types::ListStackSetOperationResultsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_stack_set_operation_results({
# stack_set_name: "StackSetName", # required
# operation_id: "ClientRequestToken", # required
# next_token: "NextToken",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.summaries #=> Array
# resp.summaries[0].account #=> String
# resp.summaries[0].region #=> String
# resp.summaries[0].status #=> String, one of "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED"
# resp.summaries[0].status_reason #=> String
# resp.summaries[0].account_gate_result.status #=> String, one of "SUCCEEDED", "FAILED", "SKIPPED"
# resp.summaries[0].account_gate_result.status_reason #=> String
# resp.summaries[0].organizational_unit_id #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationResults AWS API Documentation
#
# @overload list_stack_set_operation_results(params = {})
# @param [Hash] params ({})
def list_stack_set_operation_results(params = {}, options = {})
req = build_request(:list_stack_set_operation_results, params)
req.send_request(options)
end
# Returns summary information about operations performed on a stack set.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to get operation
# summaries for.
#
# @option params [String] :next_token
# 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`.
#
# @option params [Integer] :max_results
# 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.
#
# @return [Types::ListStackSetOperationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackSetOperationsOutput#summaries #summaries} => Array<Types::StackSetOperationSummary>
# * {Types::ListStackSetOperationsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_stack_set_operations({
# stack_set_name: "StackSetName", # required
# next_token: "NextToken",
# max_results: 1,
# })
#
# @example Response structure
#
# resp.summaries #=> Array
# resp.summaries[0].operation_id #=> String
# resp.summaries[0].action #=> String, one of "CREATE", "UPDATE", "DELETE", "DETECT_DRIFT"
# resp.summaries[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "STOPPING", "STOPPED", "QUEUED"
# resp.summaries[0].creation_timestamp #=> Time
# resp.summaries[0].end_timestamp #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperations AWS API Documentation
#
# @overload list_stack_set_operations(params = {})
# @param [Hash] params ({})
def list_stack_set_operations(params = {}, options = {})
req = build_request(:list_stack_set_operations, params)
req.send_request(options)
end
# Returns summary information about stack sets that are associated with
# the user.
#
# @option params [String] :next_token
# 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`.
#
# @option params [Integer] :max_results
# 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.
#
# @option params [String] :status
# The status of the stack sets that you want to get summary information
# about.
#
# @return [Types::ListStackSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStackSetsOutput#summaries #summaries} => Array<Types::StackSetSummary>
# * {Types::ListStackSetsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_stack_sets({
# next_token: "NextToken",
# max_results: 1,
# status: "ACTIVE", # accepts ACTIVE, DELETED
# })
#
# @example Response structure
#
# resp.summaries #=> Array
# resp.summaries[0].stack_set_name #=> String
# resp.summaries[0].stack_set_id #=> String
# resp.summaries[0].description #=> String
# resp.summaries[0].status #=> String, one of "ACTIVE", "DELETED"
# resp.summaries[0].auto_deployment.enabled #=> Boolean
# resp.summaries[0].auto_deployment.retain_stacks_on_account_removal #=> Boolean
# resp.summaries[0].permission_model #=> String, one of "SERVICE_MANAGED", "SELF_MANAGED"
# resp.summaries[0].drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.summaries[0].last_drift_check_timestamp #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSets AWS API Documentation
#
# @overload list_stack_sets(params = {})
# @param [Hash] params ({})
def list_stack_sets(params = {}, options = {})
req = build_request(:list_stack_sets, params)
req.send_request(options)
end
# 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).
#
# @option params [String] :next_token
# A string that identifies the next page of stacks that you want to
# retrieve.
#
# @option params [Array<String>] :stack_status_filter
# 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.
#
# @return [Types::ListStacksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListStacksOutput#stack_summaries #stack_summaries} => Array<Types::StackSummary>
# * {Types::ListStacksOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_stacks({
# next_token: "NextToken",
# stack_status_filter: ["CREATE_IN_PROGRESS"], # accepts 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
# })
#
# @example Response structure
#
# resp.stack_summaries #=> Array
# resp.stack_summaries[0].stack_id #=> String
# resp.stack_summaries[0].stack_name #=> String
# resp.stack_summaries[0].template_description #=> String
# resp.stack_summaries[0].creation_time #=> Time
# resp.stack_summaries[0].last_updated_time #=> Time
# resp.stack_summaries[0].deletion_time #=> Time
# resp.stack_summaries[0].stack_status #=> String, one of "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"
# resp.stack_summaries[0].stack_status_reason #=> String
# resp.stack_summaries[0].parent_id #=> String
# resp.stack_summaries[0].root_id #=> String
# resp.stack_summaries[0].drift_information.stack_drift_status #=> String, one of "DRIFTED", "IN_SYNC", "UNKNOWN", "NOT_CHECKED"
# resp.stack_summaries[0].drift_information.last_check_timestamp #=> Time
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStacks AWS API Documentation
#
# @overload list_stacks(params = {})
# @param [Hash] params ({})
def list_stacks(params = {}, options = {})
req = build_request(:list_stacks, params)
req.send_request(options)
end
# Returns a list of registration tokens for the specified type(s).
#
# @option params [String] :type
# The kind of type.
#
# Currently the only valid value is `RESOURCE`.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
# The name of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_arn
# The Amazon Resource Name (ARN) of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :registration_status_filter
# The current status of the type registration request.
#
# The default is `IN_PROGRESS`.
#
# @option params [Integer] :max_results
# 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.
#
# @option params [String] :next_token
# 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`.
#
# @return [Types::ListTypeRegistrationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTypeRegistrationsOutput#registration_token_list #registration_token_list} => Array<String>
# * {Types::ListTypeRegistrationsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_type_registrations({
# type: "RESOURCE", # accepts RESOURCE
# type_name: "TypeName",
# type_arn: "TypeArn",
# registration_status_filter: "COMPLETE", # accepts COMPLETE, IN_PROGRESS, FAILED
# max_results: 1,
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.registration_token_list #=> Array
# resp.registration_token_list[0] #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeRegistrations AWS API Documentation
#
# @overload list_type_registrations(params = {})
# @param [Hash] params ({})
def list_type_registrations(params = {}, options = {})
req = build_request(:list_type_registrations, params)
req.send_request(options)
end
# Returns summary information about the versions of a type.
#
# @option params [String] :type
# The kind of the type.
#
# Currently the only valid value is `RESOURCE`.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
# The name of the type for which you want version summary information.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :arn
# 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`.
#
# @option params [Integer] :max_results
# 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.
#
# @option params [String] :next_token
# 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`.
#
# @option params [String] :deprecated_status
# 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`.
#
# @return [Types::ListTypeVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTypeVersionsOutput#type_version_summaries #type_version_summaries} => Array<Types::TypeVersionSummary>
# * {Types::ListTypeVersionsOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_type_versions({
# type: "RESOURCE", # accepts RESOURCE
# type_name: "TypeName",
# arn: "PrivateTypeArn",
# max_results: 1,
# next_token: "NextToken",
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
# })
#
# @example Response structure
#
# resp.type_version_summaries #=> Array
# resp.type_version_summaries[0].type #=> String, one of "RESOURCE"
# resp.type_version_summaries[0].type_name #=> String
# resp.type_version_summaries[0].version_id #=> String
# resp.type_version_summaries[0].is_default_version #=> Boolean
# resp.type_version_summaries[0].arn #=> String
# resp.type_version_summaries[0].time_created #=> Time
# resp.type_version_summaries[0].description #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions AWS API Documentation
#
# @overload list_type_versions(params = {})
# @param [Hash] params ({})
def list_type_versions(params = {}, options = {})
req = build_request(:list_type_versions, params)
req.send_request(options)
end
# Returns summary information about types that have been registered with
# CloudFormation.
#
# @option params [String] :visibility
# 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`.
#
# @option params [String] :provisioning_type
# 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.
#
# @option params [String] :deprecated_status
# 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.
#
# @option params [Integer] :max_results
# 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.
#
# @option params [String] :next_token
# 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`.
#
# @return [Types::ListTypesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListTypesOutput#type_summaries #type_summaries} => Array<Types::TypeSummary>
# * {Types::ListTypesOutput#next_token #next_token} => String
#
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
#
# @example Request syntax with placeholder values
#
# resp = client.list_types({
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
# provisioning_type: "NON_PROVISIONABLE", # accepts NON_PROVISIONABLE, IMMUTABLE, FULLY_MUTABLE
# deprecated_status: "LIVE", # accepts LIVE, DEPRECATED
# max_results: 1,
# next_token: "NextToken",
# })
#
# @example Response structure
#
# resp.type_summaries #=> Array
# resp.type_summaries[0].type #=> String, one of "RESOURCE"
# resp.type_summaries[0].type_name #=> String
# resp.type_summaries[0].default_version_id #=> String
# resp.type_summaries[0].type_arn #=> String
# resp.type_summaries[0].last_updated #=> Time
# resp.type_summaries[0].description #=> String
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypes AWS API Documentation
#
# @overload list_types(params = {})
# @param [Hash] params ({})
def list_types(params = {}, options = {})
req = build_request(:list_types, params)
req.send_request(options)
end
# Reports progress of a resource handler to CloudFormation.
#
# Reserved for use by the [CloudFormation CLI][1]. Do not use this API
# in your code.
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [required, String] :bearer_token
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [required, String] :operation_status
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [String] :current_operation_status
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [String] :status_message
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [String] :error_code
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [String] :resource_model
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @option params [String] :client_request_token
# Reserved for use by the [CloudFormation CLI][1].
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.record_handler_progress({
# bearer_token: "ClientToken", # required
# operation_status: "PENDING", # required, accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
# current_operation_status: "PENDING", # accepts PENDING, IN_PROGRESS, SUCCESS, FAILED
# status_message: "StatusMessage",
# error_code: "NotUpdatable", # accepts NotUpdatable, InvalidRequest, AccessDenied, InvalidCredentials, AlreadyExists, NotFound, ResourceConflict, Throttling, ServiceLimitExceeded, NotStabilized, GeneralServiceException, ServiceInternalError, NetworkFailure, InternalFailure
# resource_model: "ResourceModel",
# client_request_token: "ClientRequestToken",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RecordHandlerProgress AWS API Documentation
#
# @overload record_handler_progress(params = {})
# @param [Hash] params ({})
def record_handler_progress(params = {}, options = {})
req = build_request(:record_handler_progress, params)
req.send_request(options)
end
# 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][1] 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](AWSCloudFormation/latest/APIReference/API_DeregisterType.html)
# 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.
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html
#
# @option params [String] :type
# The kind of type.
#
# Currently, the only valid value is `RESOURCE`.
#
# @option params [required, String] :type_name
# The name of the type being registered.
#
# We recommend that type names adhere to the following pattern:
# *company\_or\_organization*\::*service*\::*type*.
#
# <note markdown="1"> The following organization namespaces are reserved and cannot be used
# in your resource type names:
#
# * `Alexa`
#
# * `AMZN`
#
# * `Amazon`
#
# * `AWS`
#
# * `Custom`
#
# * `Dev`
#
# </note>
#
# @option params [required, String] :schema_handler_package
# 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][1] in the *CloudFormation CLI User
# Guide*.
#
# <note markdown="1"> 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][2] in the *AWS
# CloudFormation User Guide*.
#
# </note>
#
#
#
# [1]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register-permissions
#
# @option params [Types::LoggingConfig] :logging_config
# Specifies logging configuration information for a type.
#
# @option params [String] :execution_role_arn
# 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 <i> <a
# href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM
# execution role</a> </i> 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.
#
# @option params [String] :client_request_token
# 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.
#
# @return [Types::RegisterTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RegisterTypeOutput#registration_token #registration_token} => String
#
# @example Request syntax with placeholder values
#
# resp = client.register_type({
# type: "RESOURCE", # accepts RESOURCE
# type_name: "TypeName", # required
# schema_handler_package: "S3Url", # required
# logging_config: {
# log_role_arn: "RoleArn", # required
# log_group_name: "LogGroupName", # required
# },
# execution_role_arn: "RoleArn",
# client_request_token: "RequestToken",
# })
#
# @example Response structure
#
# resp.registration_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterType AWS API Documentation
#
# @overload register_type(params = {})
# @param [Hash] params ({})
def register_type(params = {}, options = {})
req = build_request(:register_type, params)
req.send_request(options)
end
# Sets a stack policy for a specified stack.
#
# @option params [required, String] :stack_name
# The name or unique stack ID that you want to associate a policy with.
#
# @option params [String] :stack_policy_body
# Structure containing the stack policy body. For more information, go
# to [ Prevent Updates to Stack Resources][1] in the AWS CloudFormation
# User Guide. You can specify either the `StackPolicyBody` or the
# `StackPolicyURL` parameter, but not both.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html
#
# @option params [String] :stack_policy_url
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.set_stack_policy({
# stack_name: "StackName", # required
# stack_policy_body: "StackPolicyBody",
# stack_policy_url: "StackPolicyURL",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetStackPolicy AWS API Documentation
#
# @overload set_stack_policy(params = {})
# @param [Hash] params ({})
def set_stack_policy(params = {}, options = {})
req = build_request(:set_stack_policy, params)
req.send_request(options)
end
# Specify the default version of a type. The default version of a type
# will be used in CloudFormation operations.
#
# @option params [String] :arn
# 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`.
#
# @option params [String] :type
# The kind of type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :type_name
# The name of the type.
#
# Conditional: You must specify either `TypeName` and `Type`, or `Arn`.
#
# @option params [String] :version_id
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.set_type_default_version({
# arn: "PrivateTypeArn",
# type: "RESOURCE", # accepts RESOURCE
# type_name: "TypeName",
# version_id: "TypeVersionId",
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersion AWS API Documentation
#
# @overload set_type_default_version(params = {})
# @param [Hash] params ({})
def set_type_default_version(params = {}, options = {})
req = build_request(:set_type_default_version, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_name
# The stack name or unique stack ID that includes the resource that you
# want to signal.
#
# @option params [required, String] :logical_resource_id
# 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.
#
# @option params [required, String] :unique_id
# 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.
#
# @option params [required, String] :status
# 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.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.signal_resource({
# stack_name: "StackNameOrId", # required
# logical_resource_id: "LogicalResourceId", # required
# unique_id: "ResourceSignalUniqueId", # required
# status: "SUCCESS", # required, accepts SUCCESS, FAILURE
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResource AWS API Documentation
#
# @overload signal_resource(params = {})
# @param [Hash] params ({})
def signal_resource(params = {}, options = {})
req = build_request(:signal_resource, params)
req.send_request(options)
end
# Stops an in-progress operation on a stack set and its associated stack
# instances.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to stop the
# operation for.
#
# @option params [required, String] :operation_id
# The ID of the stack operation.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
# resp = client.stop_stack_set_operation({
# stack_set_name: "StackSetName", # required
# operation_id: "ClientRequestToken", # required
# })
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation AWS API Documentation
#
# @overload stop_stack_set_operation(params = {})
# @param [Hash] params ({})
def stop_stack_set_operation(params = {}, options = {})
req = build_request(:stop_stack_set_operation, params)
req.send_request(options)
end
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html
#
# @option params [required, String] :stack_name
# The name or unique stack ID of the stack to update.
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User Guide.)
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
# `true`.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody`, `TemplateURL`, or set the `UsePreviousTemplate` to
# `true`.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [Boolean] :use_previous_template
# 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`.
#
# @option params [String] :stack_policy_during_update_body
# 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.
#
# @option params [String] :stack_policy_during_update_url
# 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.
#
# @option params [Array<Types::Parameter>] :parameters
# A list of `Parameter` structures that specify input parameters for the
# stack. For more information, see the [Parameter][1] data type.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html
#
# @option params [Array<String>] :capabilities
# 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][1]
#
# * [ AWS::IAM::Group][2]
#
# * [ AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
# * [ AWS::IAM::Role][5]
#
# * [ AWS::IAM::User][6]
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
# For more information, see [Acknowledging IAM Resources in AWS
# CloudFormation Templates][8].
#
# * `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][9] and
# [AWS::Serverless][10] 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][11].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
# [8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
# [9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
# [10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
# [11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
#
# @option params [Array<String>] :resource_types
# 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][1].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html
#
# @option params [String] :role_arn
# 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.
#
# @option params [Types::RollbackConfiguration] :rollback_configuration
# The rollback triggers for AWS CloudFormation to monitor during stack
# creation and updating operations, and for the specified monitoring
# period afterwards.
#
# @option params [String] :stack_policy_body
# 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.
#
# @option params [String] :stack_policy_url
# 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.
#
# @option params [Array<String>] :notification_arns
# 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.
#
# @option params [Array<Types::Tag>] :tags
# 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.
#
# @option params [String] :client_request_token
# 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`.
#
# @return [Types::UpdateStackOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateStackOutput#stack_id #stack_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_stack({
# stack_name: "StackName", # required
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# use_previous_template: false,
# stack_policy_during_update_body: "StackPolicyDuringUpdateBody",
# stack_policy_during_update_url: "StackPolicyDuringUpdateURL",
# parameters: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
# resource_types: ["ResourceType"],
# role_arn: "RoleARN",
# rollback_configuration: {
# rollback_triggers: [
# {
# arn: "Arn", # required
# type: "Type", # required
# },
# ],
# monitoring_time_in_minutes: 1,
# },
# stack_policy_body: "StackPolicyBody",
# stack_policy_url: "StackPolicyURL",
# notification_arns: ["NotificationARN"],
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
# },
# ],
# client_request_token: "ClientRequestToken",
# })
#
# @example Response structure
#
# resp.stack_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStack AWS API Documentation
#
# @overload update_stack(params = {})
# @param [Hash] params ({})
def update_stack(params = {}, options = {})
req = build_request(:update_stack, params)
req.send_request(options)
end
# 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][1].
#
# 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][2] 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][2] 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`.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set associated with the stack
# instances.
#
# @option params [Array<String>] :accounts
# \[`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.
#
# @option params [Types::DeploymentTargets] :deployment_targets
# \[`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.
#
# @option params [required, Array<String>] :regions
# 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.
#
# @option params [Array<Types::Parameter>] :parameter_overrides
# 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][1] 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`.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
# Preferences for how AWS CloudFormation performs this stack set
# operation.
#
# @option params [String] :operation_id
# 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.
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
# @return [Types::UpdateStackInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateStackInstancesOutput#operation_id #operation_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_stack_instances({
# stack_set_name: "StackSetNameOrId", # required
# accounts: ["Account"],
# deployment_targets: {
# accounts: ["Account"],
# organizational_unit_ids: ["OrganizationalUnitId"],
# },
# regions: ["Region"], # required
# parameter_overrides: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# operation_preferences: {
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
# max_concurrent_count: 1,
# max_concurrent_percentage: 1,
# },
# operation_id: "ClientRequestToken",
# })
#
# @example Response structure
#
# resp.operation_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstances AWS API Documentation
#
# @overload update_stack_instances(params = {})
# @param [Hash] params ({})
def update_stack_instances(params = {}, options = {})
req = build_request(:update_stack_instances, params)
req.send_request(options)
end
# 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.
#
# @option params [required, String] :stack_set_name
# The name or unique ID of the stack set that you want to update.
#
# @option params [String] :description
# A brief description of updates that you are making.
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1]
# in the AWS CloudFormation User Guide.
#
# Conditional: You must specify only one of the following parameters:
# `TemplateBody` or `TemplateURL`—or set `UsePreviousTemplate` to true.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [Boolean] :use_previous_template
# 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.
#
# @option params [Array<Types::Parameter>] :parameters
# A list of input parameters for the stack set template.
#
# @option params [Array<String>] :capabilities
# 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][1]
#
# * [ AWS::IAM::Group][2]
#
# * [ AWS::IAM::InstanceProfile][3]
#
# * [ AWS::IAM::Policy][4]
#
# * [ AWS::IAM::Role][5]
#
# * [ AWS::IAM::User][6]
#
# * [ AWS::IAM::UserToGroupAddition][7]
#
# For more information, see [Acknowledging IAM Resources in AWS
# CloudFormation Templates][8].
#
# * `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][9].
#
# Stack sets do not currently support macros in stack templates. (This
# includes the [AWS::Include][10] and [AWS::Serverless][11]
# 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.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
# [3]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
# [4]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
# [5]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
# [6]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
# [7]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
# [8]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities
# [9]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html
# [10]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html
# [11]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html
#
# @option params [Array<Types::Tag>] :tags
# 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.
#
# @option params [Types::StackSetOperationPreferences] :operation_preferences
# Preferences for how AWS CloudFormation performs this stack set
# operation.
#
# @option params [String] :administration_role_arn
# 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][1] 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.
#
#
#
# [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
#
# @option params [String] :execution_role_name
# 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.
#
# @option params [Types::DeploymentTargets] :deployment_targets
# \[`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.
#
# @option params [String] :permission_model
# 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][1].
#
# * 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][2].
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
#
# @option params [Types::AutoDeployment] :auto_deployment
# \[`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`.
#
# @option params [String] :operation_id
# 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`.
#
# **A suitable default value is auto-generated.** You should normally
# not need to pass this option.**
#
# @option params [Array<String>] :accounts
# \[`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.
#
# @option params [Array<String>] :regions
# 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.
#
# @return [Types::UpdateStackSetOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateStackSetOutput#operation_id #operation_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_stack_set({
# stack_set_name: "StackSetName", # required
# description: "Description",
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# use_previous_template: false,
# parameters: [
# {
# parameter_key: "ParameterKey",
# parameter_value: "ParameterValue",
# use_previous_value: false,
# resolved_value: "ParameterValue",
# },
# ],
# capabilities: ["CAPABILITY_IAM"], # accepts CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
# },
# ],
# operation_preferences: {
# region_order: ["Region"],
# failure_tolerance_count: 1,
# failure_tolerance_percentage: 1,
# max_concurrent_count: 1,
# max_concurrent_percentage: 1,
# },
# administration_role_arn: "RoleARN",
# execution_role_name: "ExecutionRoleName",
# deployment_targets: {
# accounts: ["Account"],
# organizational_unit_ids: ["OrganizationalUnitId"],
# },
# permission_model: "SERVICE_MANAGED", # accepts SERVICE_MANAGED, SELF_MANAGED
# auto_deployment: {
# enabled: false,
# retain_stacks_on_account_removal: false,
# },
# operation_id: "ClientRequestToken",
# accounts: ["Account"],
# regions: ["Region"],
# })
#
# @example Response structure
#
# resp.operation_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSet AWS API Documentation
#
# @overload update_stack_set(params = {})
# @param [Hash] params ({})
def update_stack_set(params = {}, options = {})
req = build_request(:update_stack_set, params)
req.send_request(options)
end
# 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][1] in the *AWS
# CloudFormation User Guide*.
#
# For [nested stacks][2], termination protection is set on the root
# stack and cannot be changed directly on the nested stack.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
# [2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
#
# @option params [required, Boolean] :enable_termination_protection
# Whether to enable termination protection on the specified stack.
#
# @option params [required, String] :stack_name
# The name or unique ID of the stack for which you want to set
# termination protection.
#
# @return [Types::UpdateTerminationProtectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateTerminationProtectionOutput#stack_id #stack_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.update_termination_protection({
# enable_termination_protection: false, # required
# stack_name: "StackNameOrId", # required
# })
#
# @example Response structure
#
# resp.stack_id #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateTerminationProtection AWS API Documentation
#
# @overload update_termination_protection(params = {})
# @param [Hash] params ({})
def update_termination_protection(params = {}, options = {})
req = build_request(:update_termination_protection, params)
req.send_request(options)
end
# 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.
#
# @option params [String] :template_body
# 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][1] in the AWS CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @option params [String] :template_url
# 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][1] in the AWS
# CloudFormation User Guide.
#
# Conditional: You must pass `TemplateURL` or `TemplateBody`. If both
# are passed, only `TemplateBody` is used.
#
#
#
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
#
# @return [Types::ValidateTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ValidateTemplateOutput#parameters #parameters} => Array<Types::TemplateParameter>
# * {Types::ValidateTemplateOutput#description #description} => String
# * {Types::ValidateTemplateOutput#capabilities #capabilities} => Array<String>
# * {Types::ValidateTemplateOutput#capabilities_reason #capabilities_reason} => String
# * {Types::ValidateTemplateOutput#declared_transforms #declared_transforms} => Array<String>
#
# @example Request syntax with placeholder values
#
# resp = client.validate_template({
# template_body: "TemplateBody",
# template_url: "TemplateURL",
# })
#
# @example Response structure
#
# resp.parameters #=> Array
# resp.parameters[0].parameter_key #=> String
# resp.parameters[0].default_value #=> String
# resp.parameters[0].no_echo #=> Boolean
# resp.parameters[0].description #=> String
# resp.description #=> String
# resp.capabilities #=> Array
# resp.capabilities[0] #=> String, one of "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND"
# resp.capabilities_reason #=> String
# resp.declared_transforms #=> Array
# resp.declared_transforms[0] #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ValidateTemplate AWS API Documentation
#
# @overload validate_template(params = {})
# @param [Hash] params ({})
def validate_template(params = {}, options = {})
req = build_request(:validate_template, params)
req.send_request(options)
end
# @!endgroup
# @param params ({})
# @api private
def build_request(operation_name, params = {})
handlers = @handlers.for(operation_name)
context = Seahorse::Client::RequestContext.new(
operation_name: operation_name,
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-cloudformation'
context[:gem_version] = '1.41.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#
# ## Basic Usage
#
# A waiter will call an API operation until:
#
# * It is successful
# * It enters a terminal state
# * It makes the maximum number of attempts
#
# In between attempts, the waiter will sleep.
#
# # polls in a loop, sleeping between attempts
# client.wait_until(waiter_name, params)
#
# ## Configuration
#
# You can configure the maximum number of polling attempts, and the
# delay (in seconds) between each polling attempt. You can pass
# configuration as the final arguments hash.
#
# # poll for ~25 seconds
# client.wait_until(waiter_name, params, {
# max_attempts: 5,
# delay: 5,
# })
#
# ## Callbacks
#
# You can be notified before each polling attempt and before each
# delay. If you throw `:success` or `:failure` from these callbacks,
# it will terminate the waiter.
#
# started_at = Time.now
# client.wait_until(waiter_name, params, {
#
# # disable max attempts
# max_attempts: nil,
#
# # poll for 1 hour, instead of a number of attempts
# before_wait: -> (attempts, response) do
# throw :failure if Time.now - started_at > 3600
# end
# })
#
# ## Handling Errors
#
# When a waiter is unsuccessful, it will raise an error.
# All of the failure errors extend from
# {Aws::Waiters::Errors::WaiterFailed}.
#
# begin
# client.wait_until(...)
# rescue Aws::Waiters::Errors::WaiterFailed
# # resource did not enter the desired state in time
# end
#
# ## Valid Waiters
#
# The following table lists the valid waiter names, the operations they call,
# and the default `:delay` and `:max_attempts` values.
#
# | waiter_name | params | :delay | :max_attempts |
# | -------------------------- | ----------------------------------- | -------- | ------------- |
# | change_set_create_complete | {Client#describe_change_set} | 30 | 120 |
# | stack_create_complete | {Client#describe_stacks} | 30 | 120 |
# | stack_delete_complete | {Client#describe_stacks} | 30 | 120 |
# | stack_exists | {Client#describe_stacks} | 5 | 20 |
# | stack_import_complete | {Client#describe_stacks} | 30 | 120 |
# | stack_rollback_complete | {Client#describe_stacks} | 30 | 120 |
# | stack_update_complete | {Client#describe_stacks} | 30 | 120 |
# | type_registration_complete | {Client#describe_type_registration} | 30 | 120 |
#
# @raise [Errors::FailureStateError] Raised when the waiter terminates
# because the waiter has entered a state that it will not transition
# out of, preventing success.
#
# @raise [Errors::TooManyAttemptsError] Raised when the configured
# maximum number of attempts have been made, and the waiter is not
# yet successful.
#
# @raise [Errors::UnexpectedError] Raised when an error is encounted
# while polling for a resource that is not expected.
#
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
# for an unknown state.
#
# @return [Boolean] Returns `true` if the waiter was successful.
# @param [Symbol] waiter_name
# @param [Hash] params ({})
# @param [Hash] options ({})
# @option options [Integer] :max_attempts
# @option options [Integer] :delay
# @option options [Proc] :before_attempt
# @option options [Proc] :before_wait
def wait_until(waiter_name, params = {}, options = {})
w = waiter(waiter_name, options)
yield(w.waiter) if block_given? # deprecated
w.wait(params)
end
# @api private
# @deprecated
def waiter_names
waiters.keys
end
private
# @param [Symbol] waiter_name
# @param [Hash] options ({})
def waiter(waiter_name, options = {})
waiter_class = waiters[waiter_name]
if waiter_class
waiter_class.new(options.merge(client: self))
else
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
end
end
def waiters
{
change_set_create_complete: Waiters::ChangeSetCreateComplete,
stack_create_complete: Waiters::StackCreateComplete,
stack_delete_complete: Waiters::StackDeleteComplete,
stack_exists: Waiters::StackExists,
stack_import_complete: Waiters::StackImportComplete,
stack_rollback_complete: Waiters::StackRollbackComplete,
stack_update_complete: Waiters::StackUpdateComplete,
type_registration_complete: Waiters::TypeRegistrationComplete
}
end
class << self
# @api private
attr_reader :identifier
# @api private
def errors_module
Errors
end
end
end
end
|