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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>The version of the VPC link.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum VpcLinkVersion {
#[allow(missing_docs)] // documentation missing in model
V2,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for VpcLinkVersion {
fn from(s: &str) -> Self {
match s {
"V2" => VpcLinkVersion::V2,
other => VpcLinkVersion::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for VpcLinkVersion {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(VpcLinkVersion::from(s))
}
}
impl VpcLinkVersion {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
VpcLinkVersion::V2 => "V2",
VpcLinkVersion::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["V2"]
}
}
impl AsRef<str> for VpcLinkVersion {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>The status of the VPC link.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum VpcLinkStatus {
#[allow(missing_docs)] // documentation missing in model
Available,
#[allow(missing_docs)] // documentation missing in model
Deleting,
#[allow(missing_docs)] // documentation missing in model
Failed,
#[allow(missing_docs)] // documentation missing in model
Inactive,
#[allow(missing_docs)] // documentation missing in model
Pending,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for VpcLinkStatus {
fn from(s: &str) -> Self {
match s {
"AVAILABLE" => VpcLinkStatus::Available,
"DELETING" => VpcLinkStatus::Deleting,
"FAILED" => VpcLinkStatus::Failed,
"INACTIVE" => VpcLinkStatus::Inactive,
"PENDING" => VpcLinkStatus::Pending,
other => VpcLinkStatus::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for VpcLinkStatus {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(VpcLinkStatus::from(s))
}
}
impl VpcLinkStatus {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
VpcLinkStatus::Available => "AVAILABLE",
VpcLinkStatus::Deleting => "DELETING",
VpcLinkStatus::Failed => "FAILED",
VpcLinkStatus::Inactive => "INACTIVE",
VpcLinkStatus::Pending => "PENDING",
VpcLinkStatus::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["AVAILABLE", "DELETING", "FAILED", "INACTIVE", "PENDING"]
}
}
impl AsRef<str> for VpcLinkStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Represents a collection of route settings.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct RouteSettings {
/// <p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub data_trace_enabled: bool,
/// <p>Specifies whether detailed metrics are enabled.</p>
pub detailed_metrics_enabled: bool,
/// <p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub logging_level: std::option::Option<crate::model::LoggingLevel>,
/// <p>Specifies the throttling burst limit.</p>
pub throttling_burst_limit: i32,
/// <p>Specifies the throttling rate limit.</p>
pub throttling_rate_limit: f64,
}
impl RouteSettings {
/// <p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub fn data_trace_enabled(&self) -> bool {
self.data_trace_enabled
}
/// <p>Specifies whether detailed metrics are enabled.</p>
pub fn detailed_metrics_enabled(&self) -> bool {
self.detailed_metrics_enabled
}
/// <p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub fn logging_level(&self) -> std::option::Option<&crate::model::LoggingLevel> {
self.logging_level.as_ref()
}
/// <p>Specifies the throttling burst limit.</p>
pub fn throttling_burst_limit(&self) -> i32 {
self.throttling_burst_limit
}
/// <p>Specifies the throttling rate limit.</p>
pub fn throttling_rate_limit(&self) -> f64 {
self.throttling_rate_limit
}
}
impl std::fmt::Debug for RouteSettings {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("RouteSettings");
formatter.field("data_trace_enabled", &self.data_trace_enabled);
formatter.field("detailed_metrics_enabled", &self.detailed_metrics_enabled);
formatter.field("logging_level", &self.logging_level);
formatter.field("throttling_burst_limit", &self.throttling_burst_limit);
formatter.field("throttling_rate_limit", &self.throttling_rate_limit);
formatter.finish()
}
}
/// See [`RouteSettings`](crate::model::RouteSettings).
pub mod route_settings {
/// A builder for [`RouteSettings`](crate::model::RouteSettings).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) data_trace_enabled: std::option::Option<bool>,
pub(crate) detailed_metrics_enabled: std::option::Option<bool>,
pub(crate) logging_level: std::option::Option<crate::model::LoggingLevel>,
pub(crate) throttling_burst_limit: std::option::Option<i32>,
pub(crate) throttling_rate_limit: std::option::Option<f64>,
}
impl Builder {
/// <p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub fn data_trace_enabled(mut self, input: bool) -> Self {
self.data_trace_enabled = Some(input);
self
}
/// <p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub fn set_data_trace_enabled(mut self, input: std::option::Option<bool>) -> Self {
self.data_trace_enabled = input;
self
}
/// <p>Specifies whether detailed metrics are enabled.</p>
pub fn detailed_metrics_enabled(mut self, input: bool) -> Self {
self.detailed_metrics_enabled = Some(input);
self
}
/// <p>Specifies whether detailed metrics are enabled.</p>
pub fn set_detailed_metrics_enabled(mut self, input: std::option::Option<bool>) -> Self {
self.detailed_metrics_enabled = input;
self
}
/// <p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub fn logging_level(mut self, input: crate::model::LoggingLevel) -> Self {
self.logging_level = Some(input);
self
}
/// <p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>
pub fn set_logging_level(
mut self,
input: std::option::Option<crate::model::LoggingLevel>,
) -> Self {
self.logging_level = input;
self
}
/// <p>Specifies the throttling burst limit.</p>
pub fn throttling_burst_limit(mut self, input: i32) -> Self {
self.throttling_burst_limit = Some(input);
self
}
/// <p>Specifies the throttling burst limit.</p>
pub fn set_throttling_burst_limit(mut self, input: std::option::Option<i32>) -> Self {
self.throttling_burst_limit = input;
self
}
/// <p>Specifies the throttling rate limit.</p>
pub fn throttling_rate_limit(mut self, input: f64) -> Self {
self.throttling_rate_limit = Some(input);
self
}
/// <p>Specifies the throttling rate limit.</p>
pub fn set_throttling_rate_limit(mut self, input: std::option::Option<f64>) -> Self {
self.throttling_rate_limit = input;
self
}
/// Consumes the builder and constructs a [`RouteSettings`](crate::model::RouteSettings).
pub fn build(self) -> crate::model::RouteSettings {
crate::model::RouteSettings {
data_trace_enabled: self.data_trace_enabled.unwrap_or_default(),
detailed_metrics_enabled: self.detailed_metrics_enabled.unwrap_or_default(),
logging_level: self.logging_level,
throttling_burst_limit: self.throttling_burst_limit.unwrap_or_default(),
throttling_rate_limit: self.throttling_rate_limit.unwrap_or_default(),
}
}
}
}
impl RouteSettings {
/// Creates a new builder-style object to manufacture [`RouteSettings`](crate::model::RouteSettings).
pub fn builder() -> crate::model::route_settings::Builder {
crate::model::route_settings::Builder::default()
}
}
/// <p>The logging level.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum LoggingLevel {
#[allow(missing_docs)] // documentation missing in model
Error,
#[allow(missing_docs)] // documentation missing in model
Info,
#[allow(missing_docs)] // documentation missing in model
Off,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for LoggingLevel {
fn from(s: &str) -> Self {
match s {
"ERROR" => LoggingLevel::Error,
"INFO" => LoggingLevel::Info,
"OFF" => LoggingLevel::Off,
other => LoggingLevel::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for LoggingLevel {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(LoggingLevel::from(s))
}
}
impl LoggingLevel {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
LoggingLevel::Error => "ERROR",
LoggingLevel::Info => "INFO",
LoggingLevel::Off => "OFF",
LoggingLevel::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["ERROR", "INFO", "OFF"]
}
}
impl AsRef<str> for LoggingLevel {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Settings for logging access in a stage.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct AccessLogSettings {
/// <p>The ARN of the CloudWatch Logs log group to receive access logs.</p>
pub destination_arn: std::option::Option<std::string::String>,
/// <p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>
pub format: std::option::Option<std::string::String>,
}
impl AccessLogSettings {
/// <p>The ARN of the CloudWatch Logs log group to receive access logs.</p>
pub fn destination_arn(&self) -> std::option::Option<&str> {
self.destination_arn.as_deref()
}
/// <p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>
pub fn format(&self) -> std::option::Option<&str> {
self.format.as_deref()
}
}
impl std::fmt::Debug for AccessLogSettings {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("AccessLogSettings");
formatter.field("destination_arn", &self.destination_arn);
formatter.field("format", &self.format);
formatter.finish()
}
}
/// See [`AccessLogSettings`](crate::model::AccessLogSettings).
pub mod access_log_settings {
/// A builder for [`AccessLogSettings`](crate::model::AccessLogSettings).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) destination_arn: std::option::Option<std::string::String>,
pub(crate) format: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>The ARN of the CloudWatch Logs log group to receive access logs.</p>
pub fn destination_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.destination_arn = Some(input.into());
self
}
/// <p>The ARN of the CloudWatch Logs log group to receive access logs.</p>
pub fn set_destination_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.destination_arn = input;
self
}
/// <p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>
pub fn format(mut self, input: impl Into<std::string::String>) -> Self {
self.format = Some(input.into());
self
}
/// <p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>
pub fn set_format(mut self, input: std::option::Option<std::string::String>) -> Self {
self.format = input;
self
}
/// Consumes the builder and constructs a [`AccessLogSettings`](crate::model::AccessLogSettings).
pub fn build(self) -> crate::model::AccessLogSettings {
crate::model::AccessLogSettings {
destination_arn: self.destination_arn,
format: self.format,
}
}
}
}
impl AccessLogSettings {
/// Creates a new builder-style object to manufacture [`AccessLogSettings`](crate::model::AccessLogSettings).
pub fn builder() -> crate::model::access_log_settings::Builder {
crate::model::access_log_settings::Builder::default()
}
}
/// <p>Validation constraints imposed on parameters of a request (path, query string, headers).</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct ParameterConstraints {
/// <p>Whether or not the parameter is required.</p>
pub required: bool,
}
impl ParameterConstraints {
/// <p>Whether or not the parameter is required.</p>
pub fn required(&self) -> bool {
self.required
}
}
impl std::fmt::Debug for ParameterConstraints {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("ParameterConstraints");
formatter.field("required", &self.required);
formatter.finish()
}
}
/// See [`ParameterConstraints`](crate::model::ParameterConstraints).
pub mod parameter_constraints {
/// A builder for [`ParameterConstraints`](crate::model::ParameterConstraints).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) required: std::option::Option<bool>,
}
impl Builder {
/// <p>Whether or not the parameter is required.</p>
pub fn required(mut self, input: bool) -> Self {
self.required = Some(input);
self
}
/// <p>Whether or not the parameter is required.</p>
pub fn set_required(mut self, input: std::option::Option<bool>) -> Self {
self.required = input;
self
}
/// Consumes the builder and constructs a [`ParameterConstraints`](crate::model::ParameterConstraints).
pub fn build(self) -> crate::model::ParameterConstraints {
crate::model::ParameterConstraints {
required: self.required.unwrap_or_default(),
}
}
}
}
impl ParameterConstraints {
/// Creates a new builder-style object to manufacture [`ParameterConstraints`](crate::model::ParameterConstraints).
pub fn builder() -> crate::model::parameter_constraints::Builder {
crate::model::parameter_constraints::Builder::default()
}
}
/// <p>The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum AuthorizationType {
#[allow(missing_docs)] // documentation missing in model
AwsIam,
#[allow(missing_docs)] // documentation missing in model
Custom,
#[allow(missing_docs)] // documentation missing in model
Jwt,
#[allow(missing_docs)] // documentation missing in model
None,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for AuthorizationType {
fn from(s: &str) -> Self {
match s {
"AWS_IAM" => AuthorizationType::AwsIam,
"CUSTOM" => AuthorizationType::Custom,
"JWT" => AuthorizationType::Jwt,
"NONE" => AuthorizationType::None,
other => AuthorizationType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for AuthorizationType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(AuthorizationType::from(s))
}
}
impl AuthorizationType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
AuthorizationType::AwsIam => "AWS_IAM",
AuthorizationType::Custom => "CUSTOM",
AuthorizationType::Jwt => "JWT",
AuthorizationType::None => "NONE",
AuthorizationType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["AWS_IAM", "CUSTOM", "JWT", "NONE"]
}
}
impl AsRef<str> for AuthorizationType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum ContentHandlingStrategy {
#[allow(missing_docs)] // documentation missing in model
ConvertToBinary,
#[allow(missing_docs)] // documentation missing in model
ConvertToText,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for ContentHandlingStrategy {
fn from(s: &str) -> Self {
match s {
"CONVERT_TO_BINARY" => ContentHandlingStrategy::ConvertToBinary,
"CONVERT_TO_TEXT" => ContentHandlingStrategy::ConvertToText,
other => ContentHandlingStrategy::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for ContentHandlingStrategy {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(ContentHandlingStrategy::from(s))
}
}
impl ContentHandlingStrategy {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
ContentHandlingStrategy::ConvertToBinary => "CONVERT_TO_BINARY",
ContentHandlingStrategy::ConvertToText => "CONVERT_TO_TEXT",
ContentHandlingStrategy::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"]
}
}
impl AsRef<str> for ContentHandlingStrategy {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct TlsConfig {
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub server_name_to_verify: std::option::Option<std::string::String>,
}
impl TlsConfig {
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub fn server_name_to_verify(&self) -> std::option::Option<&str> {
self.server_name_to_verify.as_deref()
}
}
impl std::fmt::Debug for TlsConfig {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("TlsConfig");
formatter.field("server_name_to_verify", &self.server_name_to_verify);
formatter.finish()
}
}
/// See [`TlsConfig`](crate::model::TlsConfig).
pub mod tls_config {
/// A builder for [`TlsConfig`](crate::model::TlsConfig).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) server_name_to_verify: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub fn server_name_to_verify(mut self, input: impl Into<std::string::String>) -> Self {
self.server_name_to_verify = Some(input.into());
self
}
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub fn set_server_name_to_verify(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.server_name_to_verify = input;
self
}
/// Consumes the builder and constructs a [`TlsConfig`](crate::model::TlsConfig).
pub fn build(self) -> crate::model::TlsConfig {
crate::model::TlsConfig {
server_name_to_verify: self.server_name_to_verify,
}
}
}
}
impl TlsConfig {
/// Creates a new builder-style object to manufacture [`TlsConfig`](crate::model::TlsConfig).
pub fn builder() -> crate::model::tls_config::Builder {
crate::model::tls_config::Builder::default()
}
}
/// <p>Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum PassthroughBehavior {
#[allow(missing_docs)] // documentation missing in model
Never,
#[allow(missing_docs)] // documentation missing in model
WhenNoMatch,
#[allow(missing_docs)] // documentation missing in model
WhenNoTemplates,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for PassthroughBehavior {
fn from(s: &str) -> Self {
match s {
"NEVER" => PassthroughBehavior::Never,
"WHEN_NO_MATCH" => PassthroughBehavior::WhenNoMatch,
"WHEN_NO_TEMPLATES" => PassthroughBehavior::WhenNoTemplates,
other => PassthroughBehavior::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for PassthroughBehavior {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(PassthroughBehavior::from(s))
}
}
impl PassthroughBehavior {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
PassthroughBehavior::Never => "NEVER",
PassthroughBehavior::WhenNoMatch => "WHEN_NO_MATCH",
PassthroughBehavior::WhenNoTemplates => "WHEN_NO_TEMPLATES",
PassthroughBehavior::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["NEVER", "WHEN_NO_MATCH", "WHEN_NO_TEMPLATES"]
}
}
impl AsRef<str> for PassthroughBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Represents an API method integration type.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum IntegrationType {
#[allow(missing_docs)] // documentation missing in model
Aws,
#[allow(missing_docs)] // documentation missing in model
AwsProxy,
#[allow(missing_docs)] // documentation missing in model
Http,
#[allow(missing_docs)] // documentation missing in model
HttpProxy,
#[allow(missing_docs)] // documentation missing in model
Mock,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for IntegrationType {
fn from(s: &str) -> Self {
match s {
"AWS" => IntegrationType::Aws,
"AWS_PROXY" => IntegrationType::AwsProxy,
"HTTP" => IntegrationType::Http,
"HTTP_PROXY" => IntegrationType::HttpProxy,
"MOCK" => IntegrationType::Mock,
other => IntegrationType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for IntegrationType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(IntegrationType::from(s))
}
}
impl IntegrationType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
IntegrationType::Aws => "AWS",
IntegrationType::AwsProxy => "AWS_PROXY",
IntegrationType::Http => "HTTP",
IntegrationType::HttpProxy => "HTTP_PROXY",
IntegrationType::Mock => "MOCK",
IntegrationType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["AWS", "AWS_PROXY", "HTTP", "HTTP_PROXY", "MOCK"]
}
}
impl AsRef<str> for IntegrationType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Represents a connection type.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum ConnectionType {
#[allow(missing_docs)] // documentation missing in model
Internet,
#[allow(missing_docs)] // documentation missing in model
VpcLink,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for ConnectionType {
fn from(s: &str) -> Self {
match s {
"INTERNET" => ConnectionType::Internet,
"VPC_LINK" => ConnectionType::VpcLink,
other => ConnectionType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for ConnectionType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(ConnectionType::from(s))
}
}
impl ConnectionType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
ConnectionType::Internet => "INTERNET",
ConnectionType::VpcLink => "VPC_LINK",
ConnectionType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["INTERNET", "VPC_LINK"]
}
}
impl AsRef<str> for ConnectionType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct TlsConfigInput {
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub server_name_to_verify: std::option::Option<std::string::String>,
}
impl TlsConfigInput {
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub fn server_name_to_verify(&self) -> std::option::Option<&str> {
self.server_name_to_verify.as_deref()
}
}
impl std::fmt::Debug for TlsConfigInput {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("TlsConfigInput");
formatter.field("server_name_to_verify", &self.server_name_to_verify);
formatter.finish()
}
}
/// See [`TlsConfigInput`](crate::model::TlsConfigInput).
pub mod tls_config_input {
/// A builder for [`TlsConfigInput`](crate::model::TlsConfigInput).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) server_name_to_verify: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub fn server_name_to_verify(mut self, input: impl Into<std::string::String>) -> Self {
self.server_name_to_verify = Some(input.into());
self
}
/// <p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>
pub fn set_server_name_to_verify(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.server_name_to_verify = input;
self
}
/// Consumes the builder and constructs a [`TlsConfigInput`](crate::model::TlsConfigInput).
pub fn build(self) -> crate::model::TlsConfigInput {
crate::model::TlsConfigInput {
server_name_to_verify: self.server_name_to_verify,
}
}
}
}
impl TlsConfigInput {
/// Creates a new builder-style object to manufacture [`TlsConfigInput`](crate::model::TlsConfigInput).
pub fn builder() -> crate::model::tls_config_input::Builder {
crate::model::tls_config_input::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct MutualTlsAuthentication {
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub truststore_uri: std::option::Option<std::string::String>,
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub truststore_version: std::option::Option<std::string::String>,
/// <p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>
pub truststore_warnings: std::option::Option<std::vec::Vec<std::string::String>>,
}
impl MutualTlsAuthentication {
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub fn truststore_uri(&self) -> std::option::Option<&str> {
self.truststore_uri.as_deref()
}
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub fn truststore_version(&self) -> std::option::Option<&str> {
self.truststore_version.as_deref()
}
/// <p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>
pub fn truststore_warnings(&self) -> std::option::Option<&[std::string::String]> {
self.truststore_warnings.as_deref()
}
}
impl std::fmt::Debug for MutualTlsAuthentication {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("MutualTlsAuthentication");
formatter.field("truststore_uri", &self.truststore_uri);
formatter.field("truststore_version", &self.truststore_version);
formatter.field("truststore_warnings", &self.truststore_warnings);
formatter.finish()
}
}
/// See [`MutualTlsAuthentication`](crate::model::MutualTlsAuthentication).
pub mod mutual_tls_authentication {
/// A builder for [`MutualTlsAuthentication`](crate::model::MutualTlsAuthentication).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) truststore_uri: std::option::Option<std::string::String>,
pub(crate) truststore_version: std::option::Option<std::string::String>,
pub(crate) truststore_warnings: std::option::Option<std::vec::Vec<std::string::String>>,
}
impl Builder {
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub fn truststore_uri(mut self, input: impl Into<std::string::String>) -> Self {
self.truststore_uri = Some(input.into());
self
}
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub fn set_truststore_uri(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.truststore_uri = input;
self
}
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub fn truststore_version(mut self, input: impl Into<std::string::String>) -> Self {
self.truststore_version = Some(input.into());
self
}
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub fn set_truststore_version(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.truststore_version = input;
self
}
/// Appends an item to `truststore_warnings`.
///
/// To override the contents of this collection use [`set_truststore_warnings`](Self::set_truststore_warnings).
///
/// <p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>
pub fn truststore_warnings(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.truststore_warnings.unwrap_or_default();
v.push(input.into());
self.truststore_warnings = Some(v);
self
}
/// <p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>
pub fn set_truststore_warnings(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.truststore_warnings = input;
self
}
/// Consumes the builder and constructs a [`MutualTlsAuthentication`](crate::model::MutualTlsAuthentication).
pub fn build(self) -> crate::model::MutualTlsAuthentication {
crate::model::MutualTlsAuthentication {
truststore_uri: self.truststore_uri,
truststore_version: self.truststore_version,
truststore_warnings: self.truststore_warnings,
}
}
}
}
impl MutualTlsAuthentication {
/// Creates a new builder-style object to manufacture [`MutualTlsAuthentication`](crate::model::MutualTlsAuthentication).
pub fn builder() -> crate::model::mutual_tls_authentication::Builder {
crate::model::mutual_tls_authentication::Builder::default()
}
}
/// <p>The domain name configuration.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct DomainNameConfiguration {
/// <p>A domain name for the API.</p>
pub api_gateway_domain_name: std::option::Option<std::string::String>,
/// <p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
pub certificate_arn: std::option::Option<std::string::String>,
/// <p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>
pub certificate_name: std::option::Option<std::string::String>,
/// <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
pub certificate_upload_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>
pub domain_name_status: std::option::Option<crate::model::DomainNameStatus>,
/// <p>An optional text message containing detailed information about status of the domain name migration.</p>
pub domain_name_status_message: std::option::Option<std::string::String>,
/// <p>The endpoint type.</p>
pub endpoint_type: std::option::Option<crate::model::EndpointType>,
/// <p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>
pub hosted_zone_id: std::option::Option<std::string::String>,
/// <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
pub security_policy: std::option::Option<crate::model::SecurityPolicy>,
/// <p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>
pub ownership_verification_certificate_arn: std::option::Option<std::string::String>,
}
impl DomainNameConfiguration {
/// <p>A domain name for the API.</p>
pub fn api_gateway_domain_name(&self) -> std::option::Option<&str> {
self.api_gateway_domain_name.as_deref()
}
/// <p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
pub fn certificate_arn(&self) -> std::option::Option<&str> {
self.certificate_arn.as_deref()
}
/// <p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>
pub fn certificate_name(&self) -> std::option::Option<&str> {
self.certificate_name.as_deref()
}
/// <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
pub fn certificate_upload_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.certificate_upload_date.as_ref()
}
/// <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>
pub fn domain_name_status(&self) -> std::option::Option<&crate::model::DomainNameStatus> {
self.domain_name_status.as_ref()
}
/// <p>An optional text message containing detailed information about status of the domain name migration.</p>
pub fn domain_name_status_message(&self) -> std::option::Option<&str> {
self.domain_name_status_message.as_deref()
}
/// <p>The endpoint type.</p>
pub fn endpoint_type(&self) -> std::option::Option<&crate::model::EndpointType> {
self.endpoint_type.as_ref()
}
/// <p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>
pub fn hosted_zone_id(&self) -> std::option::Option<&str> {
self.hosted_zone_id.as_deref()
}
/// <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
pub fn security_policy(&self) -> std::option::Option<&crate::model::SecurityPolicy> {
self.security_policy.as_ref()
}
/// <p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>
pub fn ownership_verification_certificate_arn(&self) -> std::option::Option<&str> {
self.ownership_verification_certificate_arn.as_deref()
}
}
impl std::fmt::Debug for DomainNameConfiguration {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("DomainNameConfiguration");
formatter.field("api_gateway_domain_name", &self.api_gateway_domain_name);
formatter.field("certificate_arn", &self.certificate_arn);
formatter.field("certificate_name", &self.certificate_name);
formatter.field("certificate_upload_date", &self.certificate_upload_date);
formatter.field("domain_name_status", &self.domain_name_status);
formatter.field(
"domain_name_status_message",
&self.domain_name_status_message,
);
formatter.field("endpoint_type", &self.endpoint_type);
formatter.field("hosted_zone_id", &self.hosted_zone_id);
formatter.field("security_policy", &self.security_policy);
formatter.field(
"ownership_verification_certificate_arn",
&self.ownership_verification_certificate_arn,
);
formatter.finish()
}
}
/// See [`DomainNameConfiguration`](crate::model::DomainNameConfiguration).
pub mod domain_name_configuration {
/// A builder for [`DomainNameConfiguration`](crate::model::DomainNameConfiguration).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) api_gateway_domain_name: std::option::Option<std::string::String>,
pub(crate) certificate_arn: std::option::Option<std::string::String>,
pub(crate) certificate_name: std::option::Option<std::string::String>,
pub(crate) certificate_upload_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) domain_name_status: std::option::Option<crate::model::DomainNameStatus>,
pub(crate) domain_name_status_message: std::option::Option<std::string::String>,
pub(crate) endpoint_type: std::option::Option<crate::model::EndpointType>,
pub(crate) hosted_zone_id: std::option::Option<std::string::String>,
pub(crate) security_policy: std::option::Option<crate::model::SecurityPolicy>,
pub(crate) ownership_verification_certificate_arn: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>A domain name for the API.</p>
pub fn api_gateway_domain_name(mut self, input: impl Into<std::string::String>) -> Self {
self.api_gateway_domain_name = Some(input.into());
self
}
/// <p>A domain name for the API.</p>
pub fn set_api_gateway_domain_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.api_gateway_domain_name = input;
self
}
/// <p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
pub fn certificate_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.certificate_arn = Some(input.into());
self
}
/// <p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>
pub fn set_certificate_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.certificate_arn = input;
self
}
/// <p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>
pub fn certificate_name(mut self, input: impl Into<std::string::String>) -> Self {
self.certificate_name = Some(input.into());
self
}
/// <p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>
pub fn set_certificate_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.certificate_name = input;
self
}
/// <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
pub fn certificate_upload_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.certificate_upload_date = Some(input);
self
}
/// <p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>
pub fn set_certificate_upload_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.certificate_upload_date = input;
self
}
/// <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>
pub fn domain_name_status(mut self, input: crate::model::DomainNameStatus) -> Self {
self.domain_name_status = Some(input);
self
}
/// <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>
pub fn set_domain_name_status(
mut self,
input: std::option::Option<crate::model::DomainNameStatus>,
) -> Self {
self.domain_name_status = input;
self
}
/// <p>An optional text message containing detailed information about status of the domain name migration.</p>
pub fn domain_name_status_message(mut self, input: impl Into<std::string::String>) -> Self {
self.domain_name_status_message = Some(input.into());
self
}
/// <p>An optional text message containing detailed information about status of the domain name migration.</p>
pub fn set_domain_name_status_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.domain_name_status_message = input;
self
}
/// <p>The endpoint type.</p>
pub fn endpoint_type(mut self, input: crate::model::EndpointType) -> Self {
self.endpoint_type = Some(input);
self
}
/// <p>The endpoint type.</p>
pub fn set_endpoint_type(
mut self,
input: std::option::Option<crate::model::EndpointType>,
) -> Self {
self.endpoint_type = input;
self
}
/// <p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>
pub fn hosted_zone_id(mut self, input: impl Into<std::string::String>) -> Self {
self.hosted_zone_id = Some(input.into());
self
}
/// <p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>
pub fn set_hosted_zone_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.hosted_zone_id = input;
self
}
/// <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
pub fn security_policy(mut self, input: crate::model::SecurityPolicy) -> Self {
self.security_policy = Some(input);
self
}
/// <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
pub fn set_security_policy(
mut self,
input: std::option::Option<crate::model::SecurityPolicy>,
) -> Self {
self.security_policy = input;
self
}
/// <p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>
pub fn ownership_verification_certificate_arn(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.ownership_verification_certificate_arn = Some(input.into());
self
}
/// <p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>
pub fn set_ownership_verification_certificate_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.ownership_verification_certificate_arn = input;
self
}
/// Consumes the builder and constructs a [`DomainNameConfiguration`](crate::model::DomainNameConfiguration).
pub fn build(self) -> crate::model::DomainNameConfiguration {
crate::model::DomainNameConfiguration {
api_gateway_domain_name: self.api_gateway_domain_name,
certificate_arn: self.certificate_arn,
certificate_name: self.certificate_name,
certificate_upload_date: self.certificate_upload_date,
domain_name_status: self.domain_name_status,
domain_name_status_message: self.domain_name_status_message,
endpoint_type: self.endpoint_type,
hosted_zone_id: self.hosted_zone_id,
security_policy: self.security_policy,
ownership_verification_certificate_arn: self.ownership_verification_certificate_arn,
}
}
}
}
impl DomainNameConfiguration {
/// Creates a new builder-style object to manufacture [`DomainNameConfiguration`](crate::model::DomainNameConfiguration).
pub fn builder() -> crate::model::domain_name_configuration::Builder {
crate::model::domain_name_configuration::Builder::default()
}
}
/// <p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum SecurityPolicy {
#[allow(missing_docs)] // documentation missing in model
Tls10,
#[allow(missing_docs)] // documentation missing in model
Tls12,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for SecurityPolicy {
fn from(s: &str) -> Self {
match s {
"TLS_1_0" => SecurityPolicy::Tls10,
"TLS_1_2" => SecurityPolicy::Tls12,
other => SecurityPolicy::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for SecurityPolicy {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(SecurityPolicy::from(s))
}
}
impl SecurityPolicy {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
SecurityPolicy::Tls10 => "TLS_1_0",
SecurityPolicy::Tls12 => "TLS_1_2",
SecurityPolicy::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["TLS_1_0", "TLS_1_2"]
}
}
impl AsRef<str> for SecurityPolicy {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Represents an endpoint type.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum EndpointType {
#[allow(missing_docs)] // documentation missing in model
Edge,
#[allow(missing_docs)] // documentation missing in model
Regional,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for EndpointType {
fn from(s: &str) -> Self {
match s {
"EDGE" => EndpointType::Edge,
"REGIONAL" => EndpointType::Regional,
other => EndpointType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for EndpointType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(EndpointType::from(s))
}
}
impl EndpointType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
EndpointType::Edge => "EDGE",
EndpointType::Regional => "REGIONAL",
EndpointType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["EDGE", "REGIONAL"]
}
}
impl AsRef<str> for EndpointType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum DomainNameStatus {
#[allow(missing_docs)] // documentation missing in model
Available,
#[allow(missing_docs)] // documentation missing in model
PendingCertificateReimport,
#[allow(missing_docs)] // documentation missing in model
PendingOwnershipVerification,
#[allow(missing_docs)] // documentation missing in model
Updating,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for DomainNameStatus {
fn from(s: &str) -> Self {
match s {
"AVAILABLE" => DomainNameStatus::Available,
"PENDING_CERTIFICATE_REIMPORT" => DomainNameStatus::PendingCertificateReimport,
"PENDING_OWNERSHIP_VERIFICATION" => DomainNameStatus::PendingOwnershipVerification,
"UPDATING" => DomainNameStatus::Updating,
other => DomainNameStatus::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for DomainNameStatus {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(DomainNameStatus::from(s))
}
}
impl DomainNameStatus {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
DomainNameStatus::Available => "AVAILABLE",
DomainNameStatus::PendingCertificateReimport => "PENDING_CERTIFICATE_REIMPORT",
DomainNameStatus::PendingOwnershipVerification => "PENDING_OWNERSHIP_VERIFICATION",
DomainNameStatus::Updating => "UPDATING",
DomainNameStatus::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"AVAILABLE",
"PENDING_CERTIFICATE_REIMPORT",
"PENDING_OWNERSHIP_VERIFICATION",
"UPDATING",
]
}
}
impl AsRef<str> for DomainNameStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct MutualTlsAuthenticationInput {
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub truststore_uri: std::option::Option<std::string::String>,
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub truststore_version: std::option::Option<std::string::String>,
}
impl MutualTlsAuthenticationInput {
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub fn truststore_uri(&self) -> std::option::Option<&str> {
self.truststore_uri.as_deref()
}
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub fn truststore_version(&self) -> std::option::Option<&str> {
self.truststore_version.as_deref()
}
}
impl std::fmt::Debug for MutualTlsAuthenticationInput {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("MutualTlsAuthenticationInput");
formatter.field("truststore_uri", &self.truststore_uri);
formatter.field("truststore_version", &self.truststore_version);
formatter.finish()
}
}
/// See [`MutualTlsAuthenticationInput`](crate::model::MutualTlsAuthenticationInput).
pub mod mutual_tls_authentication_input {
/// A builder for [`MutualTlsAuthenticationInput`](crate::model::MutualTlsAuthenticationInput).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) truststore_uri: std::option::Option<std::string::String>,
pub(crate) truststore_version: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub fn truststore_uri(mut self, input: impl Into<std::string::String>) -> Self {
self.truststore_uri = Some(input.into());
self
}
/// <p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>
/// bucket-name
/// </replaceable>/<replaceable>
/// key-name
/// </replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>
pub fn set_truststore_uri(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.truststore_uri = input;
self
}
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub fn truststore_version(mut self, input: impl Into<std::string::String>) -> Self {
self.truststore_version = Some(input.into());
self
}
/// <p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>
pub fn set_truststore_version(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.truststore_version = input;
self
}
/// Consumes the builder and constructs a [`MutualTlsAuthenticationInput`](crate::model::MutualTlsAuthenticationInput).
pub fn build(self) -> crate::model::MutualTlsAuthenticationInput {
crate::model::MutualTlsAuthenticationInput {
truststore_uri: self.truststore_uri,
truststore_version: self.truststore_version,
}
}
}
}
impl MutualTlsAuthenticationInput {
/// Creates a new builder-style object to manufacture [`MutualTlsAuthenticationInput`](crate::model::MutualTlsAuthenticationInput).
pub fn builder() -> crate::model::mutual_tls_authentication_input::Builder {
crate::model::mutual_tls_authentication_input::Builder::default()
}
}
/// <p>Represents a deployment status.</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum DeploymentStatus {
#[allow(missing_docs)] // documentation missing in model
Deployed,
#[allow(missing_docs)] // documentation missing in model
Failed,
#[allow(missing_docs)] // documentation missing in model
Pending,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for DeploymentStatus {
fn from(s: &str) -> Self {
match s {
"DEPLOYED" => DeploymentStatus::Deployed,
"FAILED" => DeploymentStatus::Failed,
"PENDING" => DeploymentStatus::Pending,
other => DeploymentStatus::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for DeploymentStatus {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(DeploymentStatus::from(s))
}
}
impl DeploymentStatus {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
DeploymentStatus::Deployed => "DEPLOYED",
DeploymentStatus::Failed => "FAILED",
DeploymentStatus::Pending => "PENDING",
DeploymentStatus::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["DEPLOYED", "FAILED", "PENDING"]
}
}
impl AsRef<str> for DeploymentStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct JwtConfiguration {
/// <p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</p>
pub audience: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>
/// {region}
/// </replaceable>.amazonaws.com/<replaceable>
/// {userPoolId}
/// </replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub issuer: std::option::Option<std::string::String>,
}
impl JwtConfiguration {
/// <p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</p>
pub fn audience(&self) -> std::option::Option<&[std::string::String]> {
self.audience.as_deref()
}
/// <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>
/// {region}
/// </replaceable>.amazonaws.com/<replaceable>
/// {userPoolId}
/// </replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub fn issuer(&self) -> std::option::Option<&str> {
self.issuer.as_deref()
}
}
impl std::fmt::Debug for JwtConfiguration {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("JwtConfiguration");
formatter.field("audience", &self.audience);
formatter.field("issuer", &self.issuer);
formatter.finish()
}
}
/// See [`JwtConfiguration`](crate::model::JwtConfiguration).
pub mod jwt_configuration {
/// A builder for [`JwtConfiguration`](crate::model::JwtConfiguration).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) audience: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) issuer: std::option::Option<std::string::String>,
}
impl Builder {
/// Appends an item to `audience`.
///
/// To override the contents of this collection use [`set_audience`](Self::set_audience).
///
/// <p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</p>
pub fn audience(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.audience.unwrap_or_default();
v.push(input.into());
self.audience = Some(v);
self
}
/// <p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href="https://tools.ietf.org/html/rfc7519#section-4.1.3">RFC 7519</a>. Supported only for HTTP APIs.</p>
pub fn set_audience(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.audience = input;
self
}
/// <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>
/// {region}
/// </replaceable>.amazonaws.com/<replaceable>
/// {userPoolId}
/// </replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub fn issuer(mut self, input: impl Into<std::string::String>) -> Self {
self.issuer = Some(input.into());
self
}
/// <p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>
/// {region}
/// </replaceable>.amazonaws.com/<replaceable>
/// {userPoolId}
/// </replaceable> . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub fn set_issuer(mut self, input: std::option::Option<std::string::String>) -> Self {
self.issuer = input;
self
}
/// Consumes the builder and constructs a [`JwtConfiguration`](crate::model::JwtConfiguration).
pub fn build(self) -> crate::model::JwtConfiguration {
crate::model::JwtConfiguration {
audience: self.audience,
issuer: self.issuer,
}
}
}
}
impl JwtConfiguration {
/// Creates a new builder-style object to manufacture [`JwtConfiguration`](crate::model::JwtConfiguration).
pub fn builder() -> crate::model::jwt_configuration::Builder {
crate::model::jwt_configuration::Builder::default()
}
}
/// <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum AuthorizerType {
#[allow(missing_docs)] // documentation missing in model
Jwt,
#[allow(missing_docs)] // documentation missing in model
Request,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for AuthorizerType {
fn from(s: &str) -> Self {
match s {
"JWT" => AuthorizerType::Jwt,
"REQUEST" => AuthorizerType::Request,
other => AuthorizerType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for AuthorizerType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(AuthorizerType::from(s))
}
}
impl AuthorizerType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
AuthorizerType::Jwt => "JWT",
AuthorizerType::Request => "REQUEST",
AuthorizerType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["JWT", "REQUEST"]
}
}
impl AsRef<str> for AuthorizerType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// Represents a protocol type.
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum ProtocolType {
#[allow(missing_docs)] // documentation missing in model
Http,
#[allow(missing_docs)] // documentation missing in model
Websocket,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for ProtocolType {
fn from(s: &str) -> Self {
match s {
"HTTP" => ProtocolType::Http,
"WEBSOCKET" => ProtocolType::Websocket,
other => ProtocolType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for ProtocolType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(ProtocolType::from(s))
}
}
impl ProtocolType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
ProtocolType::Http => "HTTP",
ProtocolType::Websocket => "WEBSOCKET",
ProtocolType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["HTTP", "WEBSOCKET"]
}
}
impl AsRef<str> for ProtocolType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Represents a CORS configuration. Supported only for HTTP APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html">Configuring CORS</a> for more information.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Cors {
/// <p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>
pub allow_credentials: bool,
/// <p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>
pub allow_headers: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>
pub allow_methods: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>
pub allow_origins: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>
pub expose_headers: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>
pub max_age: i32,
}
impl Cors {
/// <p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>
pub fn allow_credentials(&self) -> bool {
self.allow_credentials
}
/// <p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>
pub fn allow_headers(&self) -> std::option::Option<&[std::string::String]> {
self.allow_headers.as_deref()
}
/// <p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>
pub fn allow_methods(&self) -> std::option::Option<&[std::string::String]> {
self.allow_methods.as_deref()
}
/// <p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>
pub fn allow_origins(&self) -> std::option::Option<&[std::string::String]> {
self.allow_origins.as_deref()
}
/// <p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>
pub fn expose_headers(&self) -> std::option::Option<&[std::string::String]> {
self.expose_headers.as_deref()
}
/// <p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>
pub fn max_age(&self) -> i32 {
self.max_age
}
}
impl std::fmt::Debug for Cors {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Cors");
formatter.field("allow_credentials", &self.allow_credentials);
formatter.field("allow_headers", &self.allow_headers);
formatter.field("allow_methods", &self.allow_methods);
formatter.field("allow_origins", &self.allow_origins);
formatter.field("expose_headers", &self.expose_headers);
formatter.field("max_age", &self.max_age);
formatter.finish()
}
}
/// See [`Cors`](crate::model::Cors).
pub mod cors {
/// A builder for [`Cors`](crate::model::Cors).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) allow_credentials: std::option::Option<bool>,
pub(crate) allow_headers: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) allow_methods: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) allow_origins: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) expose_headers: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) max_age: std::option::Option<i32>,
}
impl Builder {
/// <p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>
pub fn allow_credentials(mut self, input: bool) -> Self {
self.allow_credentials = Some(input);
self
}
/// <p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>
pub fn set_allow_credentials(mut self, input: std::option::Option<bool>) -> Self {
self.allow_credentials = input;
self
}
/// Appends an item to `allow_headers`.
///
/// To override the contents of this collection use [`set_allow_headers`](Self::set_allow_headers).
///
/// <p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>
pub fn allow_headers(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.allow_headers.unwrap_or_default();
v.push(input.into());
self.allow_headers = Some(v);
self
}
/// <p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>
pub fn set_allow_headers(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.allow_headers = input;
self
}
/// Appends an item to `allow_methods`.
///
/// To override the contents of this collection use [`set_allow_methods`](Self::set_allow_methods).
///
/// <p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>
pub fn allow_methods(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.allow_methods.unwrap_or_default();
v.push(input.into());
self.allow_methods = Some(v);
self
}
/// <p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>
pub fn set_allow_methods(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.allow_methods = input;
self
}
/// Appends an item to `allow_origins`.
///
/// To override the contents of this collection use [`set_allow_origins`](Self::set_allow_origins).
///
/// <p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>
pub fn allow_origins(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.allow_origins.unwrap_or_default();
v.push(input.into());
self.allow_origins = Some(v);
self
}
/// <p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>
pub fn set_allow_origins(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.allow_origins = input;
self
}
/// Appends an item to `expose_headers`.
///
/// To override the contents of this collection use [`set_expose_headers`](Self::set_expose_headers).
///
/// <p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>
pub fn expose_headers(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.expose_headers.unwrap_or_default();
v.push(input.into());
self.expose_headers = Some(v);
self
}
/// <p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>
pub fn set_expose_headers(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.expose_headers = input;
self
}
/// <p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>
pub fn max_age(mut self, input: i32) -> Self {
self.max_age = Some(input);
self
}
/// <p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>
pub fn set_max_age(mut self, input: std::option::Option<i32>) -> Self {
self.max_age = input;
self
}
/// Consumes the builder and constructs a [`Cors`](crate::model::Cors).
pub fn build(self) -> crate::model::Cors {
crate::model::Cors {
allow_credentials: self.allow_credentials.unwrap_or_default(),
allow_headers: self.allow_headers,
allow_methods: self.allow_methods,
allow_origins: self.allow_origins,
expose_headers: self.expose_headers,
max_age: self.max_age.unwrap_or_default(),
}
}
}
}
impl Cors {
/// Creates a new builder-style object to manufacture [`Cors`](crate::model::Cors).
pub fn builder() -> crate::model::cors::Builder {
crate::model::cors::Builder::default()
}
}
/// <p>Represents a VPC link.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct VpcLink {
/// <p>The timestamp when the VPC link was created.</p>
pub created_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The name of the VPC link.</p>
pub name: std::option::Option<std::string::String>,
/// <p>A list of security group IDs for the VPC link.</p>
pub security_group_ids: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>A list of subnet IDs to include in the VPC link.</p>
pub subnet_ids: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>Tags for the VPC link.</p>
pub tags:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>The ID of the VPC link.</p>
pub vpc_link_id: std::option::Option<std::string::String>,
/// <p>The status of the VPC link.</p>
pub vpc_link_status: std::option::Option<crate::model::VpcLinkStatus>,
/// <p>A message summarizing the cause of the status of the VPC link.</p>
pub vpc_link_status_message: std::option::Option<std::string::String>,
/// <p>The version of the VPC link.</p>
pub vpc_link_version: std::option::Option<crate::model::VpcLinkVersion>,
}
impl VpcLink {
/// <p>The timestamp when the VPC link was created.</p>
pub fn created_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.created_date.as_ref()
}
/// <p>The name of the VPC link.</p>
pub fn name(&self) -> std::option::Option<&str> {
self.name.as_deref()
}
/// <p>A list of security group IDs for the VPC link.</p>
pub fn security_group_ids(&self) -> std::option::Option<&[std::string::String]> {
self.security_group_ids.as_deref()
}
/// <p>A list of subnet IDs to include in the VPC link.</p>
pub fn subnet_ids(&self) -> std::option::Option<&[std::string::String]> {
self.subnet_ids.as_deref()
}
/// <p>Tags for the VPC link.</p>
pub fn tags(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.tags.as_ref()
}
/// <p>The ID of the VPC link.</p>
pub fn vpc_link_id(&self) -> std::option::Option<&str> {
self.vpc_link_id.as_deref()
}
/// <p>The status of the VPC link.</p>
pub fn vpc_link_status(&self) -> std::option::Option<&crate::model::VpcLinkStatus> {
self.vpc_link_status.as_ref()
}
/// <p>A message summarizing the cause of the status of the VPC link.</p>
pub fn vpc_link_status_message(&self) -> std::option::Option<&str> {
self.vpc_link_status_message.as_deref()
}
/// <p>The version of the VPC link.</p>
pub fn vpc_link_version(&self) -> std::option::Option<&crate::model::VpcLinkVersion> {
self.vpc_link_version.as_ref()
}
}
impl std::fmt::Debug for VpcLink {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("VpcLink");
formatter.field("created_date", &self.created_date);
formatter.field("name", &self.name);
formatter.field("security_group_ids", &self.security_group_ids);
formatter.field("subnet_ids", &self.subnet_ids);
formatter.field("tags", &self.tags);
formatter.field("vpc_link_id", &self.vpc_link_id);
formatter.field("vpc_link_status", &self.vpc_link_status);
formatter.field("vpc_link_status_message", &self.vpc_link_status_message);
formatter.field("vpc_link_version", &self.vpc_link_version);
formatter.finish()
}
}
/// See [`VpcLink`](crate::model::VpcLink).
pub mod vpc_link {
/// A builder for [`VpcLink`](crate::model::VpcLink).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) created_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) name: std::option::Option<std::string::String>,
pub(crate) security_group_ids: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) subnet_ids: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) tags: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) vpc_link_id: std::option::Option<std::string::String>,
pub(crate) vpc_link_status: std::option::Option<crate::model::VpcLinkStatus>,
pub(crate) vpc_link_status_message: std::option::Option<std::string::String>,
pub(crate) vpc_link_version: std::option::Option<crate::model::VpcLinkVersion>,
}
impl Builder {
/// <p>The timestamp when the VPC link was created.</p>
pub fn created_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.created_date = Some(input);
self
}
/// <p>The timestamp when the VPC link was created.</p>
pub fn set_created_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.created_date = input;
self
}
/// <p>The name of the VPC link.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.name = Some(input.into());
self
}
/// <p>The name of the VPC link.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.name = input;
self
}
/// Appends an item to `security_group_ids`.
///
/// To override the contents of this collection use [`set_security_group_ids`](Self::set_security_group_ids).
///
/// <p>A list of security group IDs for the VPC link.</p>
pub fn security_group_ids(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.security_group_ids.unwrap_or_default();
v.push(input.into());
self.security_group_ids = Some(v);
self
}
/// <p>A list of security group IDs for the VPC link.</p>
pub fn set_security_group_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.security_group_ids = input;
self
}
/// Appends an item to `subnet_ids`.
///
/// To override the contents of this collection use [`set_subnet_ids`](Self::set_subnet_ids).
///
/// <p>A list of subnet IDs to include in the VPC link.</p>
pub fn subnet_ids(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.subnet_ids.unwrap_or_default();
v.push(input.into());
self.subnet_ids = Some(v);
self
}
/// <p>A list of subnet IDs to include in the VPC link.</p>
pub fn set_subnet_ids(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.subnet_ids = input;
self
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Tags for the VPC link.</p>
pub fn tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = Some(hash_map);
self
}
/// <p>Tags for the VPC link.</p>
pub fn set_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.tags = input;
self
}
/// <p>The ID of the VPC link.</p>
pub fn vpc_link_id(mut self, input: impl Into<std::string::String>) -> Self {
self.vpc_link_id = Some(input.into());
self
}
/// <p>The ID of the VPC link.</p>
pub fn set_vpc_link_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.vpc_link_id = input;
self
}
/// <p>The status of the VPC link.</p>
pub fn vpc_link_status(mut self, input: crate::model::VpcLinkStatus) -> Self {
self.vpc_link_status = Some(input);
self
}
/// <p>The status of the VPC link.</p>
pub fn set_vpc_link_status(
mut self,
input: std::option::Option<crate::model::VpcLinkStatus>,
) -> Self {
self.vpc_link_status = input;
self
}
/// <p>A message summarizing the cause of the status of the VPC link.</p>
pub fn vpc_link_status_message(mut self, input: impl Into<std::string::String>) -> Self {
self.vpc_link_status_message = Some(input.into());
self
}
/// <p>A message summarizing the cause of the status of the VPC link.</p>
pub fn set_vpc_link_status_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.vpc_link_status_message = input;
self
}
/// <p>The version of the VPC link.</p>
pub fn vpc_link_version(mut self, input: crate::model::VpcLinkVersion) -> Self {
self.vpc_link_version = Some(input);
self
}
/// <p>The version of the VPC link.</p>
pub fn set_vpc_link_version(
mut self,
input: std::option::Option<crate::model::VpcLinkVersion>,
) -> Self {
self.vpc_link_version = input;
self
}
/// Consumes the builder and constructs a [`VpcLink`](crate::model::VpcLink).
pub fn build(self) -> crate::model::VpcLink {
crate::model::VpcLink {
created_date: self.created_date,
name: self.name,
security_group_ids: self.security_group_ids,
subnet_ids: self.subnet_ids,
tags: self.tags,
vpc_link_id: self.vpc_link_id,
vpc_link_status: self.vpc_link_status,
vpc_link_status_message: self.vpc_link_status_message,
vpc_link_version: self.vpc_link_version,
}
}
}
}
impl VpcLink {
/// Creates a new builder-style object to manufacture [`VpcLink`](crate::model::VpcLink).
pub fn builder() -> crate::model::vpc_link::Builder {
crate::model::vpc_link::Builder::default()
}
}
/// <p>Represents an API stage.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Stage {
/// <p>Settings for logging access in this stage.</p>
pub access_log_settings: std::option::Option<crate::model::AccessLogSettings>,
/// <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
pub api_gateway_managed: bool,
/// <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
pub auto_deploy: bool,
/// <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
pub client_certificate_id: std::option::Option<std::string::String>,
/// <p>The timestamp when the stage was created.</p>
pub created_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>Default route settings for the stage.</p>
pub default_route_settings: std::option::Option<crate::model::RouteSettings>,
/// <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
pub deployment_id: std::option::Option<std::string::String>,
/// <p>The description of the stage.</p>
pub description: std::option::Option<std::string::String>,
/// <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
pub last_deployment_status_message: std::option::Option<std::string::String>,
/// <p>The timestamp when the stage was last updated.</p>
pub last_updated_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>Route settings for the stage, by routeKey.</p>
pub route_settings: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::RouteSettings>,
>,
/// <p>The name of the stage.</p>
pub stage_name: std::option::Option<std::string::String>,
/// <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
pub stage_variables:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>The collection of tags. Each tag element is associated with a given resource.</p>
pub tags:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
}
impl Stage {
/// <p>Settings for logging access in this stage.</p>
pub fn access_log_settings(&self) -> std::option::Option<&crate::model::AccessLogSettings> {
self.access_log_settings.as_ref()
}
/// <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
pub fn api_gateway_managed(&self) -> bool {
self.api_gateway_managed
}
/// <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
pub fn auto_deploy(&self) -> bool {
self.auto_deploy
}
/// <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
pub fn client_certificate_id(&self) -> std::option::Option<&str> {
self.client_certificate_id.as_deref()
}
/// <p>The timestamp when the stage was created.</p>
pub fn created_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.created_date.as_ref()
}
/// <p>Default route settings for the stage.</p>
pub fn default_route_settings(&self) -> std::option::Option<&crate::model::RouteSettings> {
self.default_route_settings.as_ref()
}
/// <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
pub fn deployment_id(&self) -> std::option::Option<&str> {
self.deployment_id.as_deref()
}
/// <p>The description of the stage.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
pub fn last_deployment_status_message(&self) -> std::option::Option<&str> {
self.last_deployment_status_message.as_deref()
}
/// <p>The timestamp when the stage was last updated.</p>
pub fn last_updated_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.last_updated_date.as_ref()
}
/// <p>Route settings for the stage, by routeKey.</p>
pub fn route_settings(
&self,
) -> std::option::Option<
&std::collections::HashMap<std::string::String, crate::model::RouteSettings>,
> {
self.route_settings.as_ref()
}
/// <p>The name of the stage.</p>
pub fn stage_name(&self) -> std::option::Option<&str> {
self.stage_name.as_deref()
}
/// <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
pub fn stage_variables(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.stage_variables.as_ref()
}
/// <p>The collection of tags. Each tag element is associated with a given resource.</p>
pub fn tags(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.tags.as_ref()
}
}
impl std::fmt::Debug for Stage {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Stage");
formatter.field("access_log_settings", &self.access_log_settings);
formatter.field("api_gateway_managed", &self.api_gateway_managed);
formatter.field("auto_deploy", &self.auto_deploy);
formatter.field("client_certificate_id", &self.client_certificate_id);
formatter.field("created_date", &self.created_date);
formatter.field("default_route_settings", &self.default_route_settings);
formatter.field("deployment_id", &self.deployment_id);
formatter.field("description", &self.description);
formatter.field(
"last_deployment_status_message",
&self.last_deployment_status_message,
);
formatter.field("last_updated_date", &self.last_updated_date);
formatter.field("route_settings", &self.route_settings);
formatter.field("stage_name", &self.stage_name);
formatter.field("stage_variables", &self.stage_variables);
formatter.field("tags", &self.tags);
formatter.finish()
}
}
/// See [`Stage`](crate::model::Stage).
pub mod stage {
/// A builder for [`Stage`](crate::model::Stage).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) access_log_settings: std::option::Option<crate::model::AccessLogSettings>,
pub(crate) api_gateway_managed: std::option::Option<bool>,
pub(crate) auto_deploy: std::option::Option<bool>,
pub(crate) client_certificate_id: std::option::Option<std::string::String>,
pub(crate) created_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) default_route_settings: std::option::Option<crate::model::RouteSettings>,
pub(crate) deployment_id: std::option::Option<std::string::String>,
pub(crate) description: std::option::Option<std::string::String>,
pub(crate) last_deployment_status_message: std::option::Option<std::string::String>,
pub(crate) last_updated_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) route_settings: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::RouteSettings>,
>,
pub(crate) stage_name: std::option::Option<std::string::String>,
pub(crate) stage_variables: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) tags: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
}
impl Builder {
/// <p>Settings for logging access in this stage.</p>
pub fn access_log_settings(mut self, input: crate::model::AccessLogSettings) -> Self {
self.access_log_settings = Some(input);
self
}
/// <p>Settings for logging access in this stage.</p>
pub fn set_access_log_settings(
mut self,
input: std::option::Option<crate::model::AccessLogSettings>,
) -> Self {
self.access_log_settings = input;
self
}
/// <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
pub fn api_gateway_managed(mut self, input: bool) -> Self {
self.api_gateway_managed = Some(input);
self
}
/// <p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>
pub fn set_api_gateway_managed(mut self, input: std::option::Option<bool>) -> Self {
self.api_gateway_managed = input;
self
}
/// <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
pub fn auto_deploy(mut self, input: bool) -> Self {
self.auto_deploy = Some(input);
self
}
/// <p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>
pub fn set_auto_deploy(mut self, input: std::option::Option<bool>) -> Self {
self.auto_deploy = input;
self
}
/// <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
pub fn client_certificate_id(mut self, input: impl Into<std::string::String>) -> Self {
self.client_certificate_id = Some(input.into());
self
}
/// <p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>
pub fn set_client_certificate_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.client_certificate_id = input;
self
}
/// <p>The timestamp when the stage was created.</p>
pub fn created_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.created_date = Some(input);
self
}
/// <p>The timestamp when the stage was created.</p>
pub fn set_created_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.created_date = input;
self
}
/// <p>Default route settings for the stage.</p>
pub fn default_route_settings(mut self, input: crate::model::RouteSettings) -> Self {
self.default_route_settings = Some(input);
self
}
/// <p>Default route settings for the stage.</p>
pub fn set_default_route_settings(
mut self,
input: std::option::Option<crate::model::RouteSettings>,
) -> Self {
self.default_route_settings = input;
self
}
/// <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
pub fn deployment_id(mut self, input: impl Into<std::string::String>) -> Self {
self.deployment_id = Some(input.into());
self
}
/// <p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>
pub fn set_deployment_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.deployment_id = input;
self
}
/// <p>The description of the stage.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>The description of the stage.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
pub fn last_deployment_status_message(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.last_deployment_status_message = Some(input.into());
self
}
/// <p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>
pub fn set_last_deployment_status_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.last_deployment_status_message = input;
self
}
/// <p>The timestamp when the stage was last updated.</p>
pub fn last_updated_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.last_updated_date = Some(input);
self
}
/// <p>The timestamp when the stage was last updated.</p>
pub fn set_last_updated_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.last_updated_date = input;
self
}
/// Adds a key-value pair to `route_settings`.
///
/// To override the contents of this collection use [`set_route_settings`](Self::set_route_settings).
///
/// <p>Route settings for the stage, by routeKey.</p>
pub fn route_settings(
mut self,
k: impl Into<std::string::String>,
v: crate::model::RouteSettings,
) -> Self {
let mut hash_map = self.route_settings.unwrap_or_default();
hash_map.insert(k.into(), v);
self.route_settings = Some(hash_map);
self
}
/// <p>Route settings for the stage, by routeKey.</p>
pub fn set_route_settings(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::RouteSettings>,
>,
) -> Self {
self.route_settings = input;
self
}
/// <p>The name of the stage.</p>
pub fn stage_name(mut self, input: impl Into<std::string::String>) -> Self {
self.stage_name = Some(input.into());
self
}
/// <p>The name of the stage.</p>
pub fn set_stage_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.stage_name = input;
self
}
/// Adds a key-value pair to `stage_variables`.
///
/// To override the contents of this collection use [`set_stage_variables`](Self::set_stage_variables).
///
/// <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
pub fn stage_variables(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.stage_variables.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.stage_variables = Some(hash_map);
self
}
/// <p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>
pub fn set_stage_variables(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.stage_variables = input;
self
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The collection of tags. Each tag element is associated with a given resource.</p>
pub fn tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = Some(hash_map);
self
}
/// <p>The collection of tags. Each tag element is associated with a given resource.</p>
pub fn set_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.tags = input;
self
}
/// Consumes the builder and constructs a [`Stage`](crate::model::Stage).
pub fn build(self) -> crate::model::Stage {
crate::model::Stage {
access_log_settings: self.access_log_settings,
api_gateway_managed: self.api_gateway_managed.unwrap_or_default(),
auto_deploy: self.auto_deploy.unwrap_or_default(),
client_certificate_id: self.client_certificate_id,
created_date: self.created_date,
default_route_settings: self.default_route_settings,
deployment_id: self.deployment_id,
description: self.description,
last_deployment_status_message: self.last_deployment_status_message,
last_updated_date: self.last_updated_date,
route_settings: self.route_settings,
stage_name: self.stage_name,
stage_variables: self.stage_variables,
tags: self.tags,
}
}
}
}
impl Stage {
/// Creates a new builder-style object to manufacture [`Stage`](crate::model::Stage).
pub fn builder() -> crate::model::stage::Builder {
crate::model::stage::Builder::default()
}
}
/// <p>Represents a route.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Route {
/// <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
pub api_gateway_managed: bool,
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub api_key_required: bool,
/// <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
pub authorization_scopes: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
pub authorization_type: std::option::Option<crate::model::AuthorizationType>,
/// <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
pub authorizer_id: std::option::Option<std::string::String>,
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub model_selection_expression: std::option::Option<std::string::String>,
/// <p>The operation name for the route.</p>
pub operation_name: std::option::Option<std::string::String>,
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub request_models:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub request_parameters: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
>,
/// <p>The route ID.</p>
pub route_id: std::option::Option<std::string::String>,
/// <p>The route key for the route.</p>
pub route_key: std::option::Option<std::string::String>,
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub route_response_selection_expression: std::option::Option<std::string::String>,
/// <p>The target for the route.</p>
pub target: std::option::Option<std::string::String>,
}
impl Route {
/// <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
pub fn api_gateway_managed(&self) -> bool {
self.api_gateway_managed
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn api_key_required(&self) -> bool {
self.api_key_required
}
/// <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
pub fn authorization_scopes(&self) -> std::option::Option<&[std::string::String]> {
self.authorization_scopes.as_deref()
}
/// <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
pub fn authorization_type(&self) -> std::option::Option<&crate::model::AuthorizationType> {
self.authorization_type.as_ref()
}
/// <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
pub fn authorizer_id(&self) -> std::option::Option<&str> {
self.authorizer_id.as_deref()
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn model_selection_expression(&self) -> std::option::Option<&str> {
self.model_selection_expression.as_deref()
}
/// <p>The operation name for the route.</p>
pub fn operation_name(&self) -> std::option::Option<&str> {
self.operation_name.as_deref()
}
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn request_models(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.request_models.as_ref()
}
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn request_parameters(
&self,
) -> std::option::Option<
&std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
> {
self.request_parameters.as_ref()
}
/// <p>The route ID.</p>
pub fn route_id(&self) -> std::option::Option<&str> {
self.route_id.as_deref()
}
/// <p>The route key for the route.</p>
pub fn route_key(&self) -> std::option::Option<&str> {
self.route_key.as_deref()
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn route_response_selection_expression(&self) -> std::option::Option<&str> {
self.route_response_selection_expression.as_deref()
}
/// <p>The target for the route.</p>
pub fn target(&self) -> std::option::Option<&str> {
self.target.as_deref()
}
}
impl std::fmt::Debug for Route {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Route");
formatter.field("api_gateway_managed", &self.api_gateway_managed);
formatter.field("api_key_required", &self.api_key_required);
formatter.field("authorization_scopes", &self.authorization_scopes);
formatter.field("authorization_type", &self.authorization_type);
formatter.field("authorizer_id", &self.authorizer_id);
formatter.field(
"model_selection_expression",
&self.model_selection_expression,
);
formatter.field("operation_name", &self.operation_name);
formatter.field("request_models", &self.request_models);
formatter.field("request_parameters", &self.request_parameters);
formatter.field("route_id", &self.route_id);
formatter.field("route_key", &self.route_key);
formatter.field(
"route_response_selection_expression",
&self.route_response_selection_expression,
);
formatter.field("target", &self.target);
formatter.finish()
}
}
/// See [`Route`](crate::model::Route).
pub mod route {
/// A builder for [`Route`](crate::model::Route).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) api_gateway_managed: std::option::Option<bool>,
pub(crate) api_key_required: std::option::Option<bool>,
pub(crate) authorization_scopes: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) authorization_type: std::option::Option<crate::model::AuthorizationType>,
pub(crate) authorizer_id: std::option::Option<std::string::String>,
pub(crate) model_selection_expression: std::option::Option<std::string::String>,
pub(crate) operation_name: std::option::Option<std::string::String>,
pub(crate) request_models: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) request_parameters: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
>,
pub(crate) route_id: std::option::Option<std::string::String>,
pub(crate) route_key: std::option::Option<std::string::String>,
pub(crate) route_response_selection_expression: std::option::Option<std::string::String>,
pub(crate) target: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
pub fn api_gateway_managed(mut self, input: bool) -> Self {
self.api_gateway_managed = Some(input);
self
}
/// <p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>
pub fn set_api_gateway_managed(mut self, input: std::option::Option<bool>) -> Self {
self.api_gateway_managed = input;
self
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn api_key_required(mut self, input: bool) -> Self {
self.api_key_required = Some(input);
self
}
/// <p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>
pub fn set_api_key_required(mut self, input: std::option::Option<bool>) -> Self {
self.api_key_required = input;
self
}
/// Appends an item to `authorization_scopes`.
///
/// To override the contents of this collection use [`set_authorization_scopes`](Self::set_authorization_scopes).
///
/// <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
pub fn authorization_scopes(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.authorization_scopes.unwrap_or_default();
v.push(input.into());
self.authorization_scopes = Some(v);
self
}
/// <p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>
pub fn set_authorization_scopes(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.authorization_scopes = input;
self
}
/// <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
pub fn authorization_type(mut self, input: crate::model::AuthorizationType) -> Self {
self.authorization_type = Some(input);
self
}
/// <p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>
pub fn set_authorization_type(
mut self,
input: std::option::Option<crate::model::AuthorizationType>,
) -> Self {
self.authorization_type = input;
self
}
/// <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
pub fn authorizer_id(mut self, input: impl Into<std::string::String>) -> Self {
self.authorizer_id = Some(input.into());
self
}
/// <p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>
pub fn set_authorizer_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.authorizer_id = input;
self
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn model_selection_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.model_selection_expression = Some(input.into());
self
}
/// <p>The model selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn set_model_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.model_selection_expression = input;
self
}
/// <p>The operation name for the route.</p>
pub fn operation_name(mut self, input: impl Into<std::string::String>) -> Self {
self.operation_name = Some(input.into());
self
}
/// <p>The operation name for the route.</p>
pub fn set_operation_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.operation_name = input;
self
}
/// Adds a key-value pair to `request_models`.
///
/// To override the contents of this collection use [`set_request_models`](Self::set_request_models).
///
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn request_models(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.request_models.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_models = Some(hash_map);
self
}
/// <p>The request models for the route. Supported only for WebSocket APIs.</p>
pub fn set_request_models(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.request_models = input;
self
}
/// Adds a key-value pair to `request_parameters`.
///
/// To override the contents of this collection use [`set_request_parameters`](Self::set_request_parameters).
///
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn request_parameters(
mut self,
k: impl Into<std::string::String>,
v: crate::model::ParameterConstraints,
) -> Self {
let mut hash_map = self.request_parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.request_parameters = Some(hash_map);
self
}
/// <p>The request parameters for the route. Supported only for WebSocket APIs.</p>
pub fn set_request_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
>,
) -> Self {
self.request_parameters = input;
self
}
/// <p>The route ID.</p>
pub fn route_id(mut self, input: impl Into<std::string::String>) -> Self {
self.route_id = Some(input.into());
self
}
/// <p>The route ID.</p>
pub fn set_route_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.route_id = input;
self
}
/// <p>The route key for the route.</p>
pub fn route_key(mut self, input: impl Into<std::string::String>) -> Self {
self.route_key = Some(input.into());
self
}
/// <p>The route key for the route.</p>
pub fn set_route_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.route_key = input;
self
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn route_response_selection_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.route_response_selection_expression = Some(input.into());
self
}
/// <p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>
pub fn set_route_response_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.route_response_selection_expression = input;
self
}
/// <p>The target for the route.</p>
pub fn target(mut self, input: impl Into<std::string::String>) -> Self {
self.target = Some(input.into());
self
}
/// <p>The target for the route.</p>
pub fn set_target(mut self, input: std::option::Option<std::string::String>) -> Self {
self.target = input;
self
}
/// Consumes the builder and constructs a [`Route`](crate::model::Route).
pub fn build(self) -> crate::model::Route {
crate::model::Route {
api_gateway_managed: self.api_gateway_managed.unwrap_or_default(),
api_key_required: self.api_key_required.unwrap_or_default(),
authorization_scopes: self.authorization_scopes,
authorization_type: self.authorization_type,
authorizer_id: self.authorizer_id,
model_selection_expression: self.model_selection_expression,
operation_name: self.operation_name,
request_models: self.request_models,
request_parameters: self.request_parameters,
route_id: self.route_id,
route_key: self.route_key,
route_response_selection_expression: self.route_response_selection_expression,
target: self.target,
}
}
}
}
impl Route {
/// Creates a new builder-style object to manufacture [`Route`](crate::model::Route).
pub fn builder() -> crate::model::route::Builder {
crate::model::route::Builder::default()
}
}
/// <p>Represents a route response.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct RouteResponse {
/// <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
pub model_selection_expression: std::option::Option<std::string::String>,
/// <p>Represents the response models of a route response.</p>
pub response_models:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>Represents the response parameters of a route response.</p>
pub response_parameters: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
>,
/// <p>Represents the identifier of a route response.</p>
pub route_response_id: std::option::Option<std::string::String>,
/// <p>Represents the route response key of a route response.</p>
pub route_response_key: std::option::Option<std::string::String>,
}
impl RouteResponse {
/// <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
pub fn model_selection_expression(&self) -> std::option::Option<&str> {
self.model_selection_expression.as_deref()
}
/// <p>Represents the response models of a route response.</p>
pub fn response_models(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.response_models.as_ref()
}
/// <p>Represents the response parameters of a route response.</p>
pub fn response_parameters(
&self,
) -> std::option::Option<
&std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
> {
self.response_parameters.as_ref()
}
/// <p>Represents the identifier of a route response.</p>
pub fn route_response_id(&self) -> std::option::Option<&str> {
self.route_response_id.as_deref()
}
/// <p>Represents the route response key of a route response.</p>
pub fn route_response_key(&self) -> std::option::Option<&str> {
self.route_response_key.as_deref()
}
}
impl std::fmt::Debug for RouteResponse {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("RouteResponse");
formatter.field(
"model_selection_expression",
&self.model_selection_expression,
);
formatter.field("response_models", &self.response_models);
formatter.field("response_parameters", &self.response_parameters);
formatter.field("route_response_id", &self.route_response_id);
formatter.field("route_response_key", &self.route_response_key);
formatter.finish()
}
}
/// See [`RouteResponse`](crate::model::RouteResponse).
pub mod route_response {
/// A builder for [`RouteResponse`](crate::model::RouteResponse).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) model_selection_expression: std::option::Option<std::string::String>,
pub(crate) response_models: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) response_parameters: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
>,
pub(crate) route_response_id: std::option::Option<std::string::String>,
pub(crate) route_response_key: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
pub fn model_selection_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.model_selection_expression = Some(input.into());
self
}
/// <p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>
pub fn set_model_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.model_selection_expression = input;
self
}
/// Adds a key-value pair to `response_models`.
///
/// To override the contents of this collection use [`set_response_models`](Self::set_response_models).
///
/// <p>Represents the response models of a route response.</p>
pub fn response_models(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.response_models.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.response_models = Some(hash_map);
self
}
/// <p>Represents the response models of a route response.</p>
pub fn set_response_models(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.response_models = input;
self
}
/// Adds a key-value pair to `response_parameters`.
///
/// To override the contents of this collection use [`set_response_parameters`](Self::set_response_parameters).
///
/// <p>Represents the response parameters of a route response.</p>
pub fn response_parameters(
mut self,
k: impl Into<std::string::String>,
v: crate::model::ParameterConstraints,
) -> Self {
let mut hash_map = self.response_parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.response_parameters = Some(hash_map);
self
}
/// <p>Represents the response parameters of a route response.</p>
pub fn set_response_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, crate::model::ParameterConstraints>,
>,
) -> Self {
self.response_parameters = input;
self
}
/// <p>Represents the identifier of a route response.</p>
pub fn route_response_id(mut self, input: impl Into<std::string::String>) -> Self {
self.route_response_id = Some(input.into());
self
}
/// <p>Represents the identifier of a route response.</p>
pub fn set_route_response_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.route_response_id = input;
self
}
/// <p>Represents the route response key of a route response.</p>
pub fn route_response_key(mut self, input: impl Into<std::string::String>) -> Self {
self.route_response_key = Some(input.into());
self
}
/// <p>Represents the route response key of a route response.</p>
pub fn set_route_response_key(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.route_response_key = input;
self
}
/// Consumes the builder and constructs a [`RouteResponse`](crate::model::RouteResponse).
pub fn build(self) -> crate::model::RouteResponse {
crate::model::RouteResponse {
model_selection_expression: self.model_selection_expression,
response_models: self.response_models,
response_parameters: self.response_parameters,
route_response_id: self.route_response_id,
route_response_key: self.route_response_key,
}
}
}
}
impl RouteResponse {
/// Creates a new builder-style object to manufacture [`RouteResponse`](crate::model::RouteResponse).
pub fn builder() -> crate::model::route_response::Builder {
crate::model::route_response::Builder::default()
}
}
/// <p>Represents a data model for an API. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Model {
/// <p>The content-type for the model, for example, "application/json".</p>
pub content_type: std::option::Option<std::string::String>,
/// <p>The description of the model.</p>
pub description: std::option::Option<std::string::String>,
/// <p>The model identifier.</p>
pub model_id: std::option::Option<std::string::String>,
/// <p>The name of the model. Must be alphanumeric.</p>
pub name: std::option::Option<std::string::String>,
/// <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
pub schema: std::option::Option<std::string::String>,
}
impl Model {
/// <p>The content-type for the model, for example, "application/json".</p>
pub fn content_type(&self) -> std::option::Option<&str> {
self.content_type.as_deref()
}
/// <p>The description of the model.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The model identifier.</p>
pub fn model_id(&self) -> std::option::Option<&str> {
self.model_id.as_deref()
}
/// <p>The name of the model. Must be alphanumeric.</p>
pub fn name(&self) -> std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
pub fn schema(&self) -> std::option::Option<&str> {
self.schema.as_deref()
}
}
impl std::fmt::Debug for Model {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Model");
formatter.field("content_type", &self.content_type);
formatter.field("description", &self.description);
formatter.field("model_id", &self.model_id);
formatter.field("name", &self.name);
formatter.field("schema", &self.schema);
formatter.finish()
}
}
/// See [`Model`](crate::model::Model).
pub mod model {
/// A builder for [`Model`](crate::model::Model).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) content_type: std::option::Option<std::string::String>,
pub(crate) description: std::option::Option<std::string::String>,
pub(crate) model_id: std::option::Option<std::string::String>,
pub(crate) name: std::option::Option<std::string::String>,
pub(crate) schema: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>The content-type for the model, for example, "application/json".</p>
pub fn content_type(mut self, input: impl Into<std::string::String>) -> Self {
self.content_type = Some(input.into());
self
}
/// <p>The content-type for the model, for example, "application/json".</p>
pub fn set_content_type(mut self, input: std::option::Option<std::string::String>) -> Self {
self.content_type = input;
self
}
/// <p>The description of the model.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>The description of the model.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The model identifier.</p>
pub fn model_id(mut self, input: impl Into<std::string::String>) -> Self {
self.model_id = Some(input.into());
self
}
/// <p>The model identifier.</p>
pub fn set_model_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.model_id = input;
self
}
/// <p>The name of the model. Must be alphanumeric.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.name = Some(input.into());
self
}
/// <p>The name of the model. Must be alphanumeric.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
pub fn schema(mut self, input: impl Into<std::string::String>) -> Self {
self.schema = Some(input.into());
self
}
/// <p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>
pub fn set_schema(mut self, input: std::option::Option<std::string::String>) -> Self {
self.schema = input;
self
}
/// Consumes the builder and constructs a [`Model`](crate::model::Model).
pub fn build(self) -> crate::model::Model {
crate::model::Model {
content_type: self.content_type,
description: self.description,
model_id: self.model_id,
name: self.name,
schema: self.schema,
}
}
}
}
impl Model {
/// Creates a new builder-style object to manufacture [`Model`](crate::model::Model).
pub fn builder() -> crate::model::model::Builder {
crate::model::model::Builder::default()
}
}
/// <p>Represents an integration.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Integration {
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub api_gateway_managed: bool,
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub connection_id: std::option::Option<std::string::String>,
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub connection_type: std::option::Option<crate::model::ConnectionType>,
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub content_handling_strategy: std::option::Option<crate::model::ContentHandlingStrategy>,
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub credentials_arn: std::option::Option<std::string::String>,
/// <p>Represents the description of an integration.</p>
pub description: std::option::Option<std::string::String>,
/// <p>Represents the identifier of an integration.</p>
pub integration_id: std::option::Option<std::string::String>,
/// <p>Specifies the integration's HTTP method type.</p>
pub integration_method: std::option::Option<std::string::String>,
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub integration_response_selection_expression: std::option::Option<std::string::String>,
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub integration_subtype: std::option::Option<std::string::String>,
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub integration_type: std::option::Option<crate::model::IntegrationType>,
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub integration_uri: std::option::Option<std::string::String>,
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub passthrough_behavior: std::option::Option<crate::model::PassthroughBehavior>,
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub payload_format_version: std::option::Option<std::string::String>,
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub request_parameters:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub request_templates:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub response_parameters: std::option::Option<
std::collections::HashMap<
std::string::String,
std::collections::HashMap<std::string::String, std::string::String>,
>,
>,
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub template_selection_expression: std::option::Option<std::string::String>,
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub timeout_in_millis: i32,
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub tls_config: std::option::Option<crate::model::TlsConfig>,
}
impl Integration {
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn api_gateway_managed(&self) -> bool {
self.api_gateway_managed
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn connection_id(&self) -> std::option::Option<&str> {
self.connection_id.as_deref()
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn connection_type(&self) -> std::option::Option<&crate::model::ConnectionType> {
self.connection_type.as_ref()
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn content_handling_strategy(
&self,
) -> std::option::Option<&crate::model::ContentHandlingStrategy> {
self.content_handling_strategy.as_ref()
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn credentials_arn(&self) -> std::option::Option<&str> {
self.credentials_arn.as_deref()
}
/// <p>Represents the description of an integration.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Represents the identifier of an integration.</p>
pub fn integration_id(&self) -> std::option::Option<&str> {
self.integration_id.as_deref()
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn integration_method(&self) -> std::option::Option<&str> {
self.integration_method.as_deref()
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn integration_response_selection_expression(&self) -> std::option::Option<&str> {
self.integration_response_selection_expression.as_deref()
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn integration_subtype(&self) -> std::option::Option<&str> {
self.integration_subtype.as_deref()
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn integration_type(&self) -> std::option::Option<&crate::model::IntegrationType> {
self.integration_type.as_ref()
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn integration_uri(&self) -> std::option::Option<&str> {
self.integration_uri.as_deref()
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn passthrough_behavior(&self) -> std::option::Option<&crate::model::PassthroughBehavior> {
self.passthrough_behavior.as_ref()
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn payload_format_version(&self) -> std::option::Option<&str> {
self.payload_format_version.as_deref()
}
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn request_parameters(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.request_parameters.as_ref()
}
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn request_templates(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.request_templates.as_ref()
}
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn response_parameters(
&self,
) -> std::option::Option<
&std::collections::HashMap<
std::string::String,
std::collections::HashMap<std::string::String, std::string::String>,
>,
> {
self.response_parameters.as_ref()
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn template_selection_expression(&self) -> std::option::Option<&str> {
self.template_selection_expression.as_deref()
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn timeout_in_millis(&self) -> i32 {
self.timeout_in_millis
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn tls_config(&self) -> std::option::Option<&crate::model::TlsConfig> {
self.tls_config.as_ref()
}
}
impl std::fmt::Debug for Integration {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Integration");
formatter.field("api_gateway_managed", &self.api_gateway_managed);
formatter.field("connection_id", &self.connection_id);
formatter.field("connection_type", &self.connection_type);
formatter.field("content_handling_strategy", &self.content_handling_strategy);
formatter.field("credentials_arn", &self.credentials_arn);
formatter.field("description", &self.description);
formatter.field("integration_id", &self.integration_id);
formatter.field("integration_method", &self.integration_method);
formatter.field(
"integration_response_selection_expression",
&self.integration_response_selection_expression,
);
formatter.field("integration_subtype", &self.integration_subtype);
formatter.field("integration_type", &self.integration_type);
formatter.field("integration_uri", &self.integration_uri);
formatter.field("passthrough_behavior", &self.passthrough_behavior);
formatter.field("payload_format_version", &self.payload_format_version);
formatter.field("request_parameters", &self.request_parameters);
formatter.field("request_templates", &self.request_templates);
formatter.field("response_parameters", &self.response_parameters);
formatter.field(
"template_selection_expression",
&self.template_selection_expression,
);
formatter.field("timeout_in_millis", &self.timeout_in_millis);
formatter.field("tls_config", &self.tls_config);
formatter.finish()
}
}
/// See [`Integration`](crate::model::Integration).
pub mod integration {
/// A builder for [`Integration`](crate::model::Integration).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) api_gateway_managed: std::option::Option<bool>,
pub(crate) connection_id: std::option::Option<std::string::String>,
pub(crate) connection_type: std::option::Option<crate::model::ConnectionType>,
pub(crate) content_handling_strategy:
std::option::Option<crate::model::ContentHandlingStrategy>,
pub(crate) credentials_arn: std::option::Option<std::string::String>,
pub(crate) description: std::option::Option<std::string::String>,
pub(crate) integration_id: std::option::Option<std::string::String>,
pub(crate) integration_method: std::option::Option<std::string::String>,
pub(crate) integration_response_selection_expression:
std::option::Option<std::string::String>,
pub(crate) integration_subtype: std::option::Option<std::string::String>,
pub(crate) integration_type: std::option::Option<crate::model::IntegrationType>,
pub(crate) integration_uri: std::option::Option<std::string::String>,
pub(crate) passthrough_behavior: std::option::Option<crate::model::PassthroughBehavior>,
pub(crate) payload_format_version: std::option::Option<std::string::String>,
pub(crate) request_parameters: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) request_templates: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) response_parameters: std::option::Option<
std::collections::HashMap<
std::string::String,
std::collections::HashMap<std::string::String, std::string::String>,
>,
>,
pub(crate) template_selection_expression: std::option::Option<std::string::String>,
pub(crate) timeout_in_millis: std::option::Option<i32>,
pub(crate) tls_config: std::option::Option<crate::model::TlsConfig>,
}
impl Builder {
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn api_gateway_managed(mut self, input: bool) -> Self {
self.api_gateway_managed = Some(input);
self
}
/// <p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>
pub fn set_api_gateway_managed(mut self, input: std::option::Option<bool>) -> Self {
self.api_gateway_managed = input;
self
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn connection_id(mut self, input: impl Into<std::string::String>) -> Self {
self.connection_id = Some(input.into());
self
}
/// <p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>
pub fn set_connection_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.connection_id = input;
self
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn connection_type(mut self, input: crate::model::ConnectionType) -> Self {
self.connection_type = Some(input);
self
}
/// <p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>
pub fn set_connection_type(
mut self,
input: std::option::Option<crate::model::ConnectionType>,
) -> Self {
self.connection_type = input;
self
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn content_handling_strategy(
mut self,
input: crate::model::ContentHandlingStrategy,
) -> Self {
self.content_handling_strategy = Some(input);
self
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn set_content_handling_strategy(
mut self,
input: std::option::Option<crate::model::ContentHandlingStrategy>,
) -> Self {
self.content_handling_strategy = input;
self
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn credentials_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.credentials_arn = Some(input.into());
self
}
/// <p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>
pub fn set_credentials_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.credentials_arn = input;
self
}
/// <p>Represents the description of an integration.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>Represents the description of an integration.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Represents the identifier of an integration.</p>
pub fn integration_id(mut self, input: impl Into<std::string::String>) -> Self {
self.integration_id = Some(input.into());
self
}
/// <p>Represents the identifier of an integration.</p>
pub fn set_integration_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_id = input;
self
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn integration_method(mut self, input: impl Into<std::string::String>) -> Self {
self.integration_method = Some(input.into());
self
}
/// <p>Specifies the integration's HTTP method type.</p>
pub fn set_integration_method(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_method = input;
self
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn integration_response_selection_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.integration_response_selection_expression = Some(input.into());
self
}
/// <p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions">Integration Response Selection Expressions</a>.</p>
pub fn set_integration_response_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_response_selection_expression = input;
self
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn integration_subtype(mut self, input: impl Into<std::string::String>) -> Self {
self.integration_subtype = Some(input.into());
self
}
/// <p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html">Integration subtype reference</a>.</p>
pub fn set_integration_subtype(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_subtype = input;
self
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn integration_type(mut self, input: crate::model::IntegrationType) -> Self {
self.integration_type = Some(input);
self
}
/// <p>The integration type of an integration. One of the following:</p>
/// <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p>
/// <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p>
/// <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p>
/// <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p>
/// <p>MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>
pub fn set_integration_type(
mut self,
input: std::option::Option<crate::model::IntegrationType>,
) -> Self {
self.integration_type = input;
self
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn integration_uri(mut self, input: impl Into<std::string::String>) -> Self {
self.integration_uri = Some(input.into());
self
}
/// <p>For a Lambda integration, specify the URI of a Lambda function.</p>
/// <p>For an HTTP integration, specify a fully-qualified URL.</p>
/// <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>
pub fn set_integration_uri(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_uri = input;
self
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn passthrough_behavior(mut self, input: crate::model::PassthroughBehavior) -> Self {
self.passthrough_behavior = Some(input);
self
}
/// <p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p>
/// <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p>
/// <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p>
/// <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>
pub fn set_passthrough_behavior(
mut self,
input: std::option::Option<crate::model::PassthroughBehavior>,
) -> Self {
self.passthrough_behavior = input;
self
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn payload_format_version(mut self, input: impl Into<std::string::String>) -> Self {
self.payload_format_version = Some(input.into());
self
}
/// <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
pub fn set_payload_format_version(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.payload_format_version = input;
self
}
/// Adds a key-value pair to `request_parameters`.
///
/// To override the contents of this collection use [`set_request_parameters`](Self::set_request_parameters).
///
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn request_parameters(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.request_parameters.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_parameters = Some(hash_map);
self
}
/// <p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>
/// {location}
/// </replaceable>.<replaceable>
/// {name}
/// </replaceable> , where <replaceable>
/// {location}
/// </replaceable> is querystring, path, or header; and <replaceable>
/// {name}
/// </replaceable> must be a valid and unique method request parameter name.</p>
/// <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html">Working with AWS service integrations for HTTP APIs</a>.</p>
/// <p>For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn set_request_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.request_parameters = input;
self
}
/// Adds a key-value pair to `request_templates`.
///
/// To override the contents of this collection use [`set_request_templates`](Self::set_request_templates).
///
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn request_templates(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.request_templates.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.request_templates = Some(hash_map);
self
}
/// <p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>
pub fn set_request_templates(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.request_templates = input;
self
}
/// Adds a key-value pair to `response_parameters`.
///
/// To override the contents of this collection use [`set_response_parameters`](Self::set_response_parameters).
///
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn response_parameters(
mut self,
k: impl Into<std::string::String>,
v: std::collections::HashMap<std::string::String, std::string::String>,
) -> Self {
let mut hash_map = self.response_parameters.unwrap_or_default();
hash_map.insert(k.into(), v);
self.response_parameters = Some(hash_map);
self
}
/// <p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html">Transforming API requests and responses</a>.</p>
pub fn set_response_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<
std::string::String,
std::collections::HashMap<std::string::String, std::string::String>,
>,
>,
) -> Self {
self.response_parameters = input;
self
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn template_selection_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.template_selection_expression = Some(input.into());
self
}
/// <p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>
pub fn set_template_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.template_selection_expression = input;
self
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn timeout_in_millis(mut self, input: i32) -> Self {
self.timeout_in_millis = Some(input);
self
}
/// <p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>
pub fn set_timeout_in_millis(mut self, input: std::option::Option<i32>) -> Self {
self.timeout_in_millis = input;
self
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn tls_config(mut self, input: crate::model::TlsConfig) -> Self {
self.tls_config = Some(input);
self
}
/// <p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>
pub fn set_tls_config(
mut self,
input: std::option::Option<crate::model::TlsConfig>,
) -> Self {
self.tls_config = input;
self
}
/// Consumes the builder and constructs a [`Integration`](crate::model::Integration).
pub fn build(self) -> crate::model::Integration {
crate::model::Integration {
api_gateway_managed: self.api_gateway_managed.unwrap_or_default(),
connection_id: self.connection_id,
connection_type: self.connection_type,
content_handling_strategy: self.content_handling_strategy,
credentials_arn: self.credentials_arn,
description: self.description,
integration_id: self.integration_id,
integration_method: self.integration_method,
integration_response_selection_expression: self
.integration_response_selection_expression,
integration_subtype: self.integration_subtype,
integration_type: self.integration_type,
integration_uri: self.integration_uri,
passthrough_behavior: self.passthrough_behavior,
payload_format_version: self.payload_format_version,
request_parameters: self.request_parameters,
request_templates: self.request_templates,
response_parameters: self.response_parameters,
template_selection_expression: self.template_selection_expression,
timeout_in_millis: self.timeout_in_millis.unwrap_or_default(),
tls_config: self.tls_config,
}
}
}
}
impl Integration {
/// Creates a new builder-style object to manufacture [`Integration`](crate::model::Integration).
pub fn builder() -> crate::model::integration::Builder {
crate::model::integration::Builder::default()
}
}
/// <p>Represents an integration response.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct IntegrationResponse {
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub content_handling_strategy: std::option::Option<crate::model::ContentHandlingStrategy>,
/// <p>The integration response ID.</p>
pub integration_response_id: std::option::Option<std::string::String>,
/// <p>The integration response key.</p>
pub integration_response_key: std::option::Option<std::string::String>,
/// <p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
pub response_parameters:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
pub response_templates:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>The template selection expressions for the integration response.</p>
pub template_selection_expression: std::option::Option<std::string::String>,
}
impl IntegrationResponse {
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn content_handling_strategy(
&self,
) -> std::option::Option<&crate::model::ContentHandlingStrategy> {
self.content_handling_strategy.as_ref()
}
/// <p>The integration response ID.</p>
pub fn integration_response_id(&self) -> std::option::Option<&str> {
self.integration_response_id.as_deref()
}
/// <p>The integration response key.</p>
pub fn integration_response_key(&self) -> std::option::Option<&str> {
self.integration_response_key.as_deref()
}
/// <p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
pub fn response_parameters(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.response_parameters.as_ref()
}
/// <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
pub fn response_templates(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.response_templates.as_ref()
}
/// <p>The template selection expressions for the integration response.</p>
pub fn template_selection_expression(&self) -> std::option::Option<&str> {
self.template_selection_expression.as_deref()
}
}
impl std::fmt::Debug for IntegrationResponse {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("IntegrationResponse");
formatter.field("content_handling_strategy", &self.content_handling_strategy);
formatter.field("integration_response_id", &self.integration_response_id);
formatter.field("integration_response_key", &self.integration_response_key);
formatter.field("response_parameters", &self.response_parameters);
formatter.field("response_templates", &self.response_templates);
formatter.field(
"template_selection_expression",
&self.template_selection_expression,
);
formatter.finish()
}
}
/// See [`IntegrationResponse`](crate::model::IntegrationResponse).
pub mod integration_response {
/// A builder for [`IntegrationResponse`](crate::model::IntegrationResponse).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) content_handling_strategy:
std::option::Option<crate::model::ContentHandlingStrategy>,
pub(crate) integration_response_id: std::option::Option<std::string::String>,
pub(crate) integration_response_key: std::option::Option<std::string::String>,
pub(crate) response_parameters: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) response_templates: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) template_selection_expression: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn content_handling_strategy(
mut self,
input: crate::model::ContentHandlingStrategy,
) -> Self {
self.content_handling_strategy = Some(input);
self
}
/// <p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p>
/// <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p>
/// <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p>
/// <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>
pub fn set_content_handling_strategy(
mut self,
input: std::option::Option<crate::model::ContentHandlingStrategy>,
) -> Self {
self.content_handling_strategy = input;
self
}
/// <p>The integration response ID.</p>
pub fn integration_response_id(mut self, input: impl Into<std::string::String>) -> Self {
self.integration_response_id = Some(input.into());
self
}
/// <p>The integration response ID.</p>
pub fn set_integration_response_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_response_id = input;
self
}
/// <p>The integration response key.</p>
pub fn integration_response_key(mut self, input: impl Into<std::string::String>) -> Self {
self.integration_response_key = Some(input.into());
self
}
/// <p>The integration response key.</p>
pub fn set_integration_response_key(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.integration_response_key = input;
self
}
/// Adds a key-value pair to `response_parameters`.
///
/// To override the contents of this collection use [`set_response_parameters`](Self::set_response_parameters).
///
/// <p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
pub fn response_parameters(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.response_parameters.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.response_parameters = Some(hash_map);
self
}
/// <p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>
pub fn set_response_parameters(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.response_parameters = input;
self
}
/// Adds a key-value pair to `response_templates`.
///
/// To override the contents of this collection use [`set_response_templates`](Self::set_response_templates).
///
/// <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
pub fn response_templates(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.response_templates.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.response_templates = Some(hash_map);
self
}
/// <p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>
pub fn set_response_templates(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.response_templates = input;
self
}
/// <p>The template selection expressions for the integration response.</p>
pub fn template_selection_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.template_selection_expression = Some(input.into());
self
}
/// <p>The template selection expressions for the integration response.</p>
pub fn set_template_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.template_selection_expression = input;
self
}
/// Consumes the builder and constructs a [`IntegrationResponse`](crate::model::IntegrationResponse).
pub fn build(self) -> crate::model::IntegrationResponse {
crate::model::IntegrationResponse {
content_handling_strategy: self.content_handling_strategy,
integration_response_id: self.integration_response_id,
integration_response_key: self.integration_response_key,
response_parameters: self.response_parameters,
response_templates: self.response_templates,
template_selection_expression: self.template_selection_expression,
}
}
}
}
impl IntegrationResponse {
/// Creates a new builder-style object to manufacture [`IntegrationResponse`](crate::model::IntegrationResponse).
pub fn builder() -> crate::model::integration_response::Builder {
crate::model::integration_response::Builder::default()
}
}
/// <p>Represents a domain name.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct DomainName {
/// <p>The API mapping selection expression.</p>
pub api_mapping_selection_expression: std::option::Option<std::string::String>,
/// <p>The name of the DomainName resource.</p>
pub domain_name: std::option::Option<std::string::String>,
/// <p>The domain name configurations.</p>
pub domain_name_configurations:
std::option::Option<std::vec::Vec<crate::model::DomainNameConfiguration>>,
/// <p>The mutual TLS authentication configuration for a custom domain name.</p>
pub mutual_tls_authentication: std::option::Option<crate::model::MutualTlsAuthentication>,
/// <p>The collection of tags associated with a domain name.</p>
pub tags:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
}
impl DomainName {
/// <p>The API mapping selection expression.</p>
pub fn api_mapping_selection_expression(&self) -> std::option::Option<&str> {
self.api_mapping_selection_expression.as_deref()
}
/// <p>The name of the DomainName resource.</p>
pub fn domain_name(&self) -> std::option::Option<&str> {
self.domain_name.as_deref()
}
/// <p>The domain name configurations.</p>
pub fn domain_name_configurations(
&self,
) -> std::option::Option<&[crate::model::DomainNameConfiguration]> {
self.domain_name_configurations.as_deref()
}
/// <p>The mutual TLS authentication configuration for a custom domain name.</p>
pub fn mutual_tls_authentication(
&self,
) -> std::option::Option<&crate::model::MutualTlsAuthentication> {
self.mutual_tls_authentication.as_ref()
}
/// <p>The collection of tags associated with a domain name.</p>
pub fn tags(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.tags.as_ref()
}
}
impl std::fmt::Debug for DomainName {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("DomainName");
formatter.field(
"api_mapping_selection_expression",
&self.api_mapping_selection_expression,
);
formatter.field("domain_name", &self.domain_name);
formatter.field(
"domain_name_configurations",
&self.domain_name_configurations,
);
formatter.field("mutual_tls_authentication", &self.mutual_tls_authentication);
formatter.field("tags", &self.tags);
formatter.finish()
}
}
/// See [`DomainName`](crate::model::DomainName).
pub mod domain_name {
/// A builder for [`DomainName`](crate::model::DomainName).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) api_mapping_selection_expression: std::option::Option<std::string::String>,
pub(crate) domain_name: std::option::Option<std::string::String>,
pub(crate) domain_name_configurations:
std::option::Option<std::vec::Vec<crate::model::DomainNameConfiguration>>,
pub(crate) mutual_tls_authentication:
std::option::Option<crate::model::MutualTlsAuthentication>,
pub(crate) tags: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
}
impl Builder {
/// <p>The API mapping selection expression.</p>
pub fn api_mapping_selection_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.api_mapping_selection_expression = Some(input.into());
self
}
/// <p>The API mapping selection expression.</p>
pub fn set_api_mapping_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.api_mapping_selection_expression = input;
self
}
/// <p>The name of the DomainName resource.</p>
pub fn domain_name(mut self, input: impl Into<std::string::String>) -> Self {
self.domain_name = Some(input.into());
self
}
/// <p>The name of the DomainName resource.</p>
pub fn set_domain_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.domain_name = input;
self
}
/// Appends an item to `domain_name_configurations`.
///
/// To override the contents of this collection use [`set_domain_name_configurations`](Self::set_domain_name_configurations).
///
/// <p>The domain name configurations.</p>
pub fn domain_name_configurations(
mut self,
input: crate::model::DomainNameConfiguration,
) -> Self {
let mut v = self.domain_name_configurations.unwrap_or_default();
v.push(input);
self.domain_name_configurations = Some(v);
self
}
/// <p>The domain name configurations.</p>
pub fn set_domain_name_configurations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::DomainNameConfiguration>>,
) -> Self {
self.domain_name_configurations = input;
self
}
/// <p>The mutual TLS authentication configuration for a custom domain name.</p>
pub fn mutual_tls_authentication(
mut self,
input: crate::model::MutualTlsAuthentication,
) -> Self {
self.mutual_tls_authentication = Some(input);
self
}
/// <p>The mutual TLS authentication configuration for a custom domain name.</p>
pub fn set_mutual_tls_authentication(
mut self,
input: std::option::Option<crate::model::MutualTlsAuthentication>,
) -> Self {
self.mutual_tls_authentication = input;
self
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The collection of tags associated with a domain name.</p>
pub fn tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = Some(hash_map);
self
}
/// <p>The collection of tags associated with a domain name.</p>
pub fn set_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.tags = input;
self
}
/// Consumes the builder and constructs a [`DomainName`](crate::model::DomainName).
pub fn build(self) -> crate::model::DomainName {
crate::model::DomainName {
api_mapping_selection_expression: self.api_mapping_selection_expression,
domain_name: self.domain_name,
domain_name_configurations: self.domain_name_configurations,
mutual_tls_authentication: self.mutual_tls_authentication,
tags: self.tags,
}
}
}
}
impl DomainName {
/// Creates a new builder-style object to manufacture [`DomainName`](crate::model::DomainName).
pub fn builder() -> crate::model::domain_name::Builder {
crate::model::domain_name::Builder::default()
}
}
/// <p>An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Deployment {
/// <p>Specifies whether a deployment was automatically released.</p>
pub auto_deployed: bool,
/// <p>The date and time when the Deployment resource was created.</p>
pub created_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The identifier for the deployment.</p>
pub deployment_id: std::option::Option<std::string::String>,
/// <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
pub deployment_status: std::option::Option<crate::model::DeploymentStatus>,
/// <p>May contain additional feedback on the status of an API deployment.</p>
pub deployment_status_message: std::option::Option<std::string::String>,
/// <p>The description for the deployment.</p>
pub description: std::option::Option<std::string::String>,
}
impl Deployment {
/// <p>Specifies whether a deployment was automatically released.</p>
pub fn auto_deployed(&self) -> bool {
self.auto_deployed
}
/// <p>The date and time when the Deployment resource was created.</p>
pub fn created_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.created_date.as_ref()
}
/// <p>The identifier for the deployment.</p>
pub fn deployment_id(&self) -> std::option::Option<&str> {
self.deployment_id.as_deref()
}
/// <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
pub fn deployment_status(&self) -> std::option::Option<&crate::model::DeploymentStatus> {
self.deployment_status.as_ref()
}
/// <p>May contain additional feedback on the status of an API deployment.</p>
pub fn deployment_status_message(&self) -> std::option::Option<&str> {
self.deployment_status_message.as_deref()
}
/// <p>The description for the deployment.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
}
impl std::fmt::Debug for Deployment {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Deployment");
formatter.field("auto_deployed", &self.auto_deployed);
formatter.field("created_date", &self.created_date);
formatter.field("deployment_id", &self.deployment_id);
formatter.field("deployment_status", &self.deployment_status);
formatter.field("deployment_status_message", &self.deployment_status_message);
formatter.field("description", &self.description);
formatter.finish()
}
}
/// See [`Deployment`](crate::model::Deployment).
pub mod deployment {
/// A builder for [`Deployment`](crate::model::Deployment).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) auto_deployed: std::option::Option<bool>,
pub(crate) created_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) deployment_id: std::option::Option<std::string::String>,
pub(crate) deployment_status: std::option::Option<crate::model::DeploymentStatus>,
pub(crate) deployment_status_message: std::option::Option<std::string::String>,
pub(crate) description: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Specifies whether a deployment was automatically released.</p>
pub fn auto_deployed(mut self, input: bool) -> Self {
self.auto_deployed = Some(input);
self
}
/// <p>Specifies whether a deployment was automatically released.</p>
pub fn set_auto_deployed(mut self, input: std::option::Option<bool>) -> Self {
self.auto_deployed = input;
self
}
/// <p>The date and time when the Deployment resource was created.</p>
pub fn created_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.created_date = Some(input);
self
}
/// <p>The date and time when the Deployment resource was created.</p>
pub fn set_created_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.created_date = input;
self
}
/// <p>The identifier for the deployment.</p>
pub fn deployment_id(mut self, input: impl Into<std::string::String>) -> Self {
self.deployment_id = Some(input.into());
self
}
/// <p>The identifier for the deployment.</p>
pub fn set_deployment_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.deployment_id = input;
self
}
/// <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
pub fn deployment_status(mut self, input: crate::model::DeploymentStatus) -> Self {
self.deployment_status = Some(input);
self
}
/// <p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>
pub fn set_deployment_status(
mut self,
input: std::option::Option<crate::model::DeploymentStatus>,
) -> Self {
self.deployment_status = input;
self
}
/// <p>May contain additional feedback on the status of an API deployment.</p>
pub fn deployment_status_message(mut self, input: impl Into<std::string::String>) -> Self {
self.deployment_status_message = Some(input.into());
self
}
/// <p>May contain additional feedback on the status of an API deployment.</p>
pub fn set_deployment_status_message(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.deployment_status_message = input;
self
}
/// <p>The description for the deployment.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>The description for the deployment.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// Consumes the builder and constructs a [`Deployment`](crate::model::Deployment).
pub fn build(self) -> crate::model::Deployment {
crate::model::Deployment {
auto_deployed: self.auto_deployed.unwrap_or_default(),
created_date: self.created_date,
deployment_id: self.deployment_id,
deployment_status: self.deployment_status,
deployment_status_message: self.deployment_status_message,
description: self.description,
}
}
}
}
impl Deployment {
/// Creates a new builder-style object to manufacture [`Deployment`](crate::model::Deployment).
pub fn builder() -> crate::model::deployment::Builder {
crate::model::deployment::Builder::default()
}
}
/// <p>Represents an authorizer.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Authorizer {
/// <p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>
pub authorizer_credentials_arn: std::option::Option<std::string::String>,
/// <p>The authorizer identifier.</p>
pub authorizer_id: std::option::Option<std::string::String>,
/// <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
pub authorizer_payload_format_version: std::option::Option<std::string::String>,
/// <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
pub authorizer_result_ttl_in_seconds: i32,
/// <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
pub authorizer_type: std::option::Option<crate::model::AuthorizerType>,
/// <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>
/// {account_id}
/// </replaceable>:function:<replaceable>
/// {lambda_function_name}
/// </replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>
/// {region}
/// </replaceable>:lambda:path/<replaceable>
/// {service_api}
/// </replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
pub authorizer_uri: std::option::Option<std::string::String>,
/// <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
pub enable_simple_responses: bool,
/// <p>The identity source for which authorization is requested.</p>
/// <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
/// <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
pub identity_source: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>The validation expression does not apply to the REQUEST authorizer.</p>
pub identity_validation_expression: std::option::Option<std::string::String>,
/// <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub jwt_configuration: std::option::Option<crate::model::JwtConfiguration>,
/// <p>The name of the authorizer.</p>
pub name: std::option::Option<std::string::String>,
}
impl Authorizer {
/// <p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>
pub fn authorizer_credentials_arn(&self) -> std::option::Option<&str> {
self.authorizer_credentials_arn.as_deref()
}
/// <p>The authorizer identifier.</p>
pub fn authorizer_id(&self) -> std::option::Option<&str> {
self.authorizer_id.as_deref()
}
/// <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
pub fn authorizer_payload_format_version(&self) -> std::option::Option<&str> {
self.authorizer_payload_format_version.as_deref()
}
/// <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
pub fn authorizer_result_ttl_in_seconds(&self) -> i32 {
self.authorizer_result_ttl_in_seconds
}
/// <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
pub fn authorizer_type(&self) -> std::option::Option<&crate::model::AuthorizerType> {
self.authorizer_type.as_ref()
}
/// <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>
/// {account_id}
/// </replaceable>:function:<replaceable>
/// {lambda_function_name}
/// </replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>
/// {region}
/// </replaceable>:lambda:path/<replaceable>
/// {service_api}
/// </replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
pub fn authorizer_uri(&self) -> std::option::Option<&str> {
self.authorizer_uri.as_deref()
}
/// <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
pub fn enable_simple_responses(&self) -> bool {
self.enable_simple_responses
}
/// <p>The identity source for which authorization is requested.</p>
/// <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
/// <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
pub fn identity_source(&self) -> std::option::Option<&[std::string::String]> {
self.identity_source.as_deref()
}
/// <p>The validation expression does not apply to the REQUEST authorizer.</p>
pub fn identity_validation_expression(&self) -> std::option::Option<&str> {
self.identity_validation_expression.as_deref()
}
/// <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub fn jwt_configuration(&self) -> std::option::Option<&crate::model::JwtConfiguration> {
self.jwt_configuration.as_ref()
}
/// <p>The name of the authorizer.</p>
pub fn name(&self) -> std::option::Option<&str> {
self.name.as_deref()
}
}
impl std::fmt::Debug for Authorizer {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Authorizer");
formatter.field(
"authorizer_credentials_arn",
&self.authorizer_credentials_arn,
);
formatter.field("authorizer_id", &self.authorizer_id);
formatter.field(
"authorizer_payload_format_version",
&self.authorizer_payload_format_version,
);
formatter.field(
"authorizer_result_ttl_in_seconds",
&self.authorizer_result_ttl_in_seconds,
);
formatter.field("authorizer_type", &self.authorizer_type);
formatter.field("authorizer_uri", &self.authorizer_uri);
formatter.field("enable_simple_responses", &self.enable_simple_responses);
formatter.field("identity_source", &self.identity_source);
formatter.field(
"identity_validation_expression",
&self.identity_validation_expression,
);
formatter.field("jwt_configuration", &self.jwt_configuration);
formatter.field("name", &self.name);
formatter.finish()
}
}
/// See [`Authorizer`](crate::model::Authorizer).
pub mod authorizer {
/// A builder for [`Authorizer`](crate::model::Authorizer).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) authorizer_credentials_arn: std::option::Option<std::string::String>,
pub(crate) authorizer_id: std::option::Option<std::string::String>,
pub(crate) authorizer_payload_format_version: std::option::Option<std::string::String>,
pub(crate) authorizer_result_ttl_in_seconds: std::option::Option<i32>,
pub(crate) authorizer_type: std::option::Option<crate::model::AuthorizerType>,
pub(crate) authorizer_uri: std::option::Option<std::string::String>,
pub(crate) enable_simple_responses: std::option::Option<bool>,
pub(crate) identity_source: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) identity_validation_expression: std::option::Option<std::string::String>,
pub(crate) jwt_configuration: std::option::Option<crate::model::JwtConfiguration>,
pub(crate) name: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>
pub fn authorizer_credentials_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.authorizer_credentials_arn = Some(input.into());
self
}
/// <p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>
pub fn set_authorizer_credentials_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.authorizer_credentials_arn = input;
self
}
/// <p>The authorizer identifier.</p>
pub fn authorizer_id(mut self, input: impl Into<std::string::String>) -> Self {
self.authorizer_id = Some(input.into());
self
}
/// <p>The authorizer identifier.</p>
pub fn set_authorizer_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.authorizer_id = input;
self
}
/// <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
pub fn authorizer_payload_format_version(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.authorizer_payload_format_version = Some(input.into());
self
}
/// <p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
pub fn set_authorizer_payload_format_version(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.authorizer_payload_format_version = input;
self
}
/// <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
pub fn authorizer_result_ttl_in_seconds(mut self, input: i32) -> Self {
self.authorizer_result_ttl_in_seconds = Some(input);
self
}
/// <p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>
pub fn set_authorizer_result_ttl_in_seconds(
mut self,
input: std::option::Option<i32>,
) -> Self {
self.authorizer_result_ttl_in_seconds = input;
self
}
/// <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
pub fn authorizer_type(mut self, input: crate::model::AuthorizerType) -> Self {
self.authorizer_type = Some(input);
self
}
/// <p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>
pub fn set_authorizer_type(
mut self,
input: std::option::Option<crate::model::AuthorizerType>,
) -> Self {
self.authorizer_type = input;
self
}
/// <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>
/// {account_id}
/// </replaceable>:function:<replaceable>
/// {lambda_function_name}
/// </replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>
/// {region}
/// </replaceable>:lambda:path/<replaceable>
/// {service_api}
/// </replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
pub fn authorizer_uri(mut self, input: impl Into<std::string::String>) -> Self {
self.authorizer_uri = Some(input.into());
self
}
/// <p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>
/// {account_id}
/// </replaceable>:function:<replaceable>
/// {lambda_function_name}
/// </replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>
/// {region}
/// </replaceable>:lambda:path/<replaceable>
/// {service_api}
/// </replaceable> , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>
pub fn set_authorizer_uri(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.authorizer_uri = input;
self
}
/// <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
pub fn enable_simple_responses(mut self, input: bool) -> Self {
self.enable_simple_responses = Some(input);
self
}
/// <p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a></p>
pub fn set_enable_simple_responses(mut self, input: std::option::Option<bool>) -> Self {
self.enable_simple_responses = input;
self
}
/// Appends an item to `identity_source`.
///
/// To override the contents of this collection use [`set_identity_source`](Self::set_identity_source).
///
/// <p>The identity source for which authorization is requested.</p>
/// <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
/// <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
pub fn identity_source(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.identity_source.unwrap_or_default();
v.push(input.into());
self.identity_source = Some(v);
self
}
/// <p>The identity source for which authorization is requested.</p>
/// <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>
/// <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>
pub fn set_identity_source(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.identity_source = input;
self
}
/// <p>The validation expression does not apply to the REQUEST authorizer.</p>
pub fn identity_validation_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.identity_validation_expression = Some(input.into());
self
}
/// <p>The validation expression does not apply to the REQUEST authorizer.</p>
pub fn set_identity_validation_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.identity_validation_expression = input;
self
}
/// <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub fn jwt_configuration(mut self, input: crate::model::JwtConfiguration) -> Self {
self.jwt_configuration = Some(input);
self
}
/// <p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>
pub fn set_jwt_configuration(
mut self,
input: std::option::Option<crate::model::JwtConfiguration>,
) -> Self {
self.jwt_configuration = input;
self
}
/// <p>The name of the authorizer.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.name = Some(input.into());
self
}
/// <p>The name of the authorizer.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.name = input;
self
}
/// Consumes the builder and constructs a [`Authorizer`](crate::model::Authorizer).
pub fn build(self) -> crate::model::Authorizer {
crate::model::Authorizer {
authorizer_credentials_arn: self.authorizer_credentials_arn,
authorizer_id: self.authorizer_id,
authorizer_payload_format_version: self.authorizer_payload_format_version,
authorizer_result_ttl_in_seconds: self
.authorizer_result_ttl_in_seconds
.unwrap_or_default(),
authorizer_type: self.authorizer_type,
authorizer_uri: self.authorizer_uri,
enable_simple_responses: self.enable_simple_responses.unwrap_or_default(),
identity_source: self.identity_source,
identity_validation_expression: self.identity_validation_expression,
jwt_configuration: self.jwt_configuration,
name: self.name,
}
}
}
}
impl Authorizer {
/// Creates a new builder-style object to manufacture [`Authorizer`](crate::model::Authorizer).
pub fn builder() -> crate::model::authorizer::Builder {
crate::model::authorizer::Builder::default()
}
}
/// <p>Represents an API.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Api {
/// <p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
pub api_endpoint: std::option::Option<std::string::String>,
/// <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
pub api_gateway_managed: bool,
/// <p>The API ID.</p>
pub api_id: std::option::Option<std::string::String>,
/// <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
pub api_key_selection_expression: std::option::Option<std::string::String>,
/// <p>A CORS configuration. Supported only for HTTP APIs.</p>
pub cors_configuration: std::option::Option<crate::model::Cors>,
/// <p>The timestamp when the API was created.</p>
pub created_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The description of the API.</p>
pub description: std::option::Option<std::string::String>,
/// <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
pub disable_schema_validation: bool,
/// <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
pub disable_execute_api_endpoint: bool,
/// <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
pub import_info: std::option::Option<std::vec::Vec<std::string::String>>,
/// <p>The name of the API.</p>
pub name: std::option::Option<std::string::String>,
/// <p>The API protocol.</p>
pub protocol_type: std::option::Option<crate::model::ProtocolType>,
/// <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
pub route_selection_expression: std::option::Option<std::string::String>,
/// <p>A collection of tags associated with the API.</p>
pub tags:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>A version identifier for the API.</p>
pub version: std::option::Option<std::string::String>,
/// <p>The warning messages reported when failonwarnings is turned on during API import.</p>
pub warnings: std::option::Option<std::vec::Vec<std::string::String>>,
}
impl Api {
/// <p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
pub fn api_endpoint(&self) -> std::option::Option<&str> {
self.api_endpoint.as_deref()
}
/// <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
pub fn api_gateway_managed(&self) -> bool {
self.api_gateway_managed
}
/// <p>The API ID.</p>
pub fn api_id(&self) -> std::option::Option<&str> {
self.api_id.as_deref()
}
/// <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
pub fn api_key_selection_expression(&self) -> std::option::Option<&str> {
self.api_key_selection_expression.as_deref()
}
/// <p>A CORS configuration. Supported only for HTTP APIs.</p>
pub fn cors_configuration(&self) -> std::option::Option<&crate::model::Cors> {
self.cors_configuration.as_ref()
}
/// <p>The timestamp when the API was created.</p>
pub fn created_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.created_date.as_ref()
}
/// <p>The description of the API.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
pub fn disable_schema_validation(&self) -> bool {
self.disable_schema_validation
}
/// <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
pub fn disable_execute_api_endpoint(&self) -> bool {
self.disable_execute_api_endpoint
}
/// <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
pub fn import_info(&self) -> std::option::Option<&[std::string::String]> {
self.import_info.as_deref()
}
/// <p>The name of the API.</p>
pub fn name(&self) -> std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The API protocol.</p>
pub fn protocol_type(&self) -> std::option::Option<&crate::model::ProtocolType> {
self.protocol_type.as_ref()
}
/// <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
pub fn route_selection_expression(&self) -> std::option::Option<&str> {
self.route_selection_expression.as_deref()
}
/// <p>A collection of tags associated with the API.</p>
pub fn tags(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.tags.as_ref()
}
/// <p>A version identifier for the API.</p>
pub fn version(&self) -> std::option::Option<&str> {
self.version.as_deref()
}
/// <p>The warning messages reported when failonwarnings is turned on during API import.</p>
pub fn warnings(&self) -> std::option::Option<&[std::string::String]> {
self.warnings.as_deref()
}
}
impl std::fmt::Debug for Api {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Api");
formatter.field("api_endpoint", &self.api_endpoint);
formatter.field("api_gateway_managed", &self.api_gateway_managed);
formatter.field("api_id", &self.api_id);
formatter.field(
"api_key_selection_expression",
&self.api_key_selection_expression,
);
formatter.field("cors_configuration", &self.cors_configuration);
formatter.field("created_date", &self.created_date);
formatter.field("description", &self.description);
formatter.field("disable_schema_validation", &self.disable_schema_validation);
formatter.field(
"disable_execute_api_endpoint",
&self.disable_execute_api_endpoint,
);
formatter.field("import_info", &self.import_info);
formatter.field("name", &self.name);
formatter.field("protocol_type", &self.protocol_type);
formatter.field(
"route_selection_expression",
&self.route_selection_expression,
);
formatter.field("tags", &self.tags);
formatter.field("version", &self.version);
formatter.field("warnings", &self.warnings);
formatter.finish()
}
}
/// See [`Api`](crate::model::Api).
pub mod api {
/// A builder for [`Api`](crate::model::Api).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) api_endpoint: std::option::Option<std::string::String>,
pub(crate) api_gateway_managed: std::option::Option<bool>,
pub(crate) api_id: std::option::Option<std::string::String>,
pub(crate) api_key_selection_expression: std::option::Option<std::string::String>,
pub(crate) cors_configuration: std::option::Option<crate::model::Cors>,
pub(crate) created_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) description: std::option::Option<std::string::String>,
pub(crate) disable_schema_validation: std::option::Option<bool>,
pub(crate) disable_execute_api_endpoint: std::option::Option<bool>,
pub(crate) import_info: std::option::Option<std::vec::Vec<std::string::String>>,
pub(crate) name: std::option::Option<std::string::String>,
pub(crate) protocol_type: std::option::Option<crate::model::ProtocolType>,
pub(crate) route_selection_expression: std::option::Option<std::string::String>,
pub(crate) tags: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) version: std::option::Option<std::string::String>,
pub(crate) warnings: std::option::Option<std::vec::Vec<std::string::String>>,
}
impl Builder {
/// <p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
pub fn api_endpoint(mut self, input: impl Into<std::string::String>) -> Self {
self.api_endpoint = Some(input.into());
self
}
/// <p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>
pub fn set_api_endpoint(mut self, input: std::option::Option<std::string::String>) -> Self {
self.api_endpoint = input;
self
}
/// <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
pub fn api_gateway_managed(mut self, input: bool) -> Self {
self.api_gateway_managed = Some(input);
self
}
/// <p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>
pub fn set_api_gateway_managed(mut self, input: std::option::Option<bool>) -> Self {
self.api_gateway_managed = input;
self
}
/// <p>The API ID.</p>
pub fn api_id(mut self, input: impl Into<std::string::String>) -> Self {
self.api_id = Some(input.into());
self
}
/// <p>The API ID.</p>
pub fn set_api_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.api_id = input;
self
}
/// <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
pub fn api_key_selection_expression(
mut self,
input: impl Into<std::string::String>,
) -> Self {
self.api_key_selection_expression = Some(input.into());
self
}
/// <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
pub fn set_api_key_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.api_key_selection_expression = input;
self
}
/// <p>A CORS configuration. Supported only for HTTP APIs.</p>
pub fn cors_configuration(mut self, input: crate::model::Cors) -> Self {
self.cors_configuration = Some(input);
self
}
/// <p>A CORS configuration. Supported only for HTTP APIs.</p>
pub fn set_cors_configuration(
mut self,
input: std::option::Option<crate::model::Cors>,
) -> Self {
self.cors_configuration = input;
self
}
/// <p>The timestamp when the API was created.</p>
pub fn created_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.created_date = Some(input);
self
}
/// <p>The timestamp when the API was created.</p>
pub fn set_created_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.created_date = input;
self
}
/// <p>The description of the API.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>The description of the API.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
pub fn disable_schema_validation(mut self, input: bool) -> Self {
self.disable_schema_validation = Some(input);
self
}
/// <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
pub fn set_disable_schema_validation(mut self, input: std::option::Option<bool>) -> Self {
self.disable_schema_validation = input;
self
}
/// <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
pub fn disable_execute_api_endpoint(mut self, input: bool) -> Self {
self.disable_execute_api_endpoint = Some(input);
self
}
/// <p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>
pub fn set_disable_execute_api_endpoint(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.disable_execute_api_endpoint = input;
self
}
/// Appends an item to `import_info`.
///
/// To override the contents of this collection use [`set_import_info`](Self::set_import_info).
///
/// <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
pub fn import_info(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.import_info.unwrap_or_default();
v.push(input.into());
self.import_info = Some(v);
self
}
/// <p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>
pub fn set_import_info(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.import_info = input;
self
}
/// <p>The name of the API.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.name = Some(input.into());
self
}
/// <p>The name of the API.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The API protocol.</p>
pub fn protocol_type(mut self, input: crate::model::ProtocolType) -> Self {
self.protocol_type = Some(input);
self
}
/// <p>The API protocol.</p>
pub fn set_protocol_type(
mut self,
input: std::option::Option<crate::model::ProtocolType>,
) -> Self {
self.protocol_type = input;
self
}
/// <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
pub fn route_selection_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.route_selection_expression = Some(input.into());
self
}
/// <p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>
pub fn set_route_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.route_selection_expression = input;
self
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>A collection of tags associated with the API.</p>
pub fn tags(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.tags.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.tags = Some(hash_map);
self
}
/// <p>A collection of tags associated with the API.</p>
pub fn set_tags(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.tags = input;
self
}
/// <p>A version identifier for the API.</p>
pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
self.version = Some(input.into());
self
}
/// <p>A version identifier for the API.</p>
pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.version = input;
self
}
/// Appends an item to `warnings`.
///
/// To override the contents of this collection use [`set_warnings`](Self::set_warnings).
///
/// <p>The warning messages reported when failonwarnings is turned on during API import.</p>
pub fn warnings(mut self, input: impl Into<std::string::String>) -> Self {
let mut v = self.warnings.unwrap_or_default();
v.push(input.into());
self.warnings = Some(v);
self
}
/// <p>The warning messages reported when failonwarnings is turned on during API import.</p>
pub fn set_warnings(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.warnings = input;
self
}
/// Consumes the builder and constructs a [`Api`](crate::model::Api).
pub fn build(self) -> crate::model::Api {
crate::model::Api {
api_endpoint: self.api_endpoint,
api_gateway_managed: self.api_gateway_managed.unwrap_or_default(),
api_id: self.api_id,
api_key_selection_expression: self.api_key_selection_expression,
cors_configuration: self.cors_configuration,
created_date: self.created_date,
description: self.description,
disable_schema_validation: self.disable_schema_validation.unwrap_or_default(),
disable_execute_api_endpoint: self.disable_execute_api_endpoint.unwrap_or_default(),
import_info: self.import_info,
name: self.name,
protocol_type: self.protocol_type,
route_selection_expression: self.route_selection_expression,
tags: self.tags,
version: self.version,
warnings: self.warnings,
}
}
}
}
impl Api {
/// Creates a new builder-style object to manufacture [`Api`](crate::model::Api).
pub fn builder() -> crate::model::api::Builder {
crate::model::api::Builder::default()
}
}
/// <p>Represents an API mapping.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct ApiMapping {
/// <p>The API identifier.</p>
pub api_id: std::option::Option<std::string::String>,
/// <p>The API mapping identifier.</p>
pub api_mapping_id: std::option::Option<std::string::String>,
/// <p>The API mapping key.</p>
pub api_mapping_key: std::option::Option<std::string::String>,
/// <p>The API stage.</p>
pub stage: std::option::Option<std::string::String>,
}
impl ApiMapping {
/// <p>The API identifier.</p>
pub fn api_id(&self) -> std::option::Option<&str> {
self.api_id.as_deref()
}
/// <p>The API mapping identifier.</p>
pub fn api_mapping_id(&self) -> std::option::Option<&str> {
self.api_mapping_id.as_deref()
}
/// <p>The API mapping key.</p>
pub fn api_mapping_key(&self) -> std::option::Option<&str> {
self.api_mapping_key.as_deref()
}
/// <p>The API stage.</p>
pub fn stage(&self) -> std::option::Option<&str> {
self.stage.as_deref()
}
}
impl std::fmt::Debug for ApiMapping {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("ApiMapping");
formatter.field("api_id", &self.api_id);
formatter.field("api_mapping_id", &self.api_mapping_id);
formatter.field("api_mapping_key", &self.api_mapping_key);
formatter.field("stage", &self.stage);
formatter.finish()
}
}
/// See [`ApiMapping`](crate::model::ApiMapping).
pub mod api_mapping {
/// A builder for [`ApiMapping`](crate::model::ApiMapping).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) api_id: std::option::Option<std::string::String>,
pub(crate) api_mapping_id: std::option::Option<std::string::String>,
pub(crate) api_mapping_key: std::option::Option<std::string::String>,
pub(crate) stage: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>The API identifier.</p>
pub fn api_id(mut self, input: impl Into<std::string::String>) -> Self {
self.api_id = Some(input.into());
self
}
/// <p>The API identifier.</p>
pub fn set_api_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.api_id = input;
self
}
/// <p>The API mapping identifier.</p>
pub fn api_mapping_id(mut self, input: impl Into<std::string::String>) -> Self {
self.api_mapping_id = Some(input.into());
self
}
/// <p>The API mapping identifier.</p>
pub fn set_api_mapping_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.api_mapping_id = input;
self
}
/// <p>The API mapping key.</p>
pub fn api_mapping_key(mut self, input: impl Into<std::string::String>) -> Self {
self.api_mapping_key = Some(input.into());
self
}
/// <p>The API mapping key.</p>
pub fn set_api_mapping_key(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.api_mapping_key = input;
self
}
/// <p>The API stage.</p>
pub fn stage(mut self, input: impl Into<std::string::String>) -> Self {
self.stage = Some(input.into());
self
}
/// <p>The API stage.</p>
pub fn set_stage(mut self, input: std::option::Option<std::string::String>) -> Self {
self.stage = input;
self
}
/// Consumes the builder and constructs a [`ApiMapping`](crate::model::ApiMapping).
pub fn build(self) -> crate::model::ApiMapping {
crate::model::ApiMapping {
api_id: self.api_id,
api_mapping_id: self.api_mapping_id,
api_mapping_key: self.api_mapping_key,
stage: self.stage,
}
}
}
}
impl ApiMapping {
/// Creates a new builder-style object to manufacture [`ApiMapping`](crate::model::ApiMapping).
pub fn builder() -> crate::model::api_mapping::Builder {
crate::model::api_mapping::Builder::default()
}
}