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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// An object representing a container instance or task attachment.
type Attachment struct {
// Details of the attachment. For elastic network interfaces, this includes the
// network interface ID, the MAC address, the subnet ID, and the private IPv4
// address.
Details []KeyValuePair
// The unique identifier for the attachment.
Id *string
// The status of the attachment. Valid values are PRECREATED , CREATED , ATTACHING
// , ATTACHED , DETACHING , DETACHED , DELETED , and FAILED .
Status *string
// The type of the attachment, such as ElasticNetworkInterface .
Type *string
noSmithyDocumentSerde
}
// An object representing a change in state for a task attachment.
type AttachmentStateChange struct {
// The Amazon Resource Name (ARN) of the attachment.
//
// This member is required.
AttachmentArn *string
// The status of the attachment.
//
// This member is required.
Status *string
noSmithyDocumentSerde
}
// An attribute is a name-value pair that's associated with an Amazon ECS object.
// Use attributes to extend the Amazon ECS data model by adding custom metadata to
// your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)
// in the Amazon Elastic Container Service Developer Guide.
type Attribute struct {
// The name of the attribute. The name must contain between 1 and 128 characters.
// The name may contain letters (uppercase and lowercase), numbers, hyphens (-),
// underscores (_), forward slashes (/), back slashes (\), or periods (.).
//
// This member is required.
Name *string
// The ID of the target. You can specify the short form ID for a resource or the
// full Amazon Resource Name (ARN).
TargetId *string
// The type of the target to attach the attribute with. This parameter is required
// if you use the short form ID for a resource instead of the full ARN.
TargetType TargetType
// The value of the attribute. The value must contain between 1 and 128
// characters. It can contain letters (uppercase and lowercase), numbers, hyphens
// (-), underscores (_), periods (.), at signs (@), forward slashes (/), back
// slashes (\), colons (:), or spaces. The value can't start or end with a space.
Value *string
noSmithyDocumentSerde
}
// The details of the Auto Scaling group for the capacity provider.
type AutoScalingGroupProvider struct {
// The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the
// Auto Scaling group name.
//
// This member is required.
AutoScalingGroupArn *string
// The managed draining option for the Auto Scaling group capacity provider. When
// you enable this, Amazon ECS manages and gracefully drains the EC2 container
// instances that are in the Auto Scaling group capacity provider. The default is
// ENABLED .
ManagedDraining ManagedDraining
// The managed scaling settings for the Auto Scaling group capacity provider.
ManagedScaling *ManagedScaling
// The managed termination protection setting to use for the Auto Scaling group
// capacity provider. This determines whether the Auto Scaling group has managed
// termination protection. The default is off. When using managed termination
// protection, managed scaling must also be used otherwise managed termination
// protection doesn't work. When managed termination protection is on, Amazon ECS
// prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks
// from being terminated during a scale-in action. The Auto Scaling group and each
// instance in the Auto Scaling group must have instance protection from scale-in
// actions on as well. For more information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection)
// in the Auto Scaling User Guide. When managed termination protection is off, your
// Amazon EC2 instances aren't protected from termination when the Auto Scaling
// group scales in.
ManagedTerminationProtection ManagedTerminationProtection
noSmithyDocumentSerde
}
// The details of the Auto Scaling group capacity provider to update.
type AutoScalingGroupProviderUpdate struct {
// The managed draining option for the Auto Scaling group capacity provider. When
// you enable this, Amazon ECS manages and gracefully drains the EC2 container
// instances that are in the Auto Scaling group capacity provider. The default is
// ENABLED .
ManagedDraining ManagedDraining
// The managed scaling settings for the Auto Scaling group capacity provider.
ManagedScaling *ManagedScaling
// The managed termination protection setting to use for the Auto Scaling group
// capacity provider. This determines whether the Auto Scaling group has managed
// termination protection. When using managed termination protection, managed
// scaling must also be used otherwise managed termination protection doesn't work.
// When managed termination protection is on, Amazon ECS prevents the Amazon EC2
// instances in an Auto Scaling group that contain tasks from being terminated
// during a scale-in action. The Auto Scaling group and each instance in the Auto
// Scaling group must have instance protection from scale-in actions on. For more
// information, see Instance Protection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection)
// in the Auto Scaling User Guide. When managed termination protection is off, your
// Amazon EC2 instances aren't protected from termination when the Auto Scaling
// group scales in.
ManagedTerminationProtection ManagedTerminationProtection
noSmithyDocumentSerde
}
// An object representing the networking details for a task or service.
type AwsVpcConfiguration struct {
// The IDs of the subnets associated with the task or service. There's a limit of
// 16 subnets that can be specified per AwsVpcConfiguration . All specified subnets
// must be from the same VPC.
//
// This member is required.
Subnets []string
// Whether the task's elastic network interface receives a public IP address. The
// default value is DISABLED .
AssignPublicIp AssignPublicIp
// The IDs of the security groups associated with the task or service. If you
// don't specify a security group, the default security group for the VPC is used.
// There's a limit of 5 security groups that can be specified per
// AwsVpcConfiguration . All specified security groups must be from the same VPC.
SecurityGroups []string
noSmithyDocumentSerde
}
// The details for a capacity provider.
type CapacityProvider struct {
// The Auto Scaling group settings for the capacity provider.
AutoScalingGroupProvider *AutoScalingGroupProvider
// The Amazon Resource Name (ARN) that identifies the capacity provider.
CapacityProviderArn *string
// The name of the capacity provider.
Name *string
// The current status of the capacity provider. Only capacity providers in an
// ACTIVE state can be used in a cluster. When a capacity provider is successfully
// deleted, it has an INACTIVE status.
Status CapacityProviderStatus
// The metadata that you apply to the capacity provider to help you categorize and
// organize it. Each tag consists of a key and an optional value. You define both.
// The following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
// The update status of the capacity provider. The following are the possible
// states that is returned. DELETE_IN_PROGRESS The capacity provider is in the
// process of being deleted. DELETE_COMPLETE The capacity provider was successfully
// deleted and has an INACTIVE status. DELETE_FAILED The capacity provider can't
// be deleted. The update status reason provides further details about why the
// delete failed.
UpdateStatus CapacityProviderUpdateStatus
// The update status reason. This provides further details about the update status
// for the capacity provider.
UpdateStatusReason *string
noSmithyDocumentSerde
}
// The details of a capacity provider strategy. A capacity provider strategy can
// be set when using the RunTask or CreateCluster APIs or as the default capacity
// provider strategy for a cluster with the CreateCluster API. Only capacity
// providers that are already associated with a cluster and have an ACTIVE or
// UPDATING status can be used in a capacity provider strategy. The
// PutClusterCapacityProviders API is used to associate a capacity provider with a
// cluster. If specifying a capacity provider that uses an Auto Scaling group, the
// capacity provider must already be created. New Auto Scaling group capacity
// providers can be created with the CreateCapacityProvider API operation. To use
// a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
// capacity providers. The Fargate capacity providers are available to all accounts
// and only need to be associated with a cluster to be used in a capacity provider
// strategy. A capacity provider strategy may contain a maximum of 6 capacity
// providers.
type CapacityProviderStrategyItem struct {
// The short name of the capacity provider.
//
// This member is required.
CapacityProvider *string
// The base value designates how many tasks, at a minimum, to run on the specified
// capacity provider. Only one capacity provider in a capacity provider strategy
// can have a base defined. If no value is specified, the default value of 0 is
// used.
Base int32
// The weight value designates the relative percentage of the total number of
// tasks launched that should use the specified capacity provider. The weight
// value is taken into consideration after the base value, if defined, is
// satisfied. If no weight value is specified, the default value of 0 is used.
// When multiple capacity providers are specified within a capacity provider
// strategy, at least one of the capacity providers must have a weight value
// greater than zero and any capacity providers with a weight of 0 can't be used
// to place tasks. If you specify multiple capacity providers in a strategy that
// all have a weight of 0 , any RunTask or CreateService actions using the
// capacity provider strategy will fail. An example scenario for using weights is
// defining a strategy that contains two capacity providers and both have a weight
// of 1 , then when the base is satisfied, the tasks will be split evenly across
// the two capacity providers. Using that same logic, if you specify a weight of 1
// for capacityProviderA and a weight of 4 for capacityProviderB, then for every
// one task that's run using capacityProviderA, four tasks would use
// capacityProviderB.
Weight int32
noSmithyDocumentSerde
}
// A regional grouping of one or more container instances where you can run task
// requests. Each account receives a default cluster the first time you use the
// Amazon ECS service, but you may also create other clusters. Clusters may contain
// more than one instance type simultaneously.
type Cluster struct {
// The number of services that are running on the cluster in an ACTIVE state. You
// can view these services with ListServices .
ActiveServicesCount int32
// The resources attached to a cluster. When using a capacity provider with a
// cluster, the capacity provider and associated resources are returned as cluster
// attachments.
Attachments []Attachment
// The status of the capacity providers associated with the cluster. The following
// are the states that are returned. UPDATE_IN_PROGRESS The available capacity
// providers for the cluster are updating. UPDATE_COMPLETE The capacity providers
// have successfully updated. UPDATE_FAILED The capacity provider updates failed.
AttachmentsStatus *string
// The capacity providers associated with the cluster.
CapacityProviders []string
// The Amazon Resource Name (ARN) that identifies the cluster. For more
// information about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
// in the Amazon ECS Developer Guide.
ClusterArn *string
// A user-generated string that you use to identify your cluster.
ClusterName *string
// The execute command configuration for the cluster.
Configuration *ClusterConfiguration
// The default capacity provider strategy for the cluster. When services or tasks
// are run in the cluster with no launch type or capacity provider strategy
// specified, the default capacity provider strategy is used.
DefaultCapacityProviderStrategy []CapacityProviderStrategyItem
// The number of tasks in the cluster that are in the PENDING state.
PendingTasksCount int32
// The number of container instances registered into the cluster. This includes
// container instances in both ACTIVE and DRAINING status.
RegisteredContainerInstancesCount int32
// The number of tasks in the cluster that are in the RUNNING state.
RunningTasksCount int32
// Use this parameter to set a default Service Connect namespace. After you set a
// default Service Connect namespace, any new services with Service Connect turned
// on that are created in the cluster are added as client services in the
// namespace. This setting only applies to new services that set the enabled
// parameter to true in the ServiceConnectConfiguration . You can set the namespace
// of each service individually in the ServiceConnectConfiguration to override
// this default parameter. Tasks that run in a namespace can use short names to
// connect to services in the namespace. Tasks can connect to services across all
// of the clusters in the namespace. Tasks connect through a managed proxy
// container that collects logs and metrics for increased visibility. Only the
// tasks that Amazon ECS services create are supported with Service Connect. For
// more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
ServiceConnectDefaults *ClusterServiceConnectDefaults
// The settings for the cluster. This parameter indicates whether CloudWatch
// Container Insights is on or off for a cluster.
Settings []ClusterSetting
// Additional information about your clusters that are separated by launch type.
// They include the following:
// - runningEC2TasksCount
// - RunningFargateTasksCount
// - pendingEC2TasksCount
// - pendingFargateTasksCount
// - activeEC2ServiceCount
// - activeFargateServiceCount
// - drainingEC2ServiceCount
// - drainingFargateServiceCount
Statistics []KeyValuePair
// The status of the cluster. The following are the possible states that are
// returned. ACTIVE The cluster is ready to accept tasks and if applicable you can
// register container instances with the cluster. PROVISIONING The cluster has
// capacity providers that are associated with it and the resources needed for the
// capacity provider are being created. DEPROVISIONING The cluster has capacity
// providers that are associated with it and the resources needed for the capacity
// provider are being deleted. FAILED The cluster has capacity providers that are
// associated with it and the resources needed for the capacity provider have
// failed to create. INACTIVE The cluster has been deleted. Clusters with an
// INACTIVE status may remain discoverable in your account for a period of time.
// However, this behavior is subject to change in the future. We don't recommend
// that you rely on INACTIVE clusters persisting.
Status *string
// The metadata that you apply to the cluster to help you categorize and organize
// them. Each tag consists of a key and an optional value. You define both. The
// following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
noSmithyDocumentSerde
}
// The execute command configuration for the cluster.
type ClusterConfiguration struct {
// The details of the execute command configuration.
ExecuteCommandConfiguration *ExecuteCommandConfiguration
noSmithyDocumentSerde
}
// Use this parameter to set a default Service Connect namespace. After you set a
// default Service Connect namespace, any new services with Service Connect turned
// on that are created in the cluster are added as client services in the
// namespace. This setting only applies to new services that set the enabled
// parameter to true in the ServiceConnectConfiguration . You can set the namespace
// of each service individually in the ServiceConnectConfiguration to override
// this default parameter. Tasks that run in a namespace can use short names to
// connect to services in the namespace. Tasks can connect to services across all
// of the clusters in the namespace. Tasks connect through a managed proxy
// container that collects logs and metrics for increased visibility. Only the
// tasks that Amazon ECS services create are supported with Service Connect. For
// more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
type ClusterServiceConnectDefaults struct {
// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
// namespace. When you create a service and don't specify a Service Connect
// configuration, this namespace is used.
Namespace *string
noSmithyDocumentSerde
}
// Use this parameter to set a default Service Connect namespace. After you set a
// default Service Connect namespace, any new services with Service Connect turned
// on that are created in the cluster are added as client services in the
// namespace. This setting only applies to new services that set the enabled
// parameter to true in the ServiceConnectConfiguration . You can set the namespace
// of each service individually in the ServiceConnectConfiguration to override
// this default parameter. Tasks that run in a namespace can use short names to
// connect to services in the namespace. Tasks can connect to services across all
// of the clusters in the namespace. Tasks connect through a managed proxy
// container that collects logs and metrics for increased visibility. Only the
// tasks that Amazon ECS services create are supported with Service Connect. For
// more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
type ClusterServiceConnectDefaultsRequest struct {
// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
// namespace that's used when you create a service and don't specify a Service
// Connect configuration. The namespace name can include up to 1024 characters. The
// name is case-sensitive. The name can't include hyphens (-), tilde (~), greater
// than (>), less than (<), or slash (/). If you enter an existing namespace name
// or ARN, then that namespace will be used. Any namespace type is supported. The
// namespace must be in this account and this Amazon Web Services Region. If you
// enter a new name, a Cloud Map namespace will be created. Amazon ECS creates a
// Cloud Map namespace with the "API calls" method of instance discovery only. This
// instance discovery method is the "HTTP" namespace type in the Command Line
// Interface. Other types of instance discovery aren't used by Service Connect. If
// you update the cluster with an empty string "" for the namespace name, the
// cluster configuration for Service Connect is removed. Note that the namespace
// will remain in Cloud Map and must be deleted separately. For more information
// about Cloud Map, see Working with Services (https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)
// in the Cloud Map Developer Guide.
//
// This member is required.
Namespace *string
noSmithyDocumentSerde
}
// The settings to use when creating a cluster. This parameter is used to turn on
// CloudWatch Container Insights for a cluster.
type ClusterSetting struct {
// The name of the cluster setting. The value is containerInsights .
Name ClusterSettingName
// The value to set for the cluster setting. The supported values are enabled and
// disabled . If you set name to containerInsights and value to enabled ,
// CloudWatch Container Insights will be on for the cluster, otherwise it will be
// off unless the containerInsights account setting is turned on. If a cluster
// value is specified, it will override the containerInsights value set with
// PutAccountSetting (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html)
// or PutAccountSettingDefault (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)
// .
Value *string
noSmithyDocumentSerde
}
// A Docker container that's part of a task.
type Container struct {
// The Amazon Resource Name (ARN) of the container.
ContainerArn *string
// The number of CPU units set for the container. The value is 0 if no value was
// specified in the container definition when the task definition was registered.
Cpu *string
// The exit code returned from the container.
ExitCode *int32
// The IDs of each GPU assigned to the container.
GpuIds []string
// The health status of the container. If health checks aren't configured for this
// container in its task definition, then it reports the health status as UNKNOWN .
HealthStatus HealthStatus
// The image used for the container.
Image *string
// The container image manifest digest.
ImageDigest *string
// The last known status of the container.
LastStatus *string
// The details of any Amazon ECS managed agents associated with the container.
ManagedAgents []ManagedAgent
// The hard limit (in MiB) of memory set for the container.
Memory *string
// The soft limit (in MiB) of memory set for the container.
MemoryReservation *string
// The name of the container.
Name *string
// The network bindings associated with the container.
NetworkBindings []NetworkBinding
// The network interfaces associated with the container.
NetworkInterfaces []NetworkInterface
// A short (255 max characters) human-readable string to provide additional
// details about a running or stopped container.
Reason *string
// The ID of the Docker container.
RuntimeId *string
// The ARN of the task.
TaskArn *string
noSmithyDocumentSerde
}
// Container definitions are used in task definitions to describe the different
// containers that are launched as part of a task.
type ContainerDefinition struct {
// The command that's passed to the container. This parameter maps to Cmd in the
// Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . For more information, see
// https://docs.docker.com/engine/reference/builder/#cmd (https://docs.docker.com/engine/reference/builder/#cmd)
// . If there are multiple arguments, each argument is a separated string in the
// array.
Command []string
// The number of cpu units reserved for the container. This parameter maps to
// CpuShares in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This field is optional for tasks using the Fargate launch type, and the only
// requirement is that the total amount of CPU reserved for all containers within a
// task be lower than the task-level cpu value. You can determine the number of
// CPU units that are available per EC2 instance type by multiplying the vCPUs
// listed for that instance type on the Amazon EC2 Instances (http://aws.amazon.com/ec2/instance-types/)
// detail page by 1,024. Linux containers share unallocated CPU units with other
// containers on the container instance with the same ratio as their allocated
// amount. For example, if you run a single-container task on a single-core
// instance type with 512 CPU units specified for that container, and that's the
// only task running on the container instance, that container could use the full
// 1,024 CPU unit share at any given time. However, if you launched another copy of
// the same task on that container instance, each task is guaranteed a minimum of
// 512 CPU units when needed. Moreover, each container could float to higher CPU
// usage if the other container was not using it. If both tasks were 100% active
// all of the time, they would be limited to 512 CPU units. On Linux container
// instances, the Docker daemon on the container instance uses the CPU value to
// calculate the relative CPU share ratios for running containers. For more
// information, see CPU share constraint (https://docs.docker.com/engine/reference/run/#cpu-share-constraint)
// in the Docker documentation. The minimum valid CPU share value that the Linux
// kernel allows is 2. However, the CPU parameter isn't required, and you can use
// CPU values below 2 in your container definitions. For CPU values below 2
// (including null), the behavior varies based on your Amazon ECS container agent
// version:
// - Agent versions less than or equal to 1.1.0: Null and zero CPU values are
// passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU
// values of 1 are passed to Docker as 1, which the Linux kernel converts to two
// CPU shares.
// - Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values
// of 1 are passed to Docker as 2.
// On Windows container instances, the CPU limit is enforced as an absolute limit,
// or a quota. Windows containers only have access to the specified amount of CPU
// that's described in the task definition. A null or zero CPU value is passed to
// Docker as 0 , which Windows interprets as 1% of one CPU.
Cpu int32
// A list of ARNs in SSM or Amazon S3 to a credential spec ( CredSpec ) file that
// configures the container for Active Directory authentication. We recommend that
// you use this parameter instead of the dockerSecurityOptions . The maximum number
// of ARNs is 1. There are two formats for each ARN. credentialspecdomainless:MyARN
// You use credentialspecdomainless:MyARN to provide a CredSpec with an additional
// section for a secret in Secrets Manager. You provide the login credentials to
// the domain in the secret. Each task that runs on any container instance can join
// different domains. You can use this format without joining the container
// instance to a domain. credentialspec:MyARN You use credentialspec:MyARN to
// provide a CredSpec for a single domain. You must join the container instance to
// the domain before you start any tasks that use this task definition. In both
// formats, replace MyARN with the ARN in SSM or Amazon S3. If you provide a
// credentialspecdomainless:MyARN , the credspec must provide a ARN in Secrets
// Manager for a secret containing the username, password, and the domain to
// connect to. For better security, the instance isn't joined to the domain for
// domainless authentication. Other applications on the instance can't use the
// domainless credentials. You can use this parameter to run tasks on the same
// instance, even it the tasks need to join different domains. For more
// information, see Using gMSAs for Windows Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html)
// and Using gMSAs for Linux Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)
// .
CredentialSpecs []string
// The dependencies defined for container startup and shutdown. A container can
// contain multiple dependencies on other containers in a task definition. When a
// dependency is defined for container startup, for container shutdown it is
// reversed. For tasks using the EC2 launch type, the container instances require
// at least version 1.26.0 of the container agent to turn on container
// dependencies. However, we recommend using the latest container agent version.
// For information about checking your agent version and updating to the latest
// version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
// in the Amazon Elastic Container Service Developer Guide. If you're using an
// Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of
// the ecs-init package. If your container instances are launched from version
// 20190301 or later, then they contain the required versions of the container
// agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
// in the Amazon Elastic Container Service Developer Guide. For tasks using the
// Fargate launch type, the task or service requires the following platforms:
// - Linux platform version 1.3.0 or later.
// - Windows platform version 1.0.0 or later.
DependsOn []ContainerDependency
// When this parameter is true, networking is off within the container. This
// parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) .
// This parameter is not supported for Windows containers.
DisableNetworking *bool
// A list of DNS search domains that are presented to the container. This
// parameter maps to DnsSearch in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --dns-search option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter is not supported for Windows containers.
DnsSearchDomains []string
// A list of DNS servers that are presented to the container. This parameter maps
// to Dns in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --dns option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter is not supported for Windows containers.
DnsServers []string
// A key/value map of labels to add to the container. This parameter maps to Labels
// in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --label option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter requires version 1.18 of the Docker Remote API or greater on
// your container instance. To check the Docker Remote API version on your
// container instance, log in to your container instance and run the following
// command: sudo docker version --format '{{.Server.APIVersion}}'
DockerLabels map[string]string
// A list of strings to provide custom configuration for multiple security
// systems. For more information about valid values, see Docker Run Security
// Configuration (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This field isn't valid for containers in tasks using the Fargate launch type.
// For Linux tasks on EC2, this parameter can be used to reference custom labels
// for SELinux and AppArmor multi-level security systems. For any tasks on EC2,
// this parameter can be used to reference a credential spec file that configures a
// container for Active Directory authentication. For more information, see Using
// gMSAs for Windows Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html)
// and Using gMSAs for Linux Containers (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)
// in the Amazon Elastic Container Service Developer Guide. This parameter maps to
// SecurityOpt in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --security-opt option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . The Amazon ECS container agent running on a container instance must register
// with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment
// variables before containers placed on that instance can use these security
// options. For more information, see Amazon ECS Container Agent Configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
// in the Amazon Elastic Container Service Developer Guide. For more information
// about valid values, see Docker Run Security Configuration (https://docs.docker.com/engine/reference/run/#security-configuration)
// . Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" |
// "credentialspec:CredentialSpecFilePath"
DockerSecurityOptions []string
// Early versions of the Amazon ECS container agent don't properly handle
// entryPoint parameters. If you have problems using entryPoint , update your
// container agent or enter your commands and arguments as command array items
// instead. The entry point that's passed to the container. This parameter maps to
// Entrypoint in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . For more information, see
// https://docs.docker.com/engine/reference/builder/#entrypoint (https://docs.docker.com/engine/reference/builder/#entrypoint)
// .
EntryPoint []string
// The environment variables to pass to a container. This parameter maps to Env in
// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --env option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . We don't recommend that you use plaintext environment variables for sensitive
// information, such as credential data.
Environment []KeyValuePair
// A list of files containing the environment variables to pass to a container.
// This parameter maps to the --env-file option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . You can specify up to ten environment files. The file must have a .env file
// extension. Each line in an environment file contains an environment variable in
// VARIABLE=VALUE format. Lines beginning with # are treated as comments and are
// ignored. For more information about the environment variable file syntax, see
// Declare default environment variables in file (https://docs.docker.com/compose/env-file/)
// . If there are environment variables specified using the environment parameter
// in a container definition, they take precedence over the variables contained
// within an environment file. If multiple environment files are specified that
// contain the same variable, they're processed from the top down. We recommend
// that you use unique variable names. For more information, see Specifying
// Environment Variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)
// in the Amazon Elastic Container Service Developer Guide.
EnvironmentFiles []EnvironmentFile
// If the essential parameter of a container is marked as true , and that container
// fails or stops for any reason, all other containers that are part of the task
// are stopped. If the essential parameter of a container is marked as false , its
// failure doesn't affect the rest of the containers in a task. If this parameter
// is omitted, a container is assumed to be essential. All tasks must have at least
// one essential container. If you have an application that's composed of multiple
// containers, group containers that are used for a common purpose into components,
// and separate the different components into multiple task definitions. For more
// information, see Application Architecture (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html)
// in the Amazon Elastic Container Service Developer Guide.
Essential *bool
// A list of hostnames and IP address mappings to append to the /etc/hosts file on
// the container. This parameter maps to ExtraHosts in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --add-host option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter isn't supported for Windows containers or tasks that use the
// awsvpc network mode.
ExtraHosts []HostEntry
// The FireLens configuration for the container. This is used to specify and
// configure a log router for container logs. For more information, see Custom Log
// Routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
// in the Amazon Elastic Container Service Developer Guide.
FirelensConfiguration *FirelensConfiguration
// The container health check command and associated configuration parameters for
// the container. This parameter maps to HealthCheck in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
HealthCheck *HealthCheck
// The hostname to use for your container. This parameter maps to Hostname in the
// Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . The hostname parameter is not supported if you're using the awsvpc network
// mode.
Hostname *string
// The image used to start a container. This string is passed directly to the
// Docker daemon. By default, images in the Docker Hub registry are available.
// Other repositories are specified with either repository-url/image:tag or
// repository-url/image@digest . Up to 255 letters (uppercase and lowercase),
// numbers, hyphens, underscores, colons, periods, forward slashes, and number
// signs are allowed. This parameter maps to Image in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
// - When a new task starts, the Amazon ECS container agent pulls the latest
// version of the specified image and tag for the container to use. However,
// subsequent updates to a repository image aren't propagated to already running
// tasks.
// - Images in Amazon ECR repositories can be specified by either using the full
// registry/repository:tag or registry/repository@digest . For example,
// 012345678910.dkr.ecr..amazonaws.com/:latest or
// 012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
// .
// - Images in official repositories on Docker Hub use a single name (for
// example, ubuntu or mongo ).
// - Images in other repositories on Docker Hub are qualified with an
// organization name (for example, amazon/amazon-ecs-agent ).
// - Images in other online repositories are qualified further by a domain name
// (for example, quay.io/assemblyline/ubuntu ).
Image *string
// When this parameter is true , you can deploy containerized applications that
// require stdin or a tty to be allocated. This parameter maps to OpenStdin in the
// Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --interactive option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
Interactive *bool
// The links parameter allows containers to communicate with each other without
// the need for port mappings. This parameter is only supported if the network mode
// of a task definition is bridge . The name:internalName construct is analogous
// to name:alias in Docker links. Up to 255 letters (uppercase and lowercase),
// numbers, underscores, and hyphens are allowed. For more information about
// linking Docker containers, go to Legacy container links (https://docs.docker.com/network/links/)
// in the Docker documentation. This parameter maps to Links in the Create a
// container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --link option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter is not supported for Windows containers. Containers that are
// collocated on a single container instance may be able to communicate with each
// other without requiring links or host port mappings. Network isolation is
// achieved on the container instance using security groups and VPC settings.
Links []string
// Linux-specific modifications that are applied to the container, such as Linux
// kernel capabilities. For more information see KernelCapabilities . This
// parameter is not supported for Windows containers.
LinuxParameters *LinuxParameters
// The log configuration specification for the container. This parameter maps to
// LogConfig in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . By default, containers use the same logging driver that the Docker daemon
// uses. However the container can use a different logging driver than the Docker
// daemon by specifying a log driver with this parameter in the container
// definition. To use a different logging driver for a container, the log system
// must be configured properly on the container instance (or on a different log
// server for remote logging options). For more information about the options for
// different supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
// in the Docker documentation. Amazon ECS currently supports a subset of the
// logging drivers available to the Docker daemon (shown in the LogConfiguration
// data type). Additional log drivers may be available in future releases of the
// Amazon ECS container agent. This parameter requires version 1.18 of the Docker
// Remote API or greater on your container instance. To check the Docker Remote API
// version on your container instance, log in to your container instance and run
// the following command: sudo docker version --format '{{.Server.APIVersion}}'
// The Amazon ECS container agent running on a container instance must register the
// logging drivers available on that instance with the
// ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on
// that instance can use these log configuration options. For more information, see
// Amazon ECS Container Agent Configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
// in the Amazon Elastic Container Service Developer Guide.
LogConfiguration *LogConfiguration
// The amount (in MiB) of memory to present to the container. If your container
// attempts to exceed the memory specified here, the container is killed. The total
// amount of memory reserved for all containers within a task must be lower than
// the task memory value, if one is specified. This parameter maps to Memory in
// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --memory option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If using the Fargate launch type, this parameter is optional. If using the EC2
// launch type, you must specify either a task-level memory value or a
// container-level memory value. If you specify both a container-level memory and
// memoryReservation value, memory must be greater than memoryReservation . If you
// specify memoryReservation , then that value is subtracted from the available
// memory resources for the container instance where the container is placed.
// Otherwise, the value of memory is used. The Docker 20.10.0 or later daemon
// reserves a minimum of 6 MiB of memory for a container. So, don't specify less
// than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier
// daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify
// less than 4 MiB of memory for your containers.
Memory *int32
// The soft limit (in MiB) of memory to reserve for the container. When system
// memory is under heavy contention, Docker attempts to keep the container memory
// to this soft limit. However, your container can consume more memory when it
// needs to, up to either the hard limit specified with the memory parameter (if
// applicable), or all of the available memory on the container instance, whichever
// comes first. This parameter maps to MemoryReservation in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --memory-reservation option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If a task-level memory value is not specified, you must specify a non-zero
// integer for one or both of memory or memoryReservation in a container
// definition. If you specify both, memory must be greater than memoryReservation .
// If you specify memoryReservation , then that value is subtracted from the
// available memory resources for the container instance where the container is
// placed. Otherwise, the value of memory is used. For example, if your container
// normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory
// for short periods of time, you can set a memoryReservation of 128 MiB, and a
// memory hard limit of 300 MiB. This configuration would allow the container to
// only reserve 128 MiB of memory from the remaining resources on the container
// instance, but also allow the container to consume more memory resources when
// needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory
// for a container. So, don't specify less than 6 MiB of memory for your
// containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB
// of memory for a container. So, don't specify less than 4 MiB of memory for your
// containers.
MemoryReservation *int32
// The mount points for data volumes in your container. This parameter maps to
// Volumes in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --volume option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . Windows containers can mount whole directories on the same drive as
// $env:ProgramData . Windows containers can't mount directories on a different
// drive, and mount point can't be across drives.
MountPoints []MountPoint
// The name of a container. If you're linking multiple containers together in a
// task definition, the name of one container can be entered in the links of
// another container to connect the containers. Up to 255 letters (uppercase and
// lowercase), numbers, underscores, and hyphens are allowed. This parameter maps
// to name in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --name option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
Name *string
// The list of port mappings for the container. Port mappings allow containers to
// access ports on the host container instance to send or receive traffic. For task
// definitions that use the awsvpc network mode, only specify the containerPort .
// The hostPort can be left blank or it must be the same value as the containerPort
// . Port mappings on Windows use the NetNAT gateway address rather than localhost
// . There's no loopback for port mappings on Windows, so you can't access a
// container's mapped port from the host itself. This parameter maps to
// PortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --publish option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If the network mode of a task definition is set to none , then you can't
// specify port mappings. If the network mode of a task definition is set to host ,
// then host ports must either be undefined or they must match the container port
// in the port mapping. After a task reaches the RUNNING status, manual and
// automatic host and container port assignments are visible in the Network
// Bindings section of a container description for a selected task in the Amazon
// ECS console. The assignments are also visible in the networkBindings section
// DescribeTasks responses.
PortMappings []PortMapping
// When this parameter is true, the container is given elevated privileges on the
// host container instance (similar to the root user). This parameter maps to
// Privileged in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter is not supported for Windows containers or tasks run on
// Fargate.
Privileged *bool
// When this parameter is true , a TTY is allocated. This parameter maps to Tty in
// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --tty option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
PseudoTerminal *bool
// When this parameter is true, the container is given read-only access to its
// root file system. This parameter maps to ReadonlyRootfs in the Create a
// container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --read-only option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter is not supported for Windows containers.
ReadonlyRootFilesystem *bool
// The private repository authentication credentials to use.
RepositoryCredentials *RepositoryCredentials
// The type and amount of a resource to assign to a container. The only supported
// resource is a GPU.
ResourceRequirements []ResourceRequirement
// The secrets to pass to the container. For more information, see Specifying
// Sensitive Data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)
// in the Amazon Elastic Container Service Developer Guide.
Secrets []Secret
// Time duration (in seconds) to wait before giving up on resolving dependencies
// for a container. For example, you specify two containers in a task definition
// with containerA having a dependency on containerB reaching a COMPLETE , SUCCESS
// , or HEALTHY status. If a startTimeout value is specified for containerB and it
// doesn't reach the desired status within that time then containerA gives up and
// not start. This results in the task transitioning to a STOPPED state. When the
// ECS_CONTAINER_START_TIMEOUT container agent configuration variable is used, it's
// enforced independently from this start timeout value. For tasks using the
// Fargate launch type, the task or service requires the following platforms:
// - Linux platform version 1.3.0 or later.
// - Windows platform version 1.0.0 or later.
// For tasks using the EC2 launch type, your container instances require at least
// version 1.26.0 of the container agent to use a container start timeout value.
// However, we recommend using the latest container agent version. For information
// about checking your agent version and updating to the latest version, see
// Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
// in the Amazon Elastic Container Service Developer Guide. If you're using an
// Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
// of the ecs-init package. If your container instances are launched from version
// 20190301 or later, then they contain the required versions of the container
// agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
// in the Amazon Elastic Container Service Developer Guide. The valid values are
// 2-120 seconds.
StartTimeout *int32
// Time duration (in seconds) to wait before the container is forcefully killed if
// it doesn't exit normally on its own. For tasks using the Fargate launch type,
// the task or service requires the following platforms:
// - Linux platform version 1.3.0 or later.
// - Windows platform version 1.0.0 or later.
// The max stop timeout value is 120 seconds and if the parameter is not
// specified, the default value of 30 seconds is used. For tasks that use the EC2
// launch type, if the stopTimeout parameter isn't specified, the value set for
// the Amazon ECS container agent configuration variable ECS_CONTAINER_STOP_TIMEOUT
// is used. If neither the stopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT
// agent configuration variable are set, then the default values of 30 seconds for
// Linux containers and 30 seconds on Windows containers are used. Your container
// instances require at least version 1.26.0 of the container agent to use a
// container stop timeout value. However, we recommend using the latest container
// agent version. For information about checking your agent version and updating to
// the latest version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
// in the Amazon Elastic Container Service Developer Guide. If you're using an
// Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of
// the ecs-init package. If your container instances are launched from version
// 20190301 or later, then they contain the required versions of the container
// agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
// in the Amazon Elastic Container Service Developer Guide. The valid values are
// 2-120 seconds.
StopTimeout *int32
// A list of namespaced kernel parameters to set in the container. This parameter
// maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . For example, you can configure net.ipv4.tcp_keepalive_time setting to
// maintain longer lived connections. We don't recommended that you specify
// network-related systemControls parameters for multiple containers in a single
// task that also uses either the awsvpc or host network modes. For tasks that use
// the awsvpc network mode, the container that's started last determines which
// systemControls parameters take effect. For tasks that use the host network
// mode, it changes the container instance's namespaced kernel parameters as well
// as the containers. This parameter is not supported for Windows containers. This
// parameter is only supported for tasks that are hosted on Fargate if the tasks
// are using platform version 1.4.0 or later (Linux). This isn't supported for
// Windows containers on Fargate.
SystemControls []SystemControl
// A list of ulimits to set in the container. If a ulimit value is specified in a
// task definition, it overrides the default values set by Docker. This parameter
// maps to Ulimits in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --ulimit option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . Valid naming values are displayed in the Ulimit data type. Amazon ECS tasks
// hosted on Fargate use the default resource limit values set by the operating
// system with the exception of the nofile resource limit parameter which Fargate
// overrides. The nofile resource limit sets a restriction on the number of open
// files that a container can use. The default nofile soft limit is 1024 and the
// default hard limit is 4096 . This parameter requires version 1.18 of the Docker
// Remote API or greater on your container instance. To check the Docker Remote API
// version on your container instance, log in to your container instance and run
// the following command: sudo docker version --format '{{.Server.APIVersion}}'
// This parameter is not supported for Windows containers.
Ulimits []Ulimit
// The user to use inside the container. This parameter maps to User in the Create
// a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --user option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . When running tasks using the host network mode, don't run containers using
// the root user (UID 0). We recommend using a non-root user for better security.
// You can specify the user using the following formats. If specifying a UID or
// GID, you must specify it as a positive integer.
// - user
// - user:group
// - uid
// - uid:gid
// - user:gid
// - uid:group
// This parameter is not supported for Windows containers.
User *string
// Data volumes to mount from another container. This parameter maps to VolumesFrom
// in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
VolumesFrom []VolumeFrom
// The working directory to run commands inside the container in. This parameter
// maps to WorkingDir in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --workdir option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// .
WorkingDirectory *string
noSmithyDocumentSerde
}
// The dependencies defined for container startup and shutdown. A container can
// contain multiple dependencies. When a dependency is defined for container
// startup, for container shutdown it is reversed. Your Amazon ECS container
// instances require at least version 1.26.0 of the container agent to use
// container dependencies. However, we recommend using the latest container agent
// version. For information about checking your agent version and updating to the
// latest version, see Updating the Amazon ECS Container Agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
// in the Amazon Elastic Container Service Developer Guide. If you're using an
// Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of
// the ecs-init package. If your container instances are launched from version
// 20190301 or later, then they contain the required versions of the container
// agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
// in the Amazon Elastic Container Service Developer Guide. For tasks that use the
// Fargate launch type, the task or service requires the following platforms:
// - Linux platform version 1.3.0 or later.
// - Windows platform version 1.0.0 or later.
type ContainerDependency struct {
// The dependency condition of the container. The following are the available
// conditions and their behavior:
// - START - This condition emulates the behavior of links and volumes today. It
// validates that a dependent container is started before permitting other
// containers to start.
// - COMPLETE - This condition validates that a dependent container runs to
// completion (exits) before permitting other containers to start. This can be
// useful for nonessential containers that run a script and then exit. This
// condition can't be set on an essential container.
// - SUCCESS - This condition is the same as COMPLETE , but it also requires that
// the container exits with a zero status. This condition can't be set on an
// essential container.
// - HEALTHY - This condition validates that the dependent container passes its
// Docker health check before permitting other containers to start. This requires
// that the dependent container has health checks configured. This condition is
// confirmed only at task startup.
//
// This member is required.
Condition ContainerCondition
// The name of a container.
//
// This member is required.
ContainerName *string
noSmithyDocumentSerde
}
// An Amazon EC2 or External instance that's running the Amazon ECS agent and has
// been registered with a cluster.
type ContainerInstance struct {
// This parameter returns true if the agent is connected to Amazon ECS. An
// instance with an agent that may be unhealthy or stopped return false . Only
// instances connected to an agent can accept task placement requests.
AgentConnected bool
// The status of the most recent agent update. If an update wasn't ever requested,
// this value is NULL .
AgentUpdateStatus AgentUpdateStatus
// The resources attached to a container instance, such as an elastic network
// interface.
Attachments []Attachment
// The attributes set for the container instance, either by the Amazon ECS
// container agent at instance registration or manually with the PutAttributes
// operation.
Attributes []Attribute
// The capacity provider that's associated with the container instance.
CapacityProviderName *string
// The Amazon Resource Name (ARN) of the container instance. For more information
// about the ARN format, see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
// in the Amazon ECS Developer Guide.
ContainerInstanceArn *string
// The ID of the container instance. For Amazon EC2 instances, this value is the
// Amazon EC2 instance ID. For external instances, this value is the Amazon Web
// Services Systems Manager managed instance ID.
Ec2InstanceId *string
// An object representing the health status of the container instance.
HealthStatus *ContainerInstanceHealthStatus
// The number of tasks on the container instance that are in the PENDING status.
PendingTasksCount int32
// The Unix timestamp for the time when the container instance was registered.
RegisteredAt *time.Time
// For CPU and memory resource types, this parameter describes the amount of each
// resource that was available on the container instance when the container agent
// registered it with Amazon ECS. This value represents the total amount of CPU and
// memory that can be allocated on this container instance to tasks. For port
// resource types, this parameter describes the ports that were reserved by the
// Amazon ECS container agent when it registered the container instance with Amazon
// ECS.
RegisteredResources []Resource
// For CPU and memory resource types, this parameter describes the remaining CPU
// and memory that wasn't already allocated to tasks and is therefore available for
// new tasks. For port resource types, this parameter describes the ports that were
// reserved by the Amazon ECS container agent (at instance registration time) and
// any task containers that have reserved port mappings on the host (with the host
// or bridge network mode). Any port that's not specified here is available for
// new tasks.
RemainingResources []Resource
// The number of tasks on the container instance that have a desired status (
// desiredStatus ) of RUNNING .
RunningTasksCount int32
// The status of the container instance. The valid values are REGISTERING ,
// REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING , or DRAINING . If your
// account has opted in to the awsvpcTrunking account setting, then any newly
// registered container instance will transition to a REGISTERING status while the
// trunk elastic network interface is provisioned for the instance. If the
// registration fails, the instance will transition to a REGISTRATION_FAILED
// status. You can describe the container instance and see the reason for failure
// in the statusReason parameter. Once the container instance is terminated, the
// instance transitions to a DEREGISTERING status while the trunk elastic network
// interface is deprovisioned. The instance then transitions to an INACTIVE
// status. The ACTIVE status indicates that the container instance can accept
// tasks. The DRAINING indicates that new tasks aren't placed on the container
// instance and any service tasks running on the container instance are removed if
// possible. For more information, see Container instance draining (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html)
// in the Amazon Elastic Container Service Developer Guide.
Status *string
// The reason that the container instance reached its current status.
StatusReason *string
// The metadata that you apply to the container instance to help you categorize
// and organize them. Each tag consists of a key and an optional value. You define
// both. The following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
// The version counter for the container instance. Every time a container instance
// experiences a change that triggers a CloudWatch event, the version counter is
// incremented. If you're replicating your Amazon ECS container instance state with
// CloudWatch Events, you can compare the version of a container instance reported
// by the Amazon ECS APIs with the version reported in CloudWatch Events for the
// container instance (inside the detail object) to verify that the version in
// your event stream is current.
Version int64
// The version information for the Amazon ECS container agent and Docker daemon
// running on the container instance.
VersionInfo *VersionInfo
noSmithyDocumentSerde
}
// An object representing the health status of the container instance.
type ContainerInstanceHealthStatus struct {
// An array of objects representing the details of the container instance health
// status.
Details []InstanceHealthCheckResult
// The overall health status of the container instance. This is an aggregate
// status of all container instance health checks.
OverallStatus InstanceHealthCheckState
noSmithyDocumentSerde
}
// The overrides that are sent to a container. An empty container override can be
// passed in. An example of an empty container override is {"containerOverrides":
// [ ] } . If a non-empty container override is specified, the name parameter must
// be included. You can use Secrets Manager or Amazon Web Services Systems Manager
// Parameter Store to store the sensitive data. For more information, see Retrieve
// secrets through environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/secrets-envvar.html)
// in the Amazon ECS Developer Guide.
type ContainerOverride struct {
// The command to send to the container that overrides the default command from
// the Docker image or the task definition. You must also specify a container name.
Command []string
// The number of cpu units reserved for the container, instead of the default
// value from the task definition. You must also specify a container name.
Cpu *int32
// The environment variables to send to the container. You can add new environment
// variables, which are added to the container at launch, or you can override the
// existing environment variables from the Docker image or the task definition. You
// must also specify a container name.
Environment []KeyValuePair
// A list of files containing the environment variables to pass to a container,
// instead of the value from the container definition.
EnvironmentFiles []EnvironmentFile
// The hard limit (in MiB) of memory to present to the container, instead of the
// default value from the task definition. If your container attempts to exceed the
// memory specified here, the container is killed. You must also specify a
// container name.
Memory *int32
// The soft limit (in MiB) of memory to reserve for the container, instead of the
// default value from the task definition. You must also specify a container name.
MemoryReservation *int32
// The name of the container that receives the override. This parameter is
// required if any override is specified.
Name *string
// The type and amount of a resource to assign to a container, instead of the
// default value from the task definition. The only supported resource is a GPU.
ResourceRequirements []ResourceRequirement
noSmithyDocumentSerde
}
// An object that represents a change in state for a container.
type ContainerStateChange struct {
// The name of the container.
ContainerName *string
// The exit code for the container, if the state change is a result of the
// container exiting.
ExitCode *int32
// The container image SHA 256 digest.
ImageDigest *string
// Any network bindings that are associated with the container.
NetworkBindings []NetworkBinding
// The reason for the state change.
Reason *string
// The ID of the Docker container.
RuntimeId *string
// The status of the container.
Status *string
noSmithyDocumentSerde
}
// The details of an Amazon ECS service deployment. This is used only when a
// service uses the ECS deployment controller type.
type Deployment struct {
// The capacity provider strategy that the deployment is using.
CapacityProviderStrategy []CapacityProviderStrategyItem
// The Unix timestamp for the time when the service deployment was created.
CreatedAt *time.Time
// The most recent desired count of tasks that was specified for the service to
// deploy or maintain.
DesiredCount int32
// The number of consecutively failed tasks in the deployment. A task is
// considered a failure if the service scheduler can't launch the task, the task
// doesn't transition to a RUNNING state, or if it fails any of its defined health
// checks and is stopped. Once a service deployment has one or more successfully
// running tasks, the failed task count resets to zero and stops being evaluated.
FailedTasks int32
// The ID of the deployment.
Id *string
// The launch type the tasks in the service are using. For more information, see
// Amazon ECS Launch Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
// in the Amazon Elastic Container Service Developer Guide.
LaunchType LaunchType
// The VPC subnet and security group configuration for tasks that receive their
// own elastic network interface by using the awsvpc networking mode.
NetworkConfiguration *NetworkConfiguration
// The number of tasks in the deployment that are in the PENDING status.
PendingCount int32
// The operating system that your tasks in the service, or tasks are running on. A
// platform family is specified only for tasks using the Fargate launch type. All
// tasks that run as part of this service must use the same platformFamily value
// as the service, for example, LINUX. .
PlatformFamily *string
// The platform version that your tasks in the service run on. A platform version
// is only specified for tasks using the Fargate launch type. If one isn't
// specified, the LATEST platform version is used. For more information, see
// Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// in the Amazon Elastic Container Service Developer Guide.
PlatformVersion *string
// The rolloutState of a service is only returned for services that use the
// rolling update ( ECS ) deployment type that aren't behind a Classic Load
// Balancer. The rollout state of the deployment. When a service deployment is
// started, it begins in an IN_PROGRESS state. When the service reaches a steady
// state, the deployment transitions to a COMPLETED state. If the service fails to
// reach a steady state and circuit breaker is turned on, the deployment
// transitions to a FAILED state. A deployment in FAILED state doesn't launch any
// new tasks. For more information, see DeploymentCircuitBreaker .
RolloutState DeploymentRolloutState
// A description of the rollout state of a deployment.
RolloutStateReason *string
// The number of tasks in the deployment that are in the RUNNING status.
RunningCount int32
// The details of the Service Connect configuration that's used by this
// deployment. Compare the configuration between multiple deployments when
// troubleshooting issues with new deployments. The configuration for this service
// to discover and connect to services, and be discovered by, and connected from,
// other services within a namespace. Tasks that run in a namespace can use short
// names to connect to services in the namespace. Tasks can connect to services
// across all of the clusters in the namespace. Tasks connect through a managed
// proxy container that collects logs and metrics for increased visibility. Only
// the tasks that Amazon ECS services create are supported with Service Connect.
// For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
ServiceConnectConfiguration *ServiceConnectConfiguration
// The list of Service Connect resources that are associated with this deployment.
// Each list entry maps a discovery name to a Cloud Map service name.
ServiceConnectResources []ServiceConnectServiceResource
// The status of the deployment. The following describes each state. PRIMARY The
// most recent deployment of a service. ACTIVE A service deployment that still has
// running tasks, but are in the process of being replaced with a new PRIMARY
// deployment. INACTIVE A deployment that has been completely replaced.
Status *string
// The most recent task definition that was specified for the tasks in the service
// to use.
TaskDefinition *string
// The Unix timestamp for the time when the service deployment was last updated.
UpdatedAt *time.Time
noSmithyDocumentSerde
}
// One of the methods which provide a way for you to quickly identify when a
// deployment has failed, and then to optionally roll back the failure to the last
// working deployment. When the alarms are generated, Amazon ECS sets the service
// deployment to failed. Set the rollback parameter to have Amazon ECS to roll back
// your service to the last completed deployment after a failure. You can only use
// the DeploymentAlarms method to detect failures when the DeploymentController is
// set to ECS (rolling update). For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)
// in the Amazon Elastic Container Service Developer Guide .
type DeploymentAlarms struct {
// One or more CloudWatch alarm names. Use a "," to separate the alarms.
//
// This member is required.
AlarmNames []string
// Determines whether to use the CloudWatch alarm option in the service deployment
// process.
//
// This member is required.
Enable bool
// Determines whether to configure Amazon ECS to roll back the service if a
// service deployment fails. If rollback is used, when a service deployment fails,
// the service is rolled back to the last deployment that completed successfully.
//
// This member is required.
Rollback bool
noSmithyDocumentSerde
}
// The deployment circuit breaker can only be used for services using the rolling
// update ( ECS ) deployment type. The deployment circuit breaker determines
// whether a service deployment will fail if the service can't reach a steady
// state. If it is turned on, a service deployment will transition to a failed
// state and stop launching new tasks. You can also configure Amazon ECS to roll
// back your service to the last completed deployment after a failure. For more
// information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)
// in the Amazon Elastic Container Service Developer Guide. For more information
// about API failure reasons, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html)
// in the Amazon Elastic Container Service Developer Guide.
type DeploymentCircuitBreaker struct {
// Determines whether to use the deployment circuit breaker logic for the service.
//
// This member is required.
Enable bool
// Determines whether to configure Amazon ECS to roll back the service if a
// service deployment fails. If rollback is on, when a service deployment fails,
// the service is rolled back to the last deployment that completed successfully.
//
// This member is required.
Rollback bool
noSmithyDocumentSerde
}
// Optional deployment parameters that control how many tasks run during a
// deployment and the ordering of stopping and starting tasks.
type DeploymentConfiguration struct {
// Information about the CloudWatch alarms.
Alarms *DeploymentAlarms
// The deployment circuit breaker can only be used for services using the rolling
// update ( ECS ) deployment type. The deployment circuit breaker determines
// whether a service deployment will fail if the service can't reach a steady
// state. If you use the deployment circuit breaker, a service deployment will
// transition to a failed state and stop launching new tasks. If you use the
// rollback option, when a service deployment fails, the service is rolled back to
// the last deployment that completed successfully. For more information, see
// Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)
// in the Amazon Elastic Container Service Developer Guide
DeploymentCircuitBreaker *DeploymentCircuitBreaker
// If a service is using the rolling update ( ECS ) deployment type, the
// maximumPercent parameter represents an upper limit on the number of your
// service's tasks that are allowed in the RUNNING or PENDING state during a
// deployment, as a percentage of the desiredCount (rounded down to the nearest
// integer). This parameter enables you to define the deployment batch size. For
// example, if your service is using the REPLICA service scheduler and has a
// desiredCount of four tasks and a maximumPercent value of 200%, the scheduler
// may start four new tasks before stopping the four older tasks (provided that the
// cluster resources required to do this are available). The default maximumPercent
// value for a service using the REPLICA service scheduler is 200%. If a service
// is using either the blue/green ( CODE_DEPLOY ) or EXTERNAL deployment types and
// tasks that use the EC2 launch type, the maximum percent value is set to the
// default value and is used to define the upper limit on the number of the tasks
// in the service that remain in the RUNNING state while the container instances
// are in the DRAINING state. If the tasks in the service use the Fargate launch
// type, the maximum percent value is not used, although it is returned when
// describing your service.
MaximumPercent *int32
// If a service is using the rolling update ( ECS ) deployment type, the
// minimumHealthyPercent represents a lower limit on the number of your service's
// tasks that must remain in the RUNNING state during a deployment, as a
// percentage of the desiredCount (rounded up to the nearest integer). This
// parameter enables you to deploy without using additional cluster capacity. For
// example, if your service has a desiredCount of four tasks and a
// minimumHealthyPercent of 50%, the service scheduler may stop two existing tasks
// to free up cluster capacity before starting two new tasks. For services that do
// not use a load balancer, the following should be noted:
// - A service is considered healthy if all essential containers within the
// tasks in the service pass their health checks.
// - If a task has no essential containers with a health check defined, the
// service scheduler will wait for 40 seconds after a task reaches a RUNNING
// state before the task is counted towards the minimum healthy percent total.
// - If a task has one or more essential containers with a health check defined,
// the service scheduler will wait for the task to reach a healthy status before
// counting it towards the minimum healthy percent total. A task is considered
// healthy when all essential containers within the task have passed their health
// checks. The amount of time the service scheduler can wait for is determined by
// the container health check settings.
// For services are that do use a load balancer, the following should be noted:
// - If a task has no essential containers with a health check defined, the
// service scheduler will wait for the load balancer target group health check to
// return a healthy status before counting the task towards the minimum healthy
// percent total.
// - If a task has an essential container with a health check defined, the
// service scheduler will wait for both the task to reach a healthy status and the
// load balancer target group health check to return a healthy status before
// counting the task towards the minimum healthy percent total.
// If a service is using either the blue/green ( CODE_DEPLOY ) or EXTERNAL
// deployment types and is running tasks that use the EC2 launch type, the minimum
// healthy percent value is set to the default value and is used to define the
// lower limit on the number of the tasks in the service that remain in the RUNNING
// state while the container instances are in the DRAINING state. If a service is
// using either the blue/green ( CODE_DEPLOY ) or EXTERNAL deployment types and is
// running tasks that use the Fargate launch type, the minimum healthy percent
// value is not used, although it is returned when describing your service.
MinimumHealthyPercent *int32
noSmithyDocumentSerde
}
// The deployment controller to use for the service. For more information, see
// Amazon ECS deployment types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
// in the Amazon Elastic Container Service Developer Guide.
type DeploymentController struct {
// The deployment controller type to use. There are three deployment controller
// types available: ECS The rolling update ( ECS ) deployment type involves
// replacing the current running version of the container with the latest version.
// The number of containers Amazon ECS adds or removes from the service during a
// rolling update is controlled by adjusting the minimum and maximum number of
// healthy tasks allowed during a service deployment, as specified in the
// DeploymentConfiguration . CODE_DEPLOY The blue/green ( CODE_DEPLOY ) deployment
// type uses the blue/green deployment model powered by CodeDeploy, which allows
// you to verify a new deployment of a service before sending production traffic to
// it. EXTERNAL The external ( EXTERNAL ) deployment type enables you to use any
// third-party deployment controller for full control over the deployment process
// for an Amazon ECS service.
//
// This member is required.
Type DeploymentControllerType
noSmithyDocumentSerde
}
// An object representing a container instance host device.
type Device struct {
// The path for the device on the host container instance.
//
// This member is required.
HostPath *string
// The path inside the container at which to expose the host device.
ContainerPath *string
// The explicit permissions to provide to the container for the device. By
// default, the container has permissions for read , write , and mknod for the
// device.
Permissions []DeviceCgroupPermission
noSmithyDocumentSerde
}
// This parameter is specified when you're using Docker volumes. Docker volumes
// are only supported when you're using the EC2 launch type. Windows containers
// only support the use of the local driver. To use bind mounts, specify a host
// instead.
type DockerVolumeConfiguration struct {
// If this value is true , the Docker volume is created if it doesn't already
// exist. This field is only used if the scope is shared .
Autoprovision *bool
// The Docker volume driver to use. The driver value must match the driver name
// provided by Docker because it is used for task placement. If the driver was
// installed using the Docker plugin CLI, use docker plugin ls to retrieve the
// driver name from your container instance. If the driver was installed using
// another method, use Docker plugin discovery to retrieve the driver name. For
// more information, see Docker plugin discovery (https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery)
// . This parameter maps to Driver in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the xxdriver option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/)
// .
Driver *string
// A map of Docker driver-specific options passed through. This parameter maps to
// DriverOpts in the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the xxopt option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/)
// .
DriverOpts map[string]string
// Custom metadata to add to your Docker volume. This parameter maps to Labels in
// the Create a volume (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the xxlabel option to docker volume create (https://docs.docker.com/engine/reference/commandline/volume_create/)
// .
Labels map[string]string
// The scope for the Docker volume that determines its lifecycle. Docker volumes
// that are scoped to a task are automatically provisioned when the task starts
// and destroyed when the task stops. Docker volumes that are scoped as shared
// persist after the task stops.
Scope Scope
noSmithyDocumentSerde
}
// The authorization configuration details for the Amazon EFS file system.
type EFSAuthorizationConfig struct {
// The Amazon EFS access point ID to use. If an access point is specified, the
// root directory value specified in the EFSVolumeConfiguration must either be
// omitted or set to / which will enforce the path set on the EFS access point. If
// an access point is used, transit encryption must be on in the
// EFSVolumeConfiguration . For more information, see Working with Amazon EFS
// access points (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)
// in the Amazon Elastic File System User Guide.
AccessPointId *string
// Determines whether to use the Amazon ECS task role defined in a task definition
// when mounting the Amazon EFS file system. If it is turned on, transit encryption
// must be turned on in the EFSVolumeConfiguration . If this parameter is omitted,
// the default value of DISABLED is used. For more information, see Using Amazon
// EFS access points (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints)
// in the Amazon Elastic Container Service Developer Guide.
Iam EFSAuthorizationConfigIAM
noSmithyDocumentSerde
}
// This parameter is specified when you're using an Amazon Elastic File System
// file system for task storage. For more information, see Amazon EFS volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html)
// in the Amazon Elastic Container Service Developer Guide.
type EFSVolumeConfiguration struct {
// The Amazon EFS file system ID to use.
//
// This member is required.
FileSystemId *string
// The authorization configuration details for the Amazon EFS file system.
AuthorizationConfig *EFSAuthorizationConfig
// The directory within the Amazon EFS file system to mount as the root directory
// inside the host. If this parameter is omitted, the root of the Amazon EFS volume
// will be used. Specifying / will have the same effect as omitting this
// parameter. If an EFS access point is specified in the authorizationConfig , the
// root directory parameter must either be omitted or set to / which will enforce
// the path set on the EFS access point.
RootDirectory *string
// Determines whether to use encryption for Amazon EFS data in transit between the
// Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on
// if Amazon EFS IAM authorization is used. If this parameter is omitted, the
// default value of DISABLED is used. For more information, see Encrypting data in
// transit (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html)
// in the Amazon Elastic File System User Guide.
TransitEncryption EFSTransitEncryption
// The port to use when sending encrypted data between the Amazon ECS host and the
// Amazon EFS server. If you do not specify a transit encryption port, it will use
// the port selection strategy that the Amazon EFS mount helper uses. For more
// information, see EFS mount helper (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html)
// in the Amazon Elastic File System User Guide.
TransitEncryptionPort *int32
noSmithyDocumentSerde
}
// A list of files containing the environment variables to pass to a container.
// You can specify up to ten environment files. The file must have a .env file
// extension. Each line in an environment file should contain an environment
// variable in VARIABLE=VALUE format. Lines beginning with # are treated as
// comments and are ignored. If there are environment variables specified using the
// environment parameter in a container definition, they take precedence over the
// variables contained within an environment file. If multiple environment files
// are specified that contain the same variable, they're processed from the top
// down. We recommend that you use unique variable names. For more information, see
// Specifying environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)
// in the Amazon Elastic Container Service Developer Guide. You must use the
// following platforms for the Fargate launch type:
// - Linux platform version 1.4.0 or later.
// - Windows platform version 1.0.0 or later.
//
// Consider the following when using the Fargate launch type:
// - The file is handled like a native Docker env-file.
// - There is no support for shell escape handling.
// - The container entry point interperts the VARIABLE values.
type EnvironmentFile struct {
// The file type to use. The only supported value is s3 .
//
// This member is required.
Type EnvironmentFileType
// The Amazon Resource Name (ARN) of the Amazon S3 object containing the
// environment variable file.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// The amount of ephemeral storage to allocate for the task. This parameter is
// used to expand the total amount of ephemeral storage available, beyond the
// default amount, for tasks hosted on Fargate. For more information, see Fargate
// task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html)
// in the Amazon ECS User Guide for Fargate. For tasks using the Fargate launch
// type, the task requires the following platforms:
// - Linux platform version 1.4.0 or later.
// - Windows platform version 1.0.0 or later.
type EphemeralStorage struct {
// The total amount, in GiB, of ephemeral storage to set for the task. The minimum
// supported value is 21 GiB and the maximum supported value is 200 GiB.
//
// This member is required.
SizeInGiB int32
noSmithyDocumentSerde
}
// The details of the execute command configuration.
type ExecuteCommandConfiguration struct {
// Specify an Key Management Service key ID to encrypt the data between the local
// client and the container.
KmsKeyId *string
// The log configuration for the results of the execute command actions. The logs
// can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is
// specified, a logConfiguration must be provided.
LogConfiguration *ExecuteCommandLogConfiguration
// The log setting to use for redirecting logs for your execute command results.
// The following log settings are available.
// - NONE : The execute command session is not logged.
// - DEFAULT : The awslogs configuration in the task definition is used. If no
// logging parameter is specified, it defaults to this value. If no awslogs log
// driver is configured in the task definition, the output won't be logged.
// - OVERRIDE : Specify the logging details as a part of logConfiguration . If
// the OVERRIDE logging option is specified, the logConfiguration is required.
Logging ExecuteCommandLogging
noSmithyDocumentSerde
}
// The log configuration for the results of the execute command actions. The logs
// can be sent to CloudWatch Logs or an Amazon S3 bucket.
type ExecuteCommandLogConfiguration struct {
// Determines whether to use encryption on the CloudWatch logs. If not specified,
// encryption will be off.
CloudWatchEncryptionEnabled bool
// The name of the CloudWatch log group to send logs to. The CloudWatch log group
// must already be created.
CloudWatchLogGroupName *string
// The name of the S3 bucket to send logs to. The S3 bucket must already be
// created.
S3BucketName *string
// Determines whether to use encryption on the S3 logs. If not specified,
// encryption is not used.
S3EncryptionEnabled bool
// An optional folder in the S3 bucket to place logs in.
S3KeyPrefix *string
noSmithyDocumentSerde
}
// A failed resource. For a list of common causes, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html)
// in the Amazon Elastic Container Service Developer Guide.
type Failure struct {
// The Amazon Resource Name (ARN) of the failed resource.
Arn *string
// The details of the failure.
Detail *string
// The reason for the failure.
Reason *string
noSmithyDocumentSerde
}
// The FireLens configuration for the container. This is used to specify and
// configure a log router for container logs. For more information, see Custom log
// routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
// in the Amazon Elastic Container Service Developer Guide.
type FirelensConfiguration struct {
// The log router to use. The valid values are fluentd or fluentbit .
//
// This member is required.
Type FirelensConfigurationType
// The options to use when configuring the log router. This field is optional and
// can be used to specify a custom configuration file or to add additional
// metadata, such as the task, task definition, cluster, and container instance
// details to the log event. If specified, the syntax to use is
// "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
// . For more information, see Creating a task definition that uses a FireLens
// configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef)
// in the Amazon Elastic Container Service Developer Guide. Tasks hosted on Fargate
// only support the file configuration file type.
Options map[string]string
noSmithyDocumentSerde
}
// The authorization configuration details for Amazon FSx for Windows File Server
// file system. See FSxWindowsFileServerVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html)
// in the Amazon ECS API Reference. For more information and the input format, see
// Amazon FSx for Windows File Server Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html)
// in the Amazon Elastic Container Service Developer Guide.
type FSxWindowsFileServerAuthorizationConfig struct {
// The authorization credential option to use. The authorization credential
// options can be provided using either the Amazon Resource Name (ARN) of an
// Secrets Manager secret or SSM Parameter Store parameter. The ARN refers to the
// stored credentials.
//
// This member is required.
CredentialsParameter *string
// A fully qualified domain name hosted by an Directory Service (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html)
// Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
//
// This member is required.
Domain *string
noSmithyDocumentSerde
}
// This parameter is specified when you're using Amazon FSx for Windows File Server (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html)
// file system for task storage. For more information and the input format, see
// Amazon FSx for Windows File Server volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html)
// in the Amazon Elastic Container Service Developer Guide.
type FSxWindowsFileServerVolumeConfiguration struct {
// The authorization configuration details for the Amazon FSx for Windows File
// Server file system.
//
// This member is required.
AuthorizationConfig *FSxWindowsFileServerAuthorizationConfig
// The Amazon FSx for Windows File Server file system ID to use.
//
// This member is required.
FileSystemId *string
// The directory within the Amazon FSx for Windows File Server file system to
// mount as the root directory inside the host.
//
// This member is required.
RootDirectory *string
noSmithyDocumentSerde
}
// An object representing a container health check. Health check parameters that
// are specified in a container definition override any Docker health checks that
// exist in the container image (such as those specified in a parent image or from
// the image's Dockerfile). This configuration maps to the HEALTHCHECK parameter
// of docker run (https://docs.docker.com/engine/reference/run/) . The Amazon ECS
// container agent only monitors and reports on the health checks specified in the
// task definition. Amazon ECS does not monitor Docker health checks that are
// embedded in a container image and not specified in the container definition.
// Health check parameters that are specified in a container definition override
// any Docker health checks that exist in the container image. You can view the
// health status of both individual containers and a task with the DescribeTasks
// API operation or when viewing the task details in the console. The health check
// is designed to make sure that your containers survive agent restarts, upgrades,
// or temporary unavailability. The following describes the possible healthStatus
// values for a container:
// - HEALTHY -The container health check has passed successfully.
// - UNHEALTHY -The container health check has failed.
// - UNKNOWN -The container health check is being evaluated, there's no container
// health check defined, or Amazon ECS doesn't have the health status of the
// container.
//
// The following describes the possible healthStatus values based on the container
// health checker status of essential containers in the task with the following
// priority order (high to low):
// - UNHEALTHY -One or more essential containers have failed their health check.
// - UNKNOWN -Any essential container running within the task is in an UNKNOWN
// state and no other essential containers have an UNHEALTHY state.
// - HEALTHY -All essential containers within the task have passed their health
// checks.
//
// Consider the following task health example with 2 containers.
// - If Container1 is UNHEALTHY and Container2 is UNKNOWN , the task health is
// UNHEALTHY .
// - If Container1 is UNHEALTHY and Container2 is HEALTHY , the task health is
// UNHEALTHY .
// - If Container1 is HEALTHY and Container2 is UNKNOWN , the task health is
// UNKNOWN .
// - If Container1 is HEALTHY and Container2 is HEALTHY , the task health is
// HEALTHY .
//
// Consider the following task health example with 3 containers.
// - If Container1 is UNHEALTHY and Container2 is UNKNOWN , and Container3 is
// UNKNOWN , the task health is UNHEALTHY .
// - If Container1 is UNHEALTHY and Container2 is UNKNOWN , and Container3 is
// HEALTHY , the task health is UNHEALTHY .
// - If Container1 is UNHEALTHY and Container2 is HEALTHY , and Container3 is
// HEALTHY , the task health is UNHEALTHY .
// - If Container1 is HEALTHY and Container2 is UNKNOWN , and Container3 is
// HEALTHY , the task health is UNKNOWN .
// - If Container1 is HEALTHY and Container2 is UNKNOWN , and Container3 is
// UNKNOWN , the task health is UNKNOWN .
// - If Container1 is HEALTHY and Container2 is HEALTHY , and Container3 is
// HEALTHY , the task health is HEALTHY .
//
// If a task is run manually, and not as part of a service, the task will continue
// its lifecycle regardless of its health status. For tasks that are part of a
// service, if the task reports as unhealthy then the task will be stopped and the
// service scheduler will replace it. The following are notes about container
// health check support:
// - When the Amazon ECS agent cannot connect to the Amazon ECS service, the
// service reports the container as UNHEALTHY .
// - The health check statuses are the "last heard from" response from the
// Amazon ECS agent. There are no assumptions made about the status of the
// container health checks.
// - Container health checks require version 1.17.0 or greater of the Amazon ECS
// container agent. For more information, see Updating the Amazon ECS container
// agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)
// .
// - Container health checks are supported for Fargate tasks if you're using
// platform version 1.1.0 or greater. For more information, see Fargate platform
// versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// .
// - Container health checks aren't supported for tasks that are part of a
// service that's configured to use a Classic Load Balancer.
type HealthCheck struct {
// A string array representing the command that the container runs to determine if
// it is healthy. The string array must start with CMD to run the command
// arguments directly, or CMD-SHELL to run the command with the container's
// default shell. When you use the Amazon Web Services Management Console JSON
// panel, the Command Line Interface, or the APIs, enclose the list of commands in
// double quotes and brackets. [ "CMD-SHELL", "curl -f http://localhost/ || exit
// 1" ] You don't include the double quotes and brackets when you use the Amazon
// Web Services Management Console. CMD-SHELL, curl -f http://localhost/ || exit 1
// An exit code of 0 indicates success, and non-zero exit code indicates failure.
// For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/) .
//
// This member is required.
Command []string
// The time period in seconds between each health check execution. You may specify
// between 5 and 300 seconds. The default value is 30 seconds.
Interval *int32
// The number of times to retry a failed health check before the container is
// considered unhealthy. You may specify between 1 and 10 retries. The default
// value is 3.
Retries *int32
// The optional grace period to provide containers time to bootstrap before failed
// health checks count towards the maximum number of retries. You can specify
// between 0 and 300 seconds. By default, the startPeriod is off. If a health
// check succeeds within the startPeriod , then the container is considered healthy
// and any subsequent failures count toward the maximum number of retries.
StartPeriod *int32
// The time period in seconds to wait for a health check to succeed before it is
// considered a failure. You may specify between 2 and 60 seconds. The default
// value is 5.
Timeout *int32
noSmithyDocumentSerde
}
// Hostnames and IP address entries that are added to the /etc/hosts file of a
// container via the extraHosts parameter of its ContainerDefinition .
type HostEntry struct {
// The hostname to use in the /etc/hosts entry.
//
// This member is required.
Hostname *string
// The IP address to use in the /etc/hosts entry.
//
// This member is required.
IpAddress *string
noSmithyDocumentSerde
}
// Details on a container instance bind mount host volume.
type HostVolumeProperties struct {
// When the host parameter is used, specify a sourcePath to declare the path on
// the host container instance that's presented to the container. If this parameter
// is empty, then the Docker daemon has assigned a host path for you. If the host
// parameter contains a sourcePath file location, then the data volume persists at
// the specified location on the host container instance until you delete it
// manually. If the sourcePath value doesn't exist on the host container instance,
// the Docker daemon creates it. If the location does exist, the contents of the
// source path folder are exported. If you're using the Fargate launch type, the
// sourcePath parameter is not supported.
SourcePath *string
noSmithyDocumentSerde
}
// Details on an Elastic Inference accelerator. For more information, see Working
// with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)
// in the Amazon Elastic Container Service Developer Guide.
type InferenceAccelerator struct {
// The Elastic Inference accelerator device name. The deviceName must also be
// referenced in a container definition as a ResourceRequirement (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html)
// .
//
// This member is required.
DeviceName *string
// The Elastic Inference accelerator type to use.
//
// This member is required.
DeviceType *string
noSmithyDocumentSerde
}
// Details on an Elastic Inference accelerator task override. This parameter is
// used to override the Elastic Inference accelerator specified in the task
// definition. For more information, see Working with Amazon Elastic Inference on
// Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)
// in the Amazon Elastic Container Service Developer Guide.
type InferenceAcceleratorOverride struct {
// The Elastic Inference accelerator device name to override for the task. This
// parameter must match a deviceName specified in the task definition.
DeviceName *string
// The Elastic Inference accelerator type to use.
DeviceType *string
noSmithyDocumentSerde
}
// An object representing the result of a container instance health status check.
type InstanceHealthCheckResult struct {
// The Unix timestamp for when the container instance health status last changed.
LastStatusChange *time.Time
// The Unix timestamp for when the container instance health status was last
// updated.
LastUpdated *time.Time
// The container instance health status.
Status InstanceHealthCheckState
// The type of container instance health status that was verified.
Type InstanceHealthCheckType
noSmithyDocumentSerde
}
// The Linux capabilities for the container that are added to or dropped from the
// default configuration provided by Docker. For more information about the default
// capabilities and the non-default available capabilities, see Runtime privilege
// and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities)
// in the Docker run reference. For more detailed information about these Linux
// capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html)
// Linux manual page.
type KernelCapabilities struct {
// The Linux capabilities for the container that have been added to the default
// configuration provided by Docker. This parameter maps to CapAdd in the Create a
// container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --cap-add option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . Tasks launched on Fargate only support adding the SYS_PTRACE kernel
// capability. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" |
// "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" |
// "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" |
// "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" |
// "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" |
// "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" |
// "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" |
// "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
Add []string
// The Linux capabilities for the container that have been removed from the
// default configuration provided by Docker. This parameter maps to CapDrop in the
// Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --cap-drop option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" |
// "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK"
// | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" |
// "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" |
// "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" |
// "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" |
// "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" |
// "SYSLOG" | "WAKE_ALARM"
Drop []string
noSmithyDocumentSerde
}
// A key-value pair object.
type KeyValuePair struct {
// The name of the key-value pair. For environment variables, this is the name of
// the environment variable.
Name *string
// The value of the key-value pair. For environment variables, this is the value
// of the environment variable.
Value *string
noSmithyDocumentSerde
}
// The Linux-specific options that are applied to the container, such as Linux
// KernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html)
// .
type LinuxParameters struct {
// The Linux capabilities for the container that are added to or dropped from the
// default configuration provided by Docker. For tasks that use the Fargate launch
// type, capabilities is supported for all platform versions but the add parameter
// is only supported if using platform version 1.4.0 or later.
Capabilities *KernelCapabilities
// Any host devices to expose to the container. This parameter maps to Devices in
// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --device option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If you're using tasks that use the Fargate launch type, the devices parameter
// isn't supported.
Devices []Device
// Run an init process inside the container that forwards signals and reaps
// processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . This parameter requires version 1.25 of the Docker Remote API or greater on
// your container instance. To check the Docker Remote API version on your
// container instance, log in to your container instance and run the following
// command: sudo docker version --format '{{.Server.APIVersion}}'
InitProcessEnabled *bool
// The total amount of swap memory (in MiB) a container can use. This parameter
// will be translated to the --memory-swap option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// where the value would be the sum of the container memory plus the maxSwap
// value. If a maxSwap value of 0 is specified, the container will not use swap.
// Accepted values are 0 or any positive integer. If the maxSwap parameter is
// omitted, the container will use the swap configuration for the container
// instance it is running on. A maxSwap value must be set for the swappiness
// parameter to be used. If you're using tasks that use the Fargate launch type,
// the maxSwap parameter isn't supported. If you're using tasks on Amazon Linux
// 2023 the swappiness parameter isn't supported.
MaxSwap *int32
// The value for the size (in MiB) of the /dev/shm volume. This parameter maps to
// the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If you are using tasks that use the Fargate launch type, the sharedMemorySize
// parameter is not supported.
SharedMemorySize *int32
// This allows you to tune a container's memory swappiness behavior. A swappiness
// value of 0 will cause swapping to not happen unless absolutely necessary. A
// swappiness value of 100 will cause pages to be swapped very aggressively.
// Accepted values are whole numbers between 0 and 100 . If the swappiness
// parameter is not specified, a default value of 60 is used. If a value is not
// specified for maxSwap then this parameter is ignored. This parameter maps to
// the --memory-swappiness option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If you're using tasks that use the Fargate launch type, the swappiness
// parameter isn't supported. If you're using tasks on Amazon Linux 2023 the
// swappiness parameter isn't supported.
Swappiness *int32
// The container path, mount options, and size (in MiB) of the tmpfs mount. This
// parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . If you're using tasks that use the Fargate launch type, the tmpfs parameter
// isn't supported.
Tmpfs []Tmpfs
noSmithyDocumentSerde
}
// The load balancer configuration to use with a service or task set. When you
// add, update, or remove a load balancer configuration, Amazon ECS starts a new
// deployment with the updated Elastic Load Balancing configuration. This causes
// tasks to register to and deregister from load balancers. We recommend that you
// verify this on a test environment before you update the Elastic Load Balancing
// configuration. A service-linked role is required for services that use multiple
// target groups. For more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)
// in the Amazon Elastic Container Service Developer Guide.
type LoadBalancer struct {
// The name of the container (as it appears in a container definition) to
// associate with the load balancer.
ContainerName *string
// The port on the container to associate with the load balancer. This port must
// correspond to a containerPort in the task definition the tasks in the service
// are using. For tasks that use the EC2 launch type, the container instance
// they're launched on must allow ingress traffic on the hostPort of the port
// mapping.
ContainerPort *int32
// The name of the load balancer to associate with the Amazon ECS service or task
// set. If you are using an Application Load Balancer or a Network Load Balancer
// the load balancer name parameter should be omitted.
LoadBalancerName *string
// The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group
// or groups associated with a service or task set. A target group ARN is only
// specified when using an Application Load Balancer or Network Load Balancer. For
// services using the ECS deployment controller, you can specify one or multiple
// target groups. For more information, see Registering multiple target groups
// with a service (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html)
// in the Amazon Elastic Container Service Developer Guide. For services using the
// CODE_DEPLOY deployment controller, you're required to define two target groups
// for the load balancer. For more information, see Blue/green deployment with
// CodeDeploy (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html)
// in the Amazon Elastic Container Service Developer Guide. If your service's task
// definition uses the awsvpc network mode, you must choose ip as the target type,
// not instance . Do this when creating your target groups because tasks that use
// the awsvpc network mode are associated with an elastic network interface, not
// an Amazon EC2 instance. This network mode is required for the Fargate launch
// type.
TargetGroupArn *string
noSmithyDocumentSerde
}
// The log configuration for the container. This parameter maps to LogConfig in
// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/)
// . By default, containers use the same logging driver that the Docker daemon
// uses. However, the container might use a different logging driver than the
// Docker daemon by specifying a log driver configuration in the container
// definition. For more information about the options for different supported log
// drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
// in the Docker documentation. Understand the following when specifying a log
// configuration for your containers.
// - Amazon ECS currently supports a subset of the logging drivers available to
// the Docker daemon. Additional log drivers may be available in future releases of
// the Amazon ECS container agent. For tasks on Fargate, the supported log drivers
// are awslogs , splunk , and awsfirelens . For tasks hosted on Amazon EC2
// instances, the supported log drivers are awslogs , fluentd , gelf , json-file
// , journald , logentries , syslog , splunk , and awsfirelens .
// - This parameter requires version 1.18 of the Docker Remote API or greater on
// your container instance.
// - For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container
// agent must register the available logging drivers with the
// ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on
// that instance can use these log configuration options. For more information, see
// Amazon ECS container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
// in the Amazon Elastic Container Service Developer Guide.
// - For tasks that are on Fargate, because you don't have access to the
// underlying infrastructure your tasks are hosted on, any additional software
// needed must be installed outside of the task. For example, the Fluentd output
// aggregators or a remote host running Logstash to send Gelf logs to.
type LogConfiguration struct {
// The log driver to use for the container. For tasks on Fargate, the supported
// log drivers are awslogs , splunk , and awsfirelens . For tasks hosted on Amazon
// EC2 instances, the supported log drivers are awslogs , fluentd , gelf ,
// json-file , journald , logentries , syslog , splunk , and awsfirelens . For more
// information about using the awslogs log driver, see Using the awslogs log driver (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)
// in the Amazon Elastic Container Service Developer Guide. For more information
// about using the awsfirelens log driver, see Custom log routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)
// in the Amazon Elastic Container Service Developer Guide. If you have a custom
// driver that isn't listed, you can fork the Amazon ECS container agent project
// that's available on GitHub (https://github.com/aws/amazon-ecs-agent) and
// customize it to work with that driver. We encourage you to submit pull requests
// for changes that you would like to have included. However, we don't currently
// provide support for running modified copies of this software.
//
// This member is required.
LogDriver LogDriver
// The configuration options to send to the log driver. This parameter requires
// version 1.19 of the Docker Remote API or greater on your container instance. To
// check the Docker Remote API version on your container instance, log in to your
// container instance and run the following command: sudo docker version --format
// '{{.Server.APIVersion}}'
Options map[string]string
// The secrets to pass to the log configuration. For more information, see
// Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)
// in the Amazon Elastic Container Service Developer Guide.
SecretOptions []Secret
noSmithyDocumentSerde
}
// Details about the managed agent status for the container.
type ManagedAgent struct {
// The Unix timestamp for the time when the managed agent was last started.
LastStartedAt *time.Time
// The last known status of the managed agent.
LastStatus *string
// The name of the managed agent. When the execute command feature is turned on,
// the managed agent name is ExecuteCommandAgent .
Name ManagedAgentName
// The reason for why the managed agent is in the state it is in.
Reason *string
noSmithyDocumentSerde
}
// An object representing a change in state for a managed agent.
type ManagedAgentStateChange struct {
// The name of the container that's associated with the managed agent.
//
// This member is required.
ContainerName *string
// The name of the managed agent.
//
// This member is required.
ManagedAgentName ManagedAgentName
// The status of the managed agent.
//
// This member is required.
Status *string
// The reason for the status of the managed agent.
Reason *string
noSmithyDocumentSerde
}
// The managed scaling settings for the Auto Scaling group capacity provider. When
// managed scaling is turned on, Amazon ECS manages the scale-in and scale-out
// actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling
// policy using an Amazon ECS managed CloudWatch metric with the specified
// targetCapacity value as the target value for the metric. For more information,
// see Using managed scaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html#asg-capacity-providers-managed-scaling)
// in the Amazon Elastic Container Service Developer Guide. If managed scaling is
// off, the user must manage the scaling of the Auto Scaling group.
type ManagedScaling struct {
// The period of time, in seconds, after a newly launched Amazon EC2 instance can
// contribute to CloudWatch metrics for Auto Scaling group. If this parameter is
// omitted, the default value of 300 seconds is used.
InstanceWarmupPeriod *int32
// The maximum number of Amazon EC2 instances that Amazon ECS will scale out at
// one time. The scale in process is not affected by this parameter. If this
// parameter is omitted, the default value of 10000 is used.
MaximumScalingStepSize *int32
// The minimum number of Amazon EC2 instances that Amazon ECS will scale out at
// one time. The scale in process is not affected by this parameter If this
// parameter is omitted, the default value of 1 is used. When additional capacity
// is required, Amazon ECS will scale up the minimum scaling step size even if the
// actual demand is less than the minimum scaling step size. If you use a capacity
// provider with an Auto Scaling group configured with more than one Amazon EC2
// instance type or Availability Zone, Amazon ECS will scale up by the exact
// minimum scaling step size value and will ignore both the maximum scaling step
// size as well as the capacity demand.
MinimumScalingStepSize *int32
// Determines whether to use managed scaling for the capacity provider.
Status ManagedScalingStatus
// The target capacity utilization as a percentage for the capacity provider. The
// specified value must be greater than 0 and less than or equal to 100 . For
// example, if you want the capacity provider to maintain 10% spare capacity, then
// that means the utilization is 90%, so use a targetCapacity of 90 . The default
// value of 100 percent results in the Amazon EC2 instances in your Auto Scaling
// group being completely used.
TargetCapacity *int32
noSmithyDocumentSerde
}
// The details for a volume mount point that's used in a container definition.
type MountPoint struct {
// The path on the container to mount the host volume at.
ContainerPath *string
// If this value is true , the container has read-only access to the volume. If
// this value is false , then the container can write to the volume. The default
// value is false .
ReadOnly *bool
// The name of the volume to mount. Must be a volume name referenced in the name
// parameter of task definition volume .
SourceVolume *string
noSmithyDocumentSerde
}
// Details on the network bindings between a container and its host container
// instance. After a task reaches the RUNNING status, manual and automatic host
// and container port assignments are visible in the networkBindings section of
// DescribeTasks API responses.
type NetworkBinding struct {
// The IP address that the container is bound to on the container instance.
BindIP *string
// The port number on the container that's used with the network binding.
ContainerPort *int32
// The port number range on the container that's bound to the dynamically mapped
// host port range. The following rules apply when you specify a containerPortRange
// :
// - You must use either the bridge network mode or the awsvpc network mode.
// - This parameter is available for both the EC2 and Fargate launch types.
// - This parameter is available for both the Linux and Windows operating
// systems.
// - The container instance must have at least version 1.67.0 of the container
// agent and at least version 1.67.0-1 of the ecs-init package
// - You can specify a maximum of 100 port ranges per container.
// - You do not specify a hostPortRange . The value of the hostPortRange is set
// as follows:
// - For containers in a task with the awsvpc network mode, the hostPortRange is
// set to the same value as the containerPortRange . This is a static mapping
// strategy.
// - For containers in a task with the bridge network mode, the Amazon ECS agent
// finds open host ports from the default ephemeral range and passes it to docker
// to bind them to the container ports.
// - The containerPortRange valid values are between 1 and 65535.
// - A port can only be included in one port mapping per container.
// - You cannot specify overlapping port ranges.
// - The first port in the range must be less than last port in the range.
// - Docker recommends that you turn off the docker-proxy in the Docker daemon
// config file when you have a large number of ports. For more information, see
// Issue #11185 (https://github.com/moby/moby/issues/11185) on the Github
// website. For information about how to turn off the docker-proxy in the Docker
// daemon config file, see Docker daemon (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon)
// in the Amazon ECS Developer Guide.
// You can call DescribeTasks (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html)
// to view the hostPortRange which are the host ports that are bound to the
// container ports.
ContainerPortRange *string
// The port number on the host that's used with the network binding.
HostPort *int32
// The port number range on the host that's used with the network binding. This is
// assigned is assigned by Docker and delivered by the Amazon ECS agent.
HostPortRange *string
// The protocol used for the network binding.
Protocol TransportProtocol
noSmithyDocumentSerde
}
// The network configuration for a task or service.
type NetworkConfiguration struct {
// The VPC subnets and security groups that are associated with a task. All
// specified subnets and security groups must be from the same VPC.
AwsvpcConfiguration *AwsVpcConfiguration
noSmithyDocumentSerde
}
// An object representing the elastic network interface for tasks that use the
// awsvpc network mode.
type NetworkInterface struct {
// The attachment ID for the network interface.
AttachmentId *string
// The private IPv6 address for the network interface.
Ipv6Address *string
// The private IPv4 address for the network interface.
PrivateIpv4Address *string
noSmithyDocumentSerde
}
// An object representing a constraint on task placement. For more information,
// see Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)
// in the Amazon Elastic Container Service Developer Guide. If you're using the
// Fargate launch type, task placement constraints aren't supported.
type PlacementConstraint struct {
// A cluster query language expression to apply to the constraint. The expression
// can have a maximum length of 2000 characters. You can't specify an expression if
// the constraint type is distinctInstance . For more information, see Cluster
// query language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html)
// in the Amazon Elastic Container Service Developer Guide.
Expression *string
// The type of constraint. Use distinctInstance to ensure that each task in a
// particular group is running on a different container instance. Use memberOf to
// restrict the selection to a group of valid candidates.
Type PlacementConstraintType
noSmithyDocumentSerde
}
// The task placement strategy for a task or service. For more information, see
// Task placement strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)
// in the Amazon Elastic Container Service Developer Guide.
type PlacementStrategy struct {
// The field to apply the placement strategy against. For the spread placement
// strategy, valid values are instanceId (or host , which has the same effect), or
// any platform or custom attribute that's applied to a container instance, such as
// attribute:ecs.availability-zone . For the binpack placement strategy, valid
// values are cpu and memory . For the random placement strategy, this field is
// not used.
Field *string
// The type of placement strategy. The random placement strategy randomly places
// tasks on available candidates. The spread placement strategy spreads placement
// across available candidates evenly based on the field parameter. The binpack
// strategy places tasks on available candidates that have the least available
// amount of the resource that's specified with the field parameter. For example,
// if you binpack on memory, a task is placed on the instance with the least amount
// of remaining memory but still enough to run the task.
Type PlacementStrategyType
noSmithyDocumentSerde
}
// The devices that are available on the container instance. The only supported
// device type is a GPU.
type PlatformDevice struct {
// The ID for the GPUs on the container instance. The available GPU IDs can also
// be obtained on the container instance in the
// /var/lib/ecs/gpu/nvidia_gpu_info.json file.
//
// This member is required.
Id *string
// The type of device that's available on the container instance. The only
// supported value is GPU .
//
// This member is required.
Type PlatformDeviceType
noSmithyDocumentSerde
}
// Port mappings allow containers to access ports on the host container instance
// to send or receive traffic. Port mappings are specified as part of the container
// definition. If you use containers in a task with the awsvpc or host network
// mode, specify the exposed ports using containerPort . The hostPort can be left
// blank or it must be the same value as the containerPort . Most fields of this
// parameter ( containerPort , hostPort , protocol ) maps to PortBindings in the
// Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --publish option to docker run (https://docs.docker.com/engine/reference/commandline/run/)
// . If the network mode of a task definition is set to host , host ports must
// either be undefined or match the container port in the port mapping. You can't
// expose the same container port for multiple protocols. If you attempt this, an
// error is returned. After a task reaches the RUNNING status, manual and
// automatic host and container port assignments are visible in the networkBindings
// section of DescribeTasks API responses.
type PortMapping struct {
// The application protocol that's used for the port mapping. This parameter only
// applies to Service Connect. We recommend that you set this parameter to be
// consistent with the protocol that your application uses. If you set this
// parameter, Amazon ECS adds protocol-specific connection handling to the Service
// Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific
// telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for
// this parameter, then TCP is used. However, Amazon ECS doesn't add
// protocol-specific telemetry for TCP. appProtocol is immutable in a Service
// Connect service. Updating this field requires a service deletion and
// redeployment. Tasks that run in a namespace can use short names to connect to
// services in the namespace. Tasks can connect to services across all of the
// clusters in the namespace. Tasks connect through a managed proxy container that
// collects logs and metrics for increased visibility. Only the tasks that Amazon
// ECS services create are supported with Service Connect. For more information,
// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
AppProtocol ApplicationProtocol
// The port number on the container that's bound to the user-specified or
// automatically assigned host port. If you use containers in a task with the
// awsvpc or host network mode, specify the exposed ports using containerPort . If
// you use containers in a task with the bridge network mode and you specify a
// container port and not a host port, your container automatically receives a host
// port in the ephemeral port range. For more information, see hostPort . Port
// mappings that are automatically assigned in this way do not count toward the 100
// reserved ports limit of a container instance.
ContainerPort *int32
// The port number range on the container that's bound to the dynamically mapped
// host port range. The following rules apply when you specify a containerPortRange
// :
// - You must use either the bridge network mode or the awsvpc network mode.
// - This parameter is available for both the EC2 and Fargate launch types.
// - This parameter is available for both the Linux and Windows operating
// systems.
// - The container instance must have at least version 1.67.0 of the container
// agent and at least version 1.67.0-1 of the ecs-init package
// - You can specify a maximum of 100 port ranges per container.
// - You do not specify a hostPortRange . The value of the hostPortRange is set
// as follows:
// - For containers in a task with the awsvpc network mode, the hostPortRange is
// set to the same value as the containerPortRange . This is a static mapping
// strategy.
// - For containers in a task with the bridge network mode, the Amazon ECS agent
// finds open host ports from the default ephemeral range and passes it to docker
// to bind them to the container ports.
// - The containerPortRange valid values are between 1 and 65535.
// - A port can only be included in one port mapping per container.
// - You cannot specify overlapping port ranges.
// - The first port in the range must be less than last port in the range.
// - Docker recommends that you turn off the docker-proxy in the Docker daemon
// config file when you have a large number of ports. For more information, see
// Issue #11185 (https://github.com/moby/moby/issues/11185) on the Github
// website. For information about how to turn off the docker-proxy in the Docker
// daemon config file, see Docker daemon (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon)
// in the Amazon ECS Developer Guide.
// You can call DescribeTasks (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html)
// to view the hostPortRange which are the host ports that are bound to the
// container ports.
ContainerPortRange *string
// The port number on the container instance to reserve for your container. If you
// specify a containerPortRange , leave this field empty and the value of the
// hostPort is set as follows:
// - For containers in a task with the awsvpc network mode, the hostPort is set
// to the same value as the containerPort . This is a static mapping strategy.
// - For containers in a task with the bridge network mode, the Amazon ECS agent
// finds open ports on the host and automatically binds them to the container
// ports. This is a dynamic mapping strategy.
// If you use containers in a task with the awsvpc or host network mode, the
// hostPort can either be left blank or set to the same value as the containerPort
// . If you use containers in a task with the bridge network mode, you can specify
// a non-reserved host port for your container port mapping, or you can omit the
// hostPort (or set it to 0 ) while specifying a containerPort and your container
// automatically receives a port in the ephemeral port range for your container
// instance operating system and Docker version. The default ephemeral port range
// for Docker version 1.6.0 and later is listed on the instance under
// /proc/sys/net/ipv4/ip_local_port_range . If this kernel parameter is
// unavailable, the default ephemeral port range from 49153 through 65535 (Linux)
// or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port
// in the ephemeral port range as these are reserved for automatic assignment. In
// general, ports below 32768 are outside of the ephemeral port range. The default
// reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon
// ECS container agent ports 51678-51680. Any host port that was previously
// specified in a running task is also reserved while the task is running. That is,
// after a task stops, the host port is released. The current reserved ports are
// displayed in the remainingResources of DescribeContainerInstances (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html)
// output. A container instance can have up to 100 reserved ports at a time. This
// number includes the default reserved ports. Automatically assigned ports aren't
// included in the 100 reserved ports quota.
HostPort *int32
// The name that's used for the port mapping. This parameter only applies to
// Service Connect. This parameter is the name that you use in the
// serviceConnectConfiguration of a service. The name can include up to 64
// characters. The characters can include lowercase letters, numbers, underscores
// (_), and hyphens (-). The name can't start with a hyphen. For more information,
// see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
Name *string
// The protocol used for the port mapping. Valid values are tcp and udp . The
// default is tcp . protocol is immutable in a Service Connect service. Updating
// this field requires a service deletion and redeployment.
Protocol TransportProtocol
noSmithyDocumentSerde
}
// An object representing the protection status details for a task. You can set
// the protection status with the UpdateTaskProtection API and get the status of
// tasks with the GetTaskProtection API.
type ProtectedTask struct {
// The epoch time when protection for the task will expire.
ExpirationDate *time.Time
// The protection status of the task. If scale-in protection is on for a task, the
// value is true . Otherwise, it is false .
ProtectionEnabled bool
// The task ARN.
TaskArn *string
noSmithyDocumentSerde
}
// The configuration details for the App Mesh proxy. For tasks that use the EC2
// launch type, the container instances require at least version 1.26.0 of the
// container agent and at least version 1.26.0-1 of the ecs-init package to use a
// proxy configuration. If your container instances are launched from the Amazon
// ECS optimized AMI version 20190301 or later, then they contain the required
// versions of the container agent and ecs-init . For more information, see Amazon
// ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
type ProxyConfiguration struct {
// The name of the container that will serve as the App Mesh proxy.
//
// This member is required.
ContainerName *string
// The set of network configuration parameters to provide the Container Network
// Interface (CNI) plugin, specified as key-value pairs.
// - IgnoredUID - (Required) The user ID (UID) of the proxy container as defined
// by the user parameter in a container definition. This is used to ensure the
// proxy ignores its own traffic. If IgnoredGID is specified, this field can be
// empty.
// - IgnoredGID - (Required) The group ID (GID) of the proxy container as defined
// by the user parameter in a container definition. This is used to ensure the
// proxy ignores its own traffic. If IgnoredUID is specified, this field can be
// empty.
// - AppPorts - (Required) The list of ports that the application uses. Network
// traffic to these ports is forwarded to the ProxyIngressPort and
// ProxyEgressPort .
// - ProxyIngressPort - (Required) Specifies the port that incoming traffic to
// the AppPorts is directed to.
// - ProxyEgressPort - (Required) Specifies the port that outgoing traffic from
// the AppPorts is directed to.
// - EgressIgnoredPorts - (Required) The egress traffic going to the specified
// ports is ignored and not redirected to the ProxyEgressPort . It can be an
// empty list.
// - EgressIgnoredIPs - (Required) The egress traffic going to the specified IP
// addresses is ignored and not redirected to the ProxyEgressPort . It can be an
// empty list.
Properties []KeyValuePair
// The proxy type. The only supported value is APPMESH .
Type ProxyConfigurationType
noSmithyDocumentSerde
}
// The repository credentials for private registry authentication.
type RepositoryCredentials struct {
// The Amazon Resource Name (ARN) of the secret containing the private repository
// credentials. When you use the Amazon ECS API, CLI, or Amazon Web Services SDK,
// if the secret exists in the same Region as the task that you're launching then
// you can use either the full ARN or the name of the secret. When you use the
// Amazon Web Services Management Console, you must specify the full ARN of the
// secret.
//
// This member is required.
CredentialsParameter *string
noSmithyDocumentSerde
}
// Describes the resources available for a container instance.
type Resource struct {
// When the doubleValue type is set, the value of the resource must be a double
// precision floating-point type.
DoubleValue float64
// When the integerValue type is set, the value of the resource must be an integer.
IntegerValue int32
// When the longValue type is set, the value of the resource must be an extended
// precision floating-point type.
LongValue int64
// The name of the resource, such as CPU , MEMORY , PORTS , PORTS_UDP , or a
// user-defined resource.
Name *string
// When the stringSetValue type is set, the value of the resource must be a string
// type.
StringSetValue []string
// The type of the resource. Valid values: INTEGER , DOUBLE , LONG , or STRINGSET .
Type *string
noSmithyDocumentSerde
}
// The type and amount of a resource to assign to a container. The supported
// resource types are GPUs and Elastic Inference accelerators. For more
// information, see Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html)
// or Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)
// in the Amazon Elastic Container Service Developer Guide
type ResourceRequirement struct {
// The type of resource to assign to a container. The supported values are GPU or
// InferenceAccelerator .
//
// This member is required.
Type ResourceType
// The value for the specified resource type. If the GPU type is used, the value
// is the number of physical GPUs the Amazon ECS container agent reserves for the
// container. The number of GPUs that's reserved for all containers in a task can't
// exceed the number of available GPUs on the container instance that the task is
// launched on. If the InferenceAccelerator type is used, the value matches the
// deviceName for an InferenceAccelerator (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html)
// specified in a task definition.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Information about the platform for the Amazon ECS service or task. For more
// information about RuntimePlatform , see RuntimePlatform (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform)
// in the Amazon Elastic Container Service Developer Guide.
type RuntimePlatform struct {
// The CPU architecture. You can run your Linux tasks on an ARM-based platform by
// setting the value to ARM64 . This option is available for tasks that run on
// Linux Amazon EC2 instance or Linux containers on Fargate.
CpuArchitecture CPUArchitecture
// The operating system.
OperatingSystemFamily OSFamily
noSmithyDocumentSerde
}
// A floating-point percentage of the desired number of tasks to place and keep
// running in the task set.
type Scale struct {
// The unit of measure for the scale value.
Unit ScaleUnit
// The value, specified as a percent total of a service's desiredCount , to scale
// the task set. Accepted values are numbers between 0 and 100.
Value float64
noSmithyDocumentSerde
}
// An object representing the secret to expose to your container. Secrets can be
// exposed to a container in the following ways:
// - To inject sensitive data into your containers as environment variables, use
// the secrets container definition parameter.
// - To reference sensitive information in the log configuration of a container,
// use the secretOptions container definition parameter.
//
// For more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)
// in the Amazon Elastic Container Service Developer Guide.
type Secret struct {
// The name of the secret.
//
// This member is required.
Name *string
// The secret to expose to the container. The supported values are either the full
// ARN of the Secrets Manager secret or the full ARN of the parameter in the SSM
// Parameter Store. For information about the require Identity and Access
// Management permissions, see Required IAM permissions for Amazon ECS secrets (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam)
// (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html)
// (for Systems Manager Parameter store) in the Amazon Elastic Container Service
// Developer Guide. If the SSM Parameter Store parameter exists in the same Region
// as the task you're launching, then you can use either the full ARN or name of
// the parameter. If the parameter exists in a different Region, then the full ARN
// must be specified.
//
// This member is required.
ValueFrom *string
noSmithyDocumentSerde
}
// Details on a service within a cluster.
type Service struct {
// The capacity provider strategy the service uses. When using the
// DescribeServices API, this field is omitted if the service was created using a
// launch type.
CapacityProviderStrategy []CapacityProviderStrategyItem
// The Amazon Resource Name (ARN) of the cluster that hosts the service.
ClusterArn *string
// The Unix timestamp for the time when the service was created.
CreatedAt *time.Time
// The principal that created the service.
CreatedBy *string
// Optional deployment parameters that control how many tasks run during the
// deployment and the ordering of stopping and starting tasks.
DeploymentConfiguration *DeploymentConfiguration
// The deployment controller type the service is using.
DeploymentController *DeploymentController
// The current state of deployments for the service.
Deployments []Deployment
// The desired number of instantiations of the task definition to keep running on
// the service. This value is specified when the service is created with
// CreateService , and it can be modified with UpdateService .
DesiredCount int32
// Determines whether to use Amazon ECS managed tags for the tasks in the service.
// For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
// in the Amazon Elastic Container Service Developer Guide.
EnableECSManagedTags bool
// Determines whether the execute command functionality is turned on for the
// service. If true , the execute command functionality is turned on for all
// containers in tasks as part of the service.
EnableExecuteCommand bool
// The event stream for your service. A maximum of 100 of the latest events are
// displayed.
Events []ServiceEvent
// The period of time, in seconds, that the Amazon ECS service scheduler ignores
// unhealthy Elastic Load Balancing target health checks after a task has first
// started.
HealthCheckGracePeriodSeconds *int32
// The launch type the service is using. When using the DescribeServices API, this
// field is omitted if the service was created using a capacity provider strategy.
LaunchType LaunchType
// A list of Elastic Load Balancing load balancer objects. It contains the load
// balancer name, the container name, and the container port to access from the
// load balancer. The container name is as it appears in a container definition.
LoadBalancers []LoadBalancer
// The VPC subnet and security group configuration for tasks that receive their
// own elastic network interface by using the awsvpc networking mode.
NetworkConfiguration *NetworkConfiguration
// The number of tasks in the cluster that are in the PENDING state.
PendingCount int32
// The placement constraints for the tasks in the service.
PlacementConstraints []PlacementConstraint
// The placement strategy that determines how tasks for the service are placed.
PlacementStrategy []PlacementStrategy
// The operating system that your tasks in the service run on. A platform family
// is specified only for tasks using the Fargate launch type. All tasks that run as
// part of this service must use the same platformFamily value as the service (for
// example, LINUX ).
PlatformFamily *string
// The platform version to run your service on. A platform version is only
// specified for tasks that are hosted on Fargate. If one isn't specified, the
// LATEST platform version is used. For more information, see Fargate Platform
// Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// in the Amazon Elastic Container Service Developer Guide.
PlatformVersion *string
// Determines whether to propagate the tags from the task definition or the
// service to the task. If no value is specified, the tags aren't propagated.
PropagateTags PropagateTags
// The ARN of the IAM role that's associated with the service. It allows the
// Amazon ECS container agent to register container instances with an Elastic Load
// Balancing load balancer.
RoleArn *string
// The number of tasks in the cluster that are in the RUNNING state.
RunningCount int32
// The scheduling strategy to use for the service. For more information, see
// Services (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)
// . There are two service scheduler strategies available.
// - REPLICA -The replica scheduling strategy places and maintains the desired
// number of tasks across your cluster. By default, the service scheduler spreads
// tasks across Availability Zones. You can use task placement strategies and
// constraints to customize task placement decisions.
// - DAEMON -The daemon scheduling strategy deploys exactly one task on each
// active container instance. This task meets all of the task placement constraints
// that you specify in your cluster. The service scheduler also evaluates the task
// placement constraints for running tasks. It stop tasks that don't meet the
// placement constraints. Fargate tasks don't support the DAEMON scheduling
// strategy.
SchedulingStrategy SchedulingStrategy
// The ARN that identifies the service. For more information about the ARN format,
// see Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids)
// in the Amazon ECS Developer Guide.
ServiceArn *string
// The name of your service. Up to 255 letters (uppercase and lowercase), numbers,
// underscores, and hyphens are allowed. Service names must be unique within a
// cluster. However, you can have similarly named services in multiple clusters
// within a Region or across multiple Regions.
ServiceName *string
// The details for the service discovery registries to assign to this service. For
// more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)
// .
ServiceRegistries []ServiceRegistry
// The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .
Status *string
// The metadata that you apply to the service to help you categorize and organize
// them. Each tag consists of a key and an optional value. You define bot the key
// and value. The following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
// The task definition to use for tasks in the service. This value is specified
// when the service is created with CreateService , and it can be modified with
// UpdateService .
TaskDefinition *string
// Information about a set of Amazon ECS tasks in either an CodeDeploy or an
// EXTERNAL deployment. An Amazon ECS task set includes details such as the desired
// number of tasks, how many tasks are running, and whether the task set serves
// production traffic.
TaskSets []TaskSet
noSmithyDocumentSerde
}
// Each alias ("endpoint") is a fully-qualified name and port number that other
// tasks ("clients") can use to connect to this service. Each name and port mapping
// must be unique within the namespace. Tasks that run in a namespace can use short
// names to connect to services in the namespace. Tasks can connect to services
// across all of the clusters in the namespace. Tasks connect through a managed
// proxy container that collects logs and metrics for increased visibility. Only
// the tasks that Amazon ECS services create are supported with Service Connect.
// For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
type ServiceConnectClientAlias struct {
// The listening port number for the Service Connect proxy. This port is available
// inside of all of the tasks within the same namespace. To avoid changing your
// applications in client Amazon ECS services, set this to the same port that the
// client application uses by default. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
//
// This member is required.
Port *int32
// The dnsName is the name that you use in the applications of client tasks to
// connect to this service. The name must be a valid DNS name but doesn't need to
// be fully-qualified. The name can include up to 127 characters. The name can
// include lowercase letters, numbers, underscores (_), hyphens (-), and periods
// (.). The name can't start with a hyphen. If this parameter isn't specified, the
// default value of discoveryName.namespace is used. If the discoveryName isn't
// specified, the port mapping name from the task definition is used in
// portName.namespace . To avoid changing your applications in client Amazon ECS
// services, set this to the same name that the client application uses by default.
// For example, a few common names are database , db , or the lowercase name of a
// database, such as mysql or redis . For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
DnsName *string
noSmithyDocumentSerde
}
// The Service Connect configuration of your Amazon ECS service. The configuration
// for this service to discover and connect to services, and be discovered by, and
// connected from, other services within a namespace. Tasks that run in a namespace
// can use short names to connect to services in the namespace. Tasks can connect
// to services across all of the clusters in the namespace. Tasks connect through a
// managed proxy container that collects logs and metrics for increased visibility.
// Only the tasks that Amazon ECS services create are supported with Service
// Connect. For more information, see Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
type ServiceConnectConfiguration struct {
// Specifies whether to use Service Connect with this service.
//
// This member is required.
Enabled bool
// The log configuration for the container. This parameter maps to LogConfig in
// the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/)
// . By default, containers use the same logging driver that the Docker daemon
// uses. However, the container might use a different logging driver than the
// Docker daemon by specifying a log driver configuration in the container
// definition. For more information about the options for different supported log
// drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)
// in the Docker documentation. Understand the following when specifying a log
// configuration for your containers.
// - Amazon ECS currently supports a subset of the logging drivers available to
// the Docker daemon. Additional log drivers may be available in future releases of
// the Amazon ECS container agent. For tasks on Fargate, the supported log drivers
// are awslogs , splunk , and awsfirelens . For tasks hosted on Amazon EC2
// instances, the supported log drivers are awslogs , fluentd , gelf , json-file
// , journald , logentries , syslog , splunk , and awsfirelens .
// - This parameter requires version 1.18 of the Docker Remote API or greater on
// your container instance.
// - For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container
// agent must register the available logging drivers with the
// ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on
// that instance can use these log configuration options. For more information, see
// Amazon ECS container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
// in the Amazon Elastic Container Service Developer Guide.
// - For tasks that are on Fargate, because you don't have access to the
// underlying infrastructure your tasks are hosted on, any additional software
// needed must be installed outside of the task. For example, the Fluentd output
// aggregators or a remote host running Logstash to send Gelf logs to.
LogConfiguration *LogConfiguration
// The namespace name or full Amazon Resource Name (ARN) of the Cloud Map
// namespace for use with Service Connect. The namespace must be in the same Amazon
// Web Services Region as the Amazon ECS service and cluster. The type of namespace
// doesn't affect Service Connect. For more information about Cloud Map, see
// Working with Services (https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)
// in the Cloud Map Developer Guide.
Namespace *string
// The list of Service Connect service objects. These are names and aliases (also
// known as endpoints) that are used by other Amazon ECS services to connect to
// this service. This field is not required for a "client" Amazon ECS service
// that's a member of a namespace only to connect to other services within the
// namespace. An example of this would be a frontend application that accepts
// incoming requests from either a load balancer that's attached to the service or
// by other means. An object selects a port from the task definition, assigns a
// name for the Cloud Map service, and a list of aliases (endpoints) and ports for
// client applications to refer to this service.
Services []ServiceConnectService
noSmithyDocumentSerde
}
// The Service Connect service object configuration. For more information, see
// Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)
// in the Amazon Elastic Container Service Developer Guide.
type ServiceConnectService struct {
// The portName must match the name of one of the portMappings from all the
// containers in the task definition of this Amazon ECS service.
//
// This member is required.
PortName *string
// The list of client aliases for this Service Connect service. You use these to
// assign names that can be used by client applications. The maximum number of
// client aliases that you can have in this list is 1. Each alias ("endpoint") is a
// fully-qualified name and port number that other Amazon ECS tasks ("clients") can
// use to connect to this service. Each name and port mapping must be unique within
// the namespace. For each ServiceConnectService , you must provide at least one
// clientAlias with one port .
ClientAliases []ServiceConnectClientAlias
// The discoveryName is the name of the new Cloud Map service that Amazon ECS
// creates for this Amazon ECS service. This must be unique within the Cloud Map
// namespace. The name can contain up to 64 characters. The name can include
// lowercase letters, numbers, underscores (_), and hyphens (-). The name can't
// start with a hyphen. If the discoveryName isn't specified, the port mapping
// name from the task definition is used in portName.namespace .
DiscoveryName *string
// The port number for the Service Connect proxy to listen on. Use the value of
// this field to bypass the proxy for traffic on the port number specified in the
// named portMapping in the task definition of this application, and then use it
// in your VPC security groups to allow traffic into the proxy for this Amazon ECS
// service. In awsvpc mode and Fargate, the default value is the container port
// number. The container port number is in the portMapping in the task definition.
// In bridge mode, the default value is the ephemeral port of the Service Connect
// proxy.
IngressPortOverride *int32
noSmithyDocumentSerde
}
// The Service Connect resource. Each configuration maps a discovery name to a
// Cloud Map service name. The data is stored in Cloud Map as part of the Service
// Connect configuration for each discovery name of this Amazon ECS service. A task
// can resolve the dnsName for each of the clientAliases of a service. However a
// task can't resolve the discovery names. If you want to connect to a service,
// refer to the ServiceConnectConfiguration of that service for the list of
// clientAliases that you can use.
type ServiceConnectServiceResource struct {
// The Amazon Resource Name (ARN) for the namespace in Cloud Map that matches the
// discovery name for this Service Connect resource. You can use this ARN in other
// integrations with Cloud Map. However, Service Connect can't ensure connectivity
// outside of Amazon ECS.
DiscoveryArn *string
// The discovery name of this Service Connect resource. The discoveryName is the
// name of the new Cloud Map service that Amazon ECS creates for this Amazon ECS
// service. This must be unique within the Cloud Map namespace. The name can
// contain up to 64 characters. The name can include lowercase letters, numbers,
// underscores (_), and hyphens (-). The name can't start with a hyphen. If the
// discoveryName isn't specified, the port mapping name from the task definition is
// used in portName.namespace .
DiscoveryName *string
noSmithyDocumentSerde
}
// The details for an event that's associated with a service.
type ServiceEvent struct {
// The Unix timestamp for the time when the event was triggered.
CreatedAt *time.Time
// The ID string for the event.
Id *string
// The event message.
Message *string
noSmithyDocumentSerde
}
// The details for the service registry. Each service may be associated with one
// service registry. Multiple service registries for each service are not
// supported. When you add, update, or remove the service registries configuration,
// Amazon ECS starts a new deployment. New tasks are registered and deregistered to
// the updated service registry configuration.
type ServiceRegistry struct {
// The container name value to be used for your service discovery service. It's
// already specified in the task definition. If the task definition that your
// service task specifies uses the bridge or host network mode, you must specify a
// containerName and containerPort combination from the task definition. If the
// task definition that your service task specifies uses the awsvpc network mode
// and a type SRV DNS record is used, you must specify either a containerName and
// containerPort combination or a port value. However, you can't specify both.
ContainerName *string
// The port value to be used for your service discovery service. It's already
// specified in the task definition. If the task definition your service task
// specifies uses the bridge or host network mode, you must specify a containerName
// and containerPort combination from the task definition. If the task definition
// your service task specifies uses the awsvpc network mode and a type SRV DNS
// record is used, you must specify either a containerName and containerPort
// combination or a port value. However, you can't specify both.
ContainerPort *int32
// The port value used if your service discovery service specified an SRV record.
// This field might be used if both the awsvpc network mode and SRV records are
// used.
Port *int32
// The Amazon Resource Name (ARN) of the service registry. The currently supported
// service registry is Cloud Map. For more information, see CreateService (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)
// .
RegistryArn *string
noSmithyDocumentSerde
}
// The details for the execute command session.
type Session struct {
// The ID of the execute command session.
SessionId *string
// A URL to the managed agent on the container that the SSM Session Manager client
// uses to send commands and receive output from the container.
StreamUrl *string
// An encrypted token value containing session and caller information. It's used
// to authenticate the connection to the container.
TokenValue *string
noSmithyDocumentSerde
}
// The current account setting for a resource.
type Setting struct {
// The Amazon ECS resource name.
Name SettingName
// The ARN of the principal. It can be a user, role, or the root user. If this
// field is omitted, the authenticated user is assumed.
PrincipalArn *string
// Indicates whether Amazon Web Services manages the account setting, or if the
// user manages it. aws_managed account settings are read-only, as Amazon Web
// Services manages such on the customer's behalf. Currently, the guardDutyActivate
// account setting is the only one Amazon Web Services manages.
Type SettingType
// Determines whether the account setting is on or off for the specified resource.
Value *string
noSmithyDocumentSerde
}
// A list of namespaced kernel parameters to set in the container. This parameter
// maps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)
// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)
// and the --sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration)
// . We don't recommend that you specify network-related systemControls parameters
// for multiple containers in a single task. This task also uses either the awsvpc
// or host network mode. It does it for the following reasons.
// - For tasks that use the awsvpc network mode, if you set systemControls for
// any container, it applies to all containers in the task. If you set different
// systemControls for multiple containers in a single task, the container that's
// started last determines which systemControls take effect.
// - For tasks that use the host network mode, the systemControls parameter
// applies to the container instance's kernel parameter and that of all containers
// of any tasks running on that container instance.
type SystemControl struct {
// The namespaced kernel parameter to set a value for.
Namespace *string
// The namespaced kernel parameter to set a value for. Valid IPC namespace values:
// "kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" |
// "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced" ,
// and Sysctls that start with "fs.mqueue.*" Valid network namespace values:
// Sysctls that start with "net.*" All of these values are supported by Fargate.
Value *string
noSmithyDocumentSerde
}
// The metadata that you apply to a resource to help you categorize and organize
// them. Each tag consists of a key and an optional value. You define them. The
// following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
type Tag struct {
// One part of a key-value pair that make up a tag. A key is a general label that
// acts like a category for more specific tag values.
Key *string
// The optional part of a key-value pair that make up a tag. A value acts as a
// descriptor within a tag category (key).
Value *string
noSmithyDocumentSerde
}
// Details on a task in a cluster.
type Task struct {
// The Elastic Network Adapter that's associated with the task if the task uses
// the awsvpc network mode.
Attachments []Attachment
// The attributes of the task
Attributes []Attribute
// The Availability Zone for the task.
AvailabilityZone *string
// The capacity provider that's associated with the task.
CapacityProviderName *string
// The ARN of the cluster that hosts the task.
ClusterArn *string
// The connectivity status of a task.
Connectivity Connectivity
// The Unix timestamp for the time when the task last went into CONNECTED status.
ConnectivityAt *time.Time
// The ARN of the container instances that host the task.
ContainerInstanceArn *string
// The containers that's associated with the task.
Containers []Container
// The number of CPU units used by the task as expressed in a task definition. It
// can be expressed as an integer using CPU units (for example, 1024 ). It can also
// be expressed as a string using vCPUs (for example, 1 vCPU or 1 vcpu ). String
// values are converted to an integer that indicates the CPU units when the task
// definition is registered. If you use the EC2 launch type, this field is
// optional. Supported values are between 128 CPU units ( 0.125 vCPUs) and 10240
// CPU units ( 10 vCPUs). If you use the Fargate launch type, this field is
// required. You must use one of the following values. These values determine the
// range of supported values for the memory parameter: The CPU units cannot be
// less than 1 vCPU when you use Windows containers on Fargate.
// - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2
// GB)
// - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3
// GB), 4096 (4 GB)
// - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4
// GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
// - 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in
// increments of 1024 (1 GB)
// - 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in
// increments of 1024 (1 GB)
// - 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
// This option requires Linux platform 1.4.0 or later.
// - 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
// This option requires Linux platform 1.4.0 or later.
Cpu *string
// The Unix timestamp for the time when the task was created. More specifically,
// it's for the time when the task entered the PENDING state.
CreatedAt *time.Time
// The desired status of the task. For more information, see Task Lifecycle (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html)
// .
DesiredStatus *string
// Determines whether execute command functionality is turned on for this task. If
// true , execute command functionality is turned on all the containers in the task.
EnableExecuteCommand bool
// The ephemeral storage settings for the task.
EphemeralStorage *EphemeralStorage
// The Unix timestamp for the time when the task execution stopped.
ExecutionStoppedAt *time.Time
// The name of the task group that's associated with the task.
Group *string
// The health status for the task. It's determined by the health of the essential
// containers in the task. If all essential containers in the task are reporting as
// HEALTHY , the task status also reports as HEALTHY . If any essential containers
// in the task are reporting as UNHEALTHY or UNKNOWN , the task status also reports
// as UNHEALTHY or UNKNOWN . The Amazon ECS container agent doesn't monitor or
// report on Docker health checks that are embedded in a container image and not
// specified in the container definition. For example, this includes those
// specified in a parent image or from the image's Dockerfile. Health check
// parameters that are specified in a container definition override any Docker
// health checks that are found in the container image.
HealthStatus HealthStatus
// The Elastic Inference accelerator that's associated with the task.
InferenceAccelerators []InferenceAccelerator
// The last known status for the task. For more information, see Task Lifecycle (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html)
// .
LastStatus *string
// The infrastructure where your task runs on. For more information, see Amazon
// ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
// in the Amazon Elastic Container Service Developer Guide.
LaunchType LaunchType
// The amount of memory (in MiB) that the task uses as expressed in a task
// definition. It can be expressed as an integer using MiB (for example, 1024 ). If
// it's expressed as a string using GB (for example, 1GB or 1 GB ), it's converted
// to an integer indicating the MiB when the task definition is registered. If you
// use the EC2 launch type, this field is optional. If you use the Fargate launch
// type, this field is required. You must use one of the following values. The
// value that you choose determines the range of supported values for the cpu
// parameter.
// - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25
// vCPU)
// - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:
// 512 (.5 vCPU)
// - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7
// GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
// - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
// Available cpu values: 2048 (2 vCPU)
// - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
// Available cpu values: 4096 (4 vCPU)
// - Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8
// vCPU) This option requires Linux platform 1.4.0 or later.
// - Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16
// vCPU) This option requires Linux platform 1.4.0 or later.
Memory *string
// One or more container overrides.
Overrides *TaskOverride
// The operating system that your tasks are running on. A platform family is
// specified only for tasks that use the Fargate launch type. All tasks that run as
// part of this service must use the same platformFamily value as the service (for
// example, LINUX. ).
PlatformFamily *string
// The platform version where your task runs on. A platform version is only
// specified for tasks that use the Fargate launch type. If you didn't specify one,
// the LATEST platform version is used. For more information, see Fargate Platform
// Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// in the Amazon Elastic Container Service Developer Guide.
PlatformVersion *string
// The Unix timestamp for the time when the container image pull began.
PullStartedAt *time.Time
// The Unix timestamp for the time when the container image pull completed.
PullStoppedAt *time.Time
// The Unix timestamp for the time when the task started. More specifically, it's
// for the time when the task transitioned from the PENDING state to the RUNNING
// state.
StartedAt *time.Time
// The tag specified when a task is started. If an Amazon ECS service started the
// task, the startedBy parameter contains the deployment ID of that service.
StartedBy *string
// The stop code indicating why a task was stopped. The stoppedReason might
// contain additional details. For more information about stop code, see Stopped
// tasks error codes (https://docs.aws.amazon.com/AmazonECS/latest/userguide/stopped-task-error-codes.html)
// in the Amazon ECS User Guide. The following are valid values:
// - TaskFailedToStart
// - EssentialContainerExited
// - UserInitiated
// - TerminationNotice
// - ServiceSchedulerInitiated
// - SpotInterruption
StopCode TaskStopCode
// The Unix timestamp for the time when the task was stopped. More specifically,
// it's for the time when the task transitioned from the RUNNING state to the
// STOPPED state.
StoppedAt *time.Time
// The reason that the task was stopped.
StoppedReason *string
// The Unix timestamp for the time when the task stops. More specifically, it's
// for the time when the task transitions from the RUNNING state to STOPPING .
StoppingAt *time.Time
// The metadata that you apply to the task to help you categorize and organize the
// task. Each tag consists of a key and an optional value. You define both the key
// and value. The following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
// The Amazon Resource Name (ARN) of the task.
TaskArn *string
// The ARN of the task definition that creates the task.
TaskDefinitionArn *string
// The version counter for the task. Every time a task experiences a change that
// starts a CloudWatch event, the version counter is incremented. If you replicate
// your Amazon ECS task state with CloudWatch Events, you can compare the version
// of a task reported by the Amazon ECS API actions with the version reported in
// CloudWatch Events for the task (inside the detail object) to verify that the
// version in your event stream is current.
Version int64
noSmithyDocumentSerde
}
// The details of a task definition which describes the container and volume
// definitions of an Amazon Elastic Container Service task. You can specify which
// Docker images to use, the required resources, and other configurations related
// to launching the task definition through an Amazon ECS service or task.
type TaskDefinition struct {
// The task launch types the task definition validated against during task
// definition registration. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
// in the Amazon Elastic Container Service Developer Guide.
Compatibilities []Compatibility
// A list of container definitions in JSON format that describe the different
// containers that make up your task. For more information about container
// definition parameters and defaults, see Amazon ECS Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html)
// in the Amazon Elastic Container Service Developer Guide.
ContainerDefinitions []ContainerDefinition
// The number of cpu units used by the task. If you use the EC2 launch type, this
// field is optional. Any value can be used. If you use the Fargate launch type,
// this field is required. You must use one of the following values. The value that
// you choose determines your range of valid values for the memory parameter. The
// CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
//
// - 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2
// GB)
// - 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3
// GB), 4096 (4 GB)
// - 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4
// GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
// - 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in
// increments of 1024 (1 GB)
// - 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in
// increments of 1024 (1 GB)
// - 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments
// This option requires Linux platform 1.4.0 or later.
// - 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments
// This option requires Linux platform 1.4.0 or later.
Cpu *string
// The Unix timestamp for the time when the task definition was deregistered.
DeregisteredAt *time.Time
// The ephemeral storage settings to use for tasks run with the task definition.
EphemeralStorage *EphemeralStorage
// The Amazon Resource Name (ARN) of the task execution role that grants the
// Amazon ECS container agent permission to make Amazon Web Services API calls on
// your behalf. The task execution IAM role is required depending on the
// requirements of your task. For more information, see Amazon ECS task execution
// IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)
// in the Amazon Elastic Container Service Developer Guide.
ExecutionRoleArn *string
// The name of a family that this task definition is registered to. Up to 255
// characters are allowed. Letters (both uppercase and lowercase letters), numbers,
// hyphens (-), and underscores (_) are allowed. A family groups multiple versions
// of a task definition. Amazon ECS gives the first task definition that you
// registered to a family a revision number of 1. Amazon ECS gives sequential
// revision numbers to each task definition that you add.
Family *string
// The Elastic Inference accelerator that's associated with the task.
InferenceAccelerators []InferenceAccelerator
// The IPC resource namespace to use for the containers in the task. The valid
// values are host , task , or none . If host is specified, then all containers
// within the tasks that specified the host IPC mode on the same container
// instance share the same IPC resources with the host Amazon EC2 instance. If task
// is specified, all containers within the specified task share the same IPC
// resources. If none is specified, then IPC resources within the containers of a
// task are private and not shared with other containers in a task or on the
// container instance. If no value is specified, then the IPC resource namespace
// sharing depends on the Docker daemon setting on the container instance. For more
// information, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings---ipc)
// in the Docker run reference. If the host IPC mode is used, be aware that there
// is a heightened risk of undesired IPC namespace expose. For more information,
// see Docker security (https://docs.docker.com/engine/security/security/) . If you
// are setting namespaced kernel parameters using systemControls for the
// containers in the task, the following will apply to your IPC resource namespace.
// For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html)
// in the Amazon Elastic Container Service Developer Guide.
// - For tasks that use the host IPC mode, IPC namespace related systemControls
// are not supported.
// - For tasks that use the task IPC mode, IPC namespace related systemControls
// will apply to all containers within a task.
// This parameter is not supported for Windows containers or tasks run on Fargate.
IpcMode IpcMode
// The amount (in MiB) of memory used by the task. If your tasks runs on Amazon
// EC2 instances, you must specify either a task-level memory value or a
// container-level memory value. This field is optional and any value can be used.
// If a task-level memory value is specified, the container-level memory value is
// optional. For more information regarding container-level memory and memory
// reservation, see ContainerDefinition (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)
// . If your tasks runs on Fargate, this field is required. You must use one of the
// following values. The value you choose determines your range of valid values for
// the cpu parameter.
// - 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25
// vCPU)
// - 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:
// 512 (.5 vCPU)
// - 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7
// GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
// - Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
// Available cpu values: 2048 (2 vCPU)
// - Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -
// Available cpu values: 4096 (4 vCPU)
// - Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8
// vCPU) This option requires Linux platform 1.4.0 or later.
// - Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16
// vCPU) This option requires Linux platform 1.4.0 or later.
Memory *string
// The Docker networking mode to use for the containers in the task. The valid
// values are none , bridge , awsvpc , and host . If no network mode is specified,
// the default is bridge . For Amazon ECS tasks on Fargate, the awsvpc network
// mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any
// network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances,
// or awsvpc can be used. If the network mode is set to none , you cannot specify
// port mappings in your container definitions, and the tasks containers do not
// have external connectivity. The host and awsvpc network modes offer the highest
// networking performance for containers because they use the EC2 network stack
// instead of the virtualized network stack provided by the bridge mode. With the
// host and awsvpc network modes, exposed container ports are mapped directly to
// the corresponding host port (for the host network mode) or the attached elastic
// network interface port (for the awsvpc network mode), so you cannot take
// advantage of dynamic host port mappings. When using the host network mode, you
// should not run containers using the root user (UID 0). It is considered best
// practice to use a non-root user. If the network mode is awsvpc , the task is
// allocated an elastic network interface, and you must specify a
// NetworkConfiguration value when you create a service or run a task with the task
// definition. For more information, see Task Networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)
// in the Amazon Elastic Container Service Developer Guide. If the network mode is
// host , you cannot run multiple instantiations of the same task on a single
// container instance when port mappings are used. For more information, see
// Network settings (https://docs.docker.com/engine/reference/run/#network-settings)
// in the Docker run reference.
NetworkMode NetworkMode
// The process namespace to use for the containers in the task. The valid values
// are host or task . On Fargate for Linux containers, the only valid value is task
// . For example, monitoring sidecars might need pidMode to access information
// about other containers running in the same task. If host is specified, all
// containers within the tasks that specified the host PID mode on the same
// container instance share the same process namespace with the host Amazon EC2
// instance. If task is specified, all containers within the specified task share
// the same process namespace. If no value is specified, the default is a private
// namespace for each container. For more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings---pid)
// in the Docker run reference. If the host PID mode is used, there's a heightened
// risk of undesired process namespace exposure. For more information, see Docker
// security (https://docs.docker.com/engine/security/security/) . This parameter is
// not supported for Windows containers. This parameter is only supported for tasks
// that are hosted on Fargate if the tasks are using platform version 1.4.0 or
// later (Linux). This isn't supported for Windows containers on Fargate.
PidMode PidMode
// An array of placement constraint objects to use for tasks. This parameter isn't
// supported for tasks run on Fargate.
PlacementConstraints []TaskDefinitionPlacementConstraint
// The configuration details for the App Mesh proxy. Your Amazon ECS container
// instances require at least version 1.26.0 of the container agent and at least
// version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your
// container instances are launched from the Amazon ECS optimized AMI version
// 20190301 or later, they contain the required versions of the container agent and
// ecs-init . For more information, see Amazon ECS-optimized Linux AMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)
// in the Amazon Elastic Container Service Developer Guide.
ProxyConfiguration *ProxyConfiguration
// The Unix timestamp for the time when the task definition was registered.
RegisteredAt *time.Time
// The principal that registered the task definition.
RegisteredBy *string
// The container instance attributes required by your task. When an Amazon EC2
// instance is registered to your cluster, the Amazon ECS container agent assigns
// some standard attributes to the instance. You can apply custom attributes. These
// are specified as key-value pairs using the Amazon ECS console or the
// PutAttributes API. These attributes are used when determining task placement for
// tasks hosted on Amazon EC2 instances. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)
// in the Amazon Elastic Container Service Developer Guide. This parameter isn't
// supported for tasks run on Fargate.
RequiresAttributes []Attribute
// The task launch types the task definition was validated against. The valid
// values are EC2 , FARGATE , and EXTERNAL . For more information, see Amazon ECS
// launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
// in the Amazon Elastic Container Service Developer Guide.
RequiresCompatibilities []Compatibility
// The revision of the task in a particular family. The revision is a version
// number of a task definition in a family. When you register a task definition for
// the first time, the revision is 1 . Each time that you register a new revision
// of a task definition in the same family, the revision value always increases by
// one. This is even if you deregistered previous revisions in this family.
Revision int32
// The operating system that your task definitions are running on. A platform
// family is specified only for tasks using the Fargate launch type. When you
// specify a task in a service, this value must match the runtimePlatform value of
// the service.
RuntimePlatform *RuntimePlatform
// The status of the task definition.
Status TaskDefinitionStatus
// The full Amazon Resource Name (ARN) of the task definition.
TaskDefinitionArn *string
// The short name or full Amazon Resource Name (ARN) of the Identity and Access
// Management role that grants containers in the task permission to call Amazon Web
// Services APIs on your behalf. For more information, see Amazon ECS Task Role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
// in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on
// Windows require that the -EnableTaskIAMRole option is set when you launch the
// Amazon ECS-optimized Windows AMI. Your containers must also run some
// configuration code to use the feature. For more information, see Windows IAM
// roles for tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html)
// in the Amazon Elastic Container Service Developer Guide.
TaskRoleArn *string
// The list of data volume definitions for the task. For more information, see
// Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html)
// in the Amazon Elastic Container Service Developer Guide. The host and sourcePath
// parameters aren't supported for tasks run on Fargate.
Volumes []Volume
noSmithyDocumentSerde
}
// The constraint on task placement in the task definition. For more information,
// see Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)
// in the Amazon Elastic Container Service Developer Guide. Task placement
// constraints aren't supported for tasks run on Fargate.
type TaskDefinitionPlacementConstraint struct {
// A cluster query language expression to apply to the constraint. For more
// information, see Cluster query language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html)
// in the Amazon Elastic Container Service Developer Guide.
Expression *string
// The type of constraint. The MemberOf constraint restricts selection to be from
// a group of valid candidates.
Type TaskDefinitionPlacementConstraintType
noSmithyDocumentSerde
}
// The overrides that are associated with a task.
type TaskOverride struct {
// One or more container overrides that are sent to a task.
ContainerOverrides []ContainerOverride
// The CPU override for the task.
Cpu *string
// The ephemeral storage setting override for the task. This parameter is only
// supported for tasks hosted on Fargate that use the following platform versions:
// - Linux platform version 1.4.0 or later.
// - Windows platform version 1.0.0 or later.
EphemeralStorage *EphemeralStorage
// The Amazon Resource Name (ARN) of the task execution role override for the
// task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)
// in the Amazon Elastic Container Service Developer Guide.
ExecutionRoleArn *string
// The Elastic Inference accelerator override for the task.
InferenceAcceleratorOverrides []InferenceAcceleratorOverride
// The memory override for the task.
Memory *string
// The Amazon Resource Name (ARN) of the role that containers in this task can
// assume. All containers in this task are granted the permissions that are
// specified in this role. For more information, see IAM Role for Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
// in the Amazon Elastic Container Service Developer Guide.
TaskRoleArn *string
noSmithyDocumentSerde
}
// Information about a set of Amazon ECS tasks in either an CodeDeploy or an
// EXTERNAL deployment. An Amazon ECS task set includes details such as the desired
// number of tasks, how many tasks are running, and whether the task set serves
// production traffic.
type TaskSet struct {
// The capacity provider strategy that are associated with the task set.
CapacityProviderStrategy []CapacityProviderStrategyItem
// The Amazon Resource Name (ARN) of the cluster that the service that hosts the
// task set exists in.
ClusterArn *string
// The computed desired count for the task set. This is calculated by multiplying
// the service's desiredCount by the task set's scale percentage. The result is
// always rounded up. For example, if the computed desired count is 1.2, it rounds
// up to 2 tasks.
ComputedDesiredCount int32
// The Unix timestamp for the time when the task set was created.
CreatedAt *time.Time
// The external ID associated with the task set. If an CodeDeploy deployment
// created a task set, the externalId parameter contains the CodeDeploy deployment
// ID. If a task set is created for an external deployment and is associated with a
// service discovery registry, the externalId parameter contains the
// ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
ExternalId *string
// The ID of the task set.
Id *string
// The launch type the tasks in the task set are using. For more information, see
// Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
// in the Amazon Elastic Container Service Developer Guide.
LaunchType LaunchType
// Details on a load balancer that are used with a task set.
LoadBalancers []LoadBalancer
// The network configuration for the task set.
NetworkConfiguration *NetworkConfiguration
// The number of tasks in the task set that are in the PENDING status during a
// deployment. A task in the PENDING state is preparing to enter the RUNNING
// state. A task set enters the PENDING status when it launches for the first time
// or when it's restarted after being in the STOPPED state.
PendingCount int32
// The operating system that your tasks in the set are running on. A platform
// family is specified only for tasks that use the Fargate launch type. All tasks
// in the set must have the same value.
PlatformFamily *string
// The Fargate platform version where the tasks in the task set are running. A
// platform version is only specified for tasks run on Fargate. For more
// information, see Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// in the Amazon Elastic Container Service Developer Guide.
PlatformVersion *string
// The number of tasks in the task set that are in the RUNNING status during a
// deployment. A task in the RUNNING state is running and ready for use.
RunningCount int32
// A floating-point percentage of your desired number of tasks to place and keep
// running in the task set.
Scale *Scale
// The Amazon Resource Name (ARN) of the service the task set exists in.
ServiceArn *string
// The details for the service discovery registries to assign to this task set.
// For more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)
// .
ServiceRegistries []ServiceRegistry
// The stability status. This indicates whether the task set has reached a steady
// state. If the following conditions are met, the task set are in STEADY_STATE :
// - The task runningCount is equal to the computedDesiredCount .
// - The pendingCount is 0 .
// - There are no tasks that are running on container instances in the DRAINING
// status.
// - All tasks are reporting a healthy status from the load balancers, service
// discovery, and container health checks.
// If any of those conditions aren't met, the stability status returns STABILIZING .
StabilityStatus StabilityStatus
// The Unix timestamp for the time when the task set stability status was
// retrieved.
StabilityStatusAt *time.Time
// The tag specified when a task set is started. If an CodeDeploy deployment
// created the task set, the startedBy parameter is CODE_DEPLOY . If an external
// deployment created the task set, the startedBy field isn't used.
StartedBy *string
// The status of the task set. The following describes each state. PRIMARY The
// task set is serving production traffic. ACTIVE The task set isn't serving
// production traffic. DRAINING The tasks in the task set are being stopped, and
// their corresponding targets are being deregistered from their target group.
Status *string
// The metadata that you apply to the task set to help you categorize and organize
// them. Each tag consists of a key and an optional value. You define both. The
// following basic restrictions apply to tags:
// - Maximum number of tags per resource - 50
// - For each resource, each tag key must be unique, and each tag key can have
// only one value.
// - Maximum key length - 128 Unicode characters in UTF-8
// - Maximum value length - 256 Unicode characters in UTF-8
// - If your tagging schema is used across multiple services and resources,
// remember that other services may have restrictions on allowed characters.
// Generally allowed characters are: letters, numbers, and spaces representable in
// UTF-8, and the following characters: + - = . _ : / @.
// - Tag keys and values are case-sensitive.
// - Do not use aws: , AWS: , or any upper or lowercase combination of such as a
// prefix for either keys or values as it is reserved for Amazon Web Services use.
// You cannot edit or delete tag keys or values with this prefix. Tags with this
// prefix do not count against your tags per resource limit.
Tags []Tag
// The task definition that the task set is using.
TaskDefinition *string
// The Amazon Resource Name (ARN) of the task set.
TaskSetArn *string
// The Unix timestamp for the time when the task set was last updated.
UpdatedAt *time.Time
noSmithyDocumentSerde
}
// The container path, mount options, and size of the tmpfs mount.
type Tmpfs struct {
// The absolute file path where the tmpfs volume is to be mounted.
//
// This member is required.
ContainerPath *string
// The maximum size (in MiB) of the tmpfs volume.
//
// This member is required.
Size int32
// The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw"
// | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" |
// "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" |
// "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" |
// "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" |
// "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" |
// "nr_inodes" | "nr_blocks" | "mpol"
MountOptions []string
noSmithyDocumentSerde
}
// The ulimit settings to pass to the container. Amazon ECS tasks hosted on
// Fargate use the default resource limit values set by the operating system with
// the exception of the nofile resource limit parameter which Fargate overrides.
// The nofile resource limit sets a restriction on the number of open files that a
// container can use. The default nofile soft limit is 1024 and the default hard
// limit is 4096 . You can specify the ulimit settings for a container in a task
// definition.
type Ulimit struct {
// The hard limit for the ulimit type.
//
// This member is required.
HardLimit int32
// The type of the ulimit .
//
// This member is required.
Name UlimitName
// The soft limit for the ulimit type.
//
// This member is required.
SoftLimit int32
noSmithyDocumentSerde
}
// The Docker and Amazon ECS container agent version information about a container
// instance.
type VersionInfo struct {
// The Git commit hash for the Amazon ECS container agent build on the
// amazon-ecs-agent (https://github.com/aws/amazon-ecs-agent/commits/master)
// GitHub repository.
AgentHash *string
// The version number of the Amazon ECS container agent.
AgentVersion *string
// The Docker version that's running on the container instance.
DockerVersion *string
noSmithyDocumentSerde
}
// A data volume that's used in a task definition. For tasks that use the Amazon
// Elastic File System (Amazon EFS), specify an efsVolumeConfiguration . For
// Windows tasks that use Amazon FSx for Windows File Server file system, specify a
// fsxWindowsFileServerVolumeConfiguration . For tasks that use a Docker volume,
// specify a DockerVolumeConfiguration . For tasks that use a bind mount host
// volume, specify a host and optional sourcePath . For more information, see
// Using Data Volumes in Tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html)
// .
type Volume struct {
// This parameter is specified when you use Docker volumes. Windows containers
// only support the use of the local driver. To use bind mounts, specify the host
// parameter instead. Docker volumes aren't supported by tasks run on Fargate.
DockerVolumeConfiguration *DockerVolumeConfiguration
// This parameter is specified when you use an Amazon Elastic File System file
// system for task storage.
EfsVolumeConfiguration *EFSVolumeConfiguration
// This parameter is specified when you use Amazon FSx for Windows File Server
// file system for task storage.
FsxWindowsFileServerVolumeConfiguration *FSxWindowsFileServerVolumeConfiguration
// This parameter is specified when you use bind mount host volumes. The contents
// of the host parameter determine whether your bind mount host volume persists on
// the host container instance and where it's stored. If the host parameter is
// empty, then the Docker daemon assigns a host path for your data volume. However,
// the data isn't guaranteed to persist after the containers that are associated
// with it stop running. Windows containers can mount whole directories on the same
// drive as $env:ProgramData . Windows containers can't mount directories on a
// different drive, and mount point can't be across drives. For example, you can
// mount C:\my\path:C:\my\path and D:\:D:\ , but not D:\my\path:C:\my\path or
// D:\:C:\my\path .
Host *HostVolumeProperties
// The name of the volume. Up to 255 letters (uppercase and lowercase), numbers,
// underscores, and hyphens are allowed. This name is referenced in the
// sourceVolume parameter of container definition mountPoints . This is required
// wwhen you use an Amazon EFS volume.
Name *string
noSmithyDocumentSerde
}
// Details on a data volume from another container in the same task definition.
type VolumeFrom struct {
// If this value is true , the container has read-only access to the volume. If
// this value is false , then the container can write to the volume. The default
// value is false .
ReadOnly *bool
// The name of another container within the same task definition to mount volumes
// from.
SourceContainer *string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|