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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Describes a quota for an Amazon Web Services account, for example the number of
// replication instances allowed.
type AccountQuota struct {
// The name of the DMS quota for this Amazon Web Services account.
AccountQuotaName *string
// The maximum allowed value for the quota.
Max int64
// The amount currently used toward the quota maximum.
Used int64
noSmithyDocumentSerde
}
// The name of an Availability Zone for use during database migration.
// AvailabilityZone is an optional parameter to the CreateReplicationInstance
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationInstance.html)
// operation, and it’s value relates to the Amazon Web Services Region of an
// endpoint. For example, the availability zone of an endpoint in the us-east-1
// region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.
type AvailabilityZone struct {
// The name of the Availability Zone.
Name *string
noSmithyDocumentSerde
}
// The SSL certificate that can be used to encrypt connections between the
// endpoints and the replication instance.
type Certificate struct {
// The Amazon Resource Name (ARN) for the certificate.
CertificateArn *string
// The date that the certificate was created.
CertificateCreationDate *time.Time
// A customer-assigned name for the certificate. Identifiers must begin with a
// letter and must contain only ASCII letters, digits, and hyphens. They can't end
// with a hyphen or contain two consecutive hyphens.
CertificateIdentifier *string
// The owner of the certificate.
CertificateOwner *string
// The contents of a .pem file, which contains an X.509 certificate.
CertificatePem *string
// The location of an imported Oracle Wallet certificate for use with SSL. Example:
// filebase64("${path.root}/rds-ca-2019-root.sso")
CertificateWallet []byte
// The key length of the cryptographic algorithm being used.
KeyLength *int32
// The signing algorithm for the certificate.
SigningAlgorithm *string
// The beginning date that the certificate is valid.
ValidFromDate *time.Time
// The final date that the certificate is valid.
ValidToDate *time.Time
noSmithyDocumentSerde
}
// Describes the last Fleet Advisor collector health check.
type CollectorHealthCheck struct {
// The status of the Fleet Advisor collector.
CollectorStatus CollectorStatus
// Whether the local collector can access its Amazon S3 bucket.
LocalCollectorS3Access *bool
// Whether the role that you provided when creating the Fleet Advisor collector has
// sufficient permissions to access the Fleet Advisor web collector.
WebCollectorGrantedRoleBasedAccess *bool
// Whether the web collector can access its Amazon S3 bucket.
WebCollectorS3Access *bool
noSmithyDocumentSerde
}
// Describes a Fleet Advisor collector.
type CollectorResponse struct {
// Describes the last Fleet Advisor collector health check.
CollectorHealthCheck *CollectorHealthCheck
// The name of the Fleet Advisor collector .
CollectorName *string
// The reference ID of the Fleet Advisor collector.
CollectorReferencedId *string
// The version of your Fleet Advisor collector, in semantic versioning format, for
// example 1.0.2
CollectorVersion *string
// The timestamp when you created the collector, in the following format:
// 2022-01-24T19:04:02.596113Z
CreatedDate *string
// A summary description of the Fleet Advisor collector.
Description *string
// Describes a Fleet Advisor collector inventory.
InventoryData *InventoryData
// The timestamp of the last time the collector received data, in the following
// format: 2022-01-24T19:04:02.596113Z
LastDataReceived *string
// The timestamp when DMS last modified the collector, in the following format:
// 2022-01-24T19:04:02.596113Z
ModifiedDate *string
// The timestamp when DMS registered the collector, in the following format:
// 2022-01-24T19:04:02.596113Z
RegisteredDate *string
// The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory
// metadata.
S3BucketName *string
// The IAM role that grants permissions to access the specified Amazon S3 bucket.
ServiceAccessRoleArn *string
// Whether the collector version is up to date.
VersionStatus VersionStatus
noSmithyDocumentSerde
}
// Briefly describes a Fleet Advisor collector.
type CollectorShortInfoResponse struct {
// The name of the Fleet Advisor collector.
CollectorName *string
// The reference ID of the Fleet Advisor collector.
CollectorReferencedId *string
noSmithyDocumentSerde
}
// Status of the connection between an endpoint and a replication instance,
// including Amazon Resource Names (ARNs) and the last error message issued.
type Connection struct {
// The ARN string that uniquely identifies the endpoint.
EndpointArn *string
// The identifier of the endpoint. Identifiers must begin with a letter and must
// contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or
// contain two consecutive hyphens.
EndpointIdentifier *string
// The error message when the connection last failed.
LastFailureMessage *string
// The ARN of the replication instance.
ReplicationInstanceArn *string
// The replication instance identifier. This parameter is stored as a lowercase
// string.
ReplicationInstanceIdentifier *string
// The connection status. This parameter can return one of the following values:
//
// *
// "successful"
//
// * "testing"
//
// * "failed"
//
// * "deleting"
Status *string
noSmithyDocumentSerde
}
// Describes an inventory database instance for a Fleet Advisor collector.
type DatabaseInstanceSoftwareDetailsResponse struct {
// The database engine of a database in a Fleet Advisor collector inventory, for
// example Microsoft SQL Server.
Engine *string
// The database engine edition of a database in a Fleet Advisor collector
// inventory, for example Express.
EngineEdition *string
// The database engine version of a database in a Fleet Advisor collector
// inventory, for example 2019.
EngineVersion *string
// The operating system architecture of the database.
OsArchitecture *int32
// The service pack level of the database.
ServicePack *string
// The support level of the database, for example Mainstream support.
SupportLevel *string
// Information about the database engine software, for example Mainstream support
// ends on November 14th, 2024.
Tooltip *string
noSmithyDocumentSerde
}
// Describes a database in a Fleet Advisor collector inventory.
type DatabaseResponse struct {
// A list of collectors associated with the database.
Collectors []CollectorShortInfoResponse
// The ID of a database in a Fleet Advisor collector inventory.
DatabaseId *string
// The name of a database in a Fleet Advisor collector inventory.
DatabaseName *string
// The IP address of a database in a Fleet Advisor collector inventory.
IpAddress *string
// The number of schemas in a Fleet Advisor collector inventory database.
NumberOfSchemas *int64
// The server name of a database in a Fleet Advisor collector inventory.
Server *ServerShortInfoResponse
// The software details of a database in a Fleet Advisor collector inventory, such
// as database engine and version.
SoftwareDetails *DatabaseInstanceSoftwareDetailsResponse
noSmithyDocumentSerde
}
// Describes a database in a Fleet Advisor collector inventory.
type DatabaseShortInfoResponse struct {
// The database engine of a database in a Fleet Advisor collector inventory, for
// example PostgreSQL.
DatabaseEngine *string
// The ID of a database in a Fleet Advisor collector inventory.
DatabaseId *string
// The IP address of a database in a Fleet Advisor collector inventory.
DatabaseIpAddress *string
// The name of a database in a Fleet Advisor collector inventory.
DatabaseName *string
noSmithyDocumentSerde
}
// The settings in JSON format for the DMS Transfer type source endpoint.
type DmsTransferSettings struct {
// The name of the S3 bucket to use.
BucketName *string
// The Amazon Resource Name (ARN) used by the service access IAM role. The role
// must allow the iam:PassRole action.
ServiceAccessRoleArn *string
noSmithyDocumentSerde
}
// Provides information that defines a DocumentDB endpoint.
type DocDbSettings struct {
// The database name on the DocumentDB source endpoint.
DatabaseName *string
// Indicates the number of documents to preview to determine the document
// organization. Use this setting when NestingLevel is set to "one". Must be a
// positive value greater than 0. Default value is 1000.
DocsToInvestigate *int32
// Specifies the document ID. Use this setting when NestingLevel is set to "none".
// Default value is "false".
ExtractDocId *bool
// The KMS key identifier that is used to encrypt the content on the replication
// instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses
// your default encryption key. KMS creates the default encryption key for your
// Amazon Web Services account. Your Amazon Web Services account has a different
// default encryption key for each Amazon Web Services Region.
KmsKeyId *string
// Specifies either document or table mode. Default value is "none". Specify "none"
// to use document mode. Specify "one" to use table mode.
NestingLevel NestingLevelValue
// The password for the user account you use to access the DocumentDB source
// endpoint.
Password *string
// The port value for the DocumentDB source endpoint.
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the DocumentDB endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the DocumentDB endpoint connection details.
SecretsManagerSecretId *string
// The name of the server on the DocumentDB source endpoint.
ServerName *string
// The user name you use to access the DocumentDB source endpoint.
Username *string
noSmithyDocumentSerde
}
// Provides the Amazon Resource Name (ARN) of the Identity and Access Management
// (IAM) role used to define an Amazon DynamoDB target endpoint.
type DynamoDbSettings struct {
// The Amazon Resource Name (ARN) used by the service to access the IAM role. The
// role must allow the iam:PassRole action.
//
// This member is required.
ServiceAccessRoleArn *string
noSmithyDocumentSerde
}
// Provides information that defines an OpenSearch endpoint.
type ElasticsearchSettings struct {
// The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol
// (http/https) is not specified.
//
// This member is required.
EndpointUri *string
// The Amazon Resource Name (ARN) used by the service to access the IAM role. The
// role must allow the iam:PassRole action.
//
// This member is required.
ServiceAccessRoleArn *string
// The maximum number of seconds for which DMS retries failed API requests to the
// OpenSearch cluster.
ErrorRetryDuration *int32
// The maximum percentage of records that can fail to be written before a full load
// operation stops. To avoid early failure, this counter is only effective after
// 1000 records are transferred. OpenSearch also has the concept of error
// monitoring during the last 10 minutes of an Observation Window. If transfer of
// all records fail in the last 10 minutes, the full load operation stops.
FullLoadErrorPercentage *int32
// Set this option to true for DMS to migrate documentation using the documentation
// type _doc. OpenSearch and an Elasticsearch cluster only support the _doc
// documentation type in versions 7. x and later. The default value is false.
UseNewMappingType *bool
noSmithyDocumentSerde
}
// Describes an endpoint of a database instance in response to operations such as
// the following:
//
// * CreateEndpoint
//
// * DescribeEndpoint
//
// * ModifyEndpoint
type Endpoint struct {
// The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
CertificateArn *string
// The name of the database at the endpoint.
DatabaseName *string
// The settings for the DMS Transfer type source. For more information, see the
// DmsTransferSettings structure.
DmsTransferSettings *DmsTransferSettings
// Provides information that defines a DocumentDB endpoint.
DocDbSettings *DocDbSettings
// The settings for the DynamoDB target endpoint. For more information, see the
// DynamoDBSettings structure.
DynamoDbSettings *DynamoDbSettings
// The settings for the OpenSearch source endpoint. For more information, see the
// ElasticsearchSettings structure.
ElasticsearchSettings *ElasticsearchSettings
// The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
EndpointArn *string
// The database endpoint identifier. Identifiers must begin with a letter and must
// contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or
// contain two consecutive hyphens.
EndpointIdentifier *string
// The type of endpoint. Valid values are source and target.
EndpointType ReplicationEndpointTypeValue
// The expanded name for the engine name. For example, if the EngineName parameter
// is "aurora," this value would be "Amazon Aurora MySQL."
EngineDisplayName *string
// The database engine name. Valid values, depending on the EndpointType, include
// "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql",
// "opensearch", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb",
// "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and
// "neptune".
EngineName *string
// Value returned by a call to CreateEndpoint that can be used for cross-account
// validation. Use it on a subsequent call to CreateEndpoint to create the endpoint
// with a cross-account.
ExternalId *string
// The external table definition.
ExternalTableDefinition *string
// Additional connection attributes used to connect to the endpoint.
ExtraConnectionAttributes *string
// Settings in JSON format for the source GCP MySQL endpoint.
GcpMySQLSettings *GcpMySQLSettings
// The settings for the IBM Db2 LUW source endpoint. For more information, see the
// IBMDb2Settings structure.
IBMDb2Settings *IBMDb2Settings
// The settings for the Apache Kafka target endpoint. For more information, see the
// KafkaSettings structure.
KafkaSettings *KafkaSettings
// The settings for the Amazon Kinesis target endpoint. For more information, see
// the KinesisSettings structure.
KinesisSettings *KinesisSettings
// An KMS key identifier that is used to encrypt the connection parameters for the
// endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses
// your default encryption key. KMS creates the default encryption key for your
// Amazon Web Services account. Your Amazon Web Services account has a different
// default encryption key for each Amazon Web Services Region.
KmsKeyId *string
// The settings for the Microsoft SQL Server source and target endpoint. For more
// information, see the MicrosoftSQLServerSettings structure.
MicrosoftSQLServerSettings *MicrosoftSQLServerSettings
// The settings for the MongoDB source endpoint. For more information, see the
// MongoDbSettings structure.
MongoDbSettings *MongoDbSettings
// The settings for the MySQL source and target endpoint. For more information, see
// the MySQLSettings structure.
MySQLSettings *MySQLSettings
// The settings for the Amazon Neptune target endpoint. For more information, see
// the NeptuneSettings structure.
NeptuneSettings *NeptuneSettings
// The settings for the Oracle source and target endpoint. For more information,
// see the OracleSettings structure.
OracleSettings *OracleSettings
// The port value used to access the endpoint.
Port *int32
// The settings for the PostgreSQL source and target endpoint. For more
// information, see the PostgreSQLSettings structure.
PostgreSQLSettings *PostgreSQLSettings
// The settings for the Redis target endpoint. For more information, see the
// RedisSettings structure.
RedisSettings *RedisSettings
// Settings for the Amazon Redshift endpoint.
RedshiftSettings *RedshiftSettings
// The settings for the S3 target endpoint. For more information, see the
// S3Settings structure.
S3Settings *S3Settings
// The name of the server at the endpoint.
ServerName *string
// The Amazon Resource Name (ARN) used by the service to access the IAM role. The
// role must allow the iam:PassRole action.
ServiceAccessRoleArn *string
// The SSL mode used to connect to the endpoint. The default value is none.
SslMode DmsSslModeValue
// The status of the endpoint.
Status *string
// The settings for the SAP ASE source and target endpoint. For more information,
// see the SybaseSettings structure.
SybaseSettings *SybaseSettings
// The user name used to connect to the endpoint.
Username *string
noSmithyDocumentSerde
}
// Endpoint settings.
type EndpointSetting struct {
// The relevance or validity of an endpoint setting for an engine name and its
// endpoint type.
Applicability *string
// The default value of the endpoint setting if no value is specified using
// CreateEndpoint or ModifyEndpoint.
DefaultValue *string
// Enumerated values to use for this endpoint.
EnumValues []string
// The maximum value of an endpoint setting that is of type int.
IntValueMax *int32
// The minimum value of an endpoint setting that is of type int.
IntValueMin *int32
// The name that you want to give the endpoint settings.
Name *string
// A value that marks this endpoint setting as sensitive.
Sensitive *bool
// The type of endpoint. Valid values are source and target.
Type EndpointSettingTypeValue
// The unit of measure for this endpoint setting.
Units *string
noSmithyDocumentSerde
}
// Describes an identifiable significant activity that affects a replication
// instance or task. This object can provide the message, the available event
// categories, the date and source of the event, and the DMS resource type.
type Event struct {
// The date of the event.
Date *time.Time
// The event categories available for the specified source type.
EventCategories []string
// The event message.
Message *string
// The identifier of an event source.
SourceIdentifier *string
// The type of DMS resource that generates events. Valid values:
// replication-instance | endpoint | replication-task
SourceType SourceType
noSmithyDocumentSerde
}
// Lists categories of events subscribed to, and generated by, the applicable DMS
// resource type. This data type appears in response to the DescribeEventCategories
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_EventCategoryGroup.html)
// action.
type EventCategoryGroup struct {
// A list of event categories from a source type that you've chosen.
EventCategories []string
// The type of DMS resource that generates events. Valid values:
// replication-instance | replication-server | security-group | replication-task
SourceType *string
noSmithyDocumentSerde
}
// Describes an event notification subscription created by the
// CreateEventSubscription operation.
type EventSubscription struct {
// The DMS event notification subscription Id.
CustSubscriptionId *string
// The Amazon Web Services customer account associated with the DMS event
// notification subscription.
CustomerAwsId *string
// Boolean value that indicates if the event subscription is enabled.
Enabled bool
// A lists of event categories.
EventCategoriesList []string
// The topic ARN of the DMS event notification subscription.
SnsTopicArn *string
// A list of source Ids for the event subscription.
SourceIdsList []string
// The type of DMS resource that generates events. Valid values:
// replication-instance | replication-server | security-group | replication-task
SourceType *string
// The status of the DMS event notification subscription. Constraints: Can be one
// of the following: creating | modifying | deleting | active | no-permission |
// topic-not-exist The status "no-permission" indicates that DMS no longer has
// permission to post to the SNS topic. The status "topic-not-exist" indicates that
// the topic was deleted after the subscription was created.
Status *string
// The time the DMS event notification subscription was created.
SubscriptionCreationTime *string
noSmithyDocumentSerde
}
// Identifies the name and value of a filter object. This filter is used to limit
// the number and type of DMS objects that are returned for a particular Describe*
// call or similar operation. Filters are used as an optional parameter for certain
// API operations.
type Filter struct {
// The name of the filter as specified for a Describe* or similar operation.
//
// This member is required.
Name *string
// The filter value, which can specify one or more values used to narrow the
// returned results.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor
// collector.
type FleetAdvisorLsaAnalysisResponse struct {
// The ID of an LSA analysis run by a Fleet Advisor collector.
LsaAnalysisId *string
// The status of an LSA analysis run by a Fleet Advisor collector.
Status *string
noSmithyDocumentSerde
}
// Describes a schema object in a Fleet Advisor collector inventory.
type FleetAdvisorSchemaObjectResponse struct {
// The number of lines of code in a schema object in a Fleet Advisor collector
// inventory.
CodeLineCount *int64
// The size level of the code in a schema object in a Fleet Advisor collector
// inventory.
CodeSize *int64
// The number of objects in a schema object in a Fleet Advisor collector inventory.
NumberOfObjects *int64
// The type of the schema object, as reported by the database engine. Examples
// include the following:
//
// * function
//
// * trigger
//
// * SYSTEM_TABLE
//
// * QUEUE
ObjectType *string
// The ID of a schema object in a Fleet Advisor collector inventory.
SchemaId *string
noSmithyDocumentSerde
}
// Settings in JSON format for the source GCP MySQL endpoint.
type GcpMySQLSettings struct {
// Specifies a script to run immediately after DMS connects to the endpoint. The
// migration task continues running regardless if the SQL statement succeeds or
// fails. For this parameter, provide the code of the script itself, not the name
// of a file containing the script.
AfterConnectScript *string
// Adjusts the behavior of DMS when migrating from an SQL Server source database
// that is hosted as part of an Always On availability group cluster. If you need
// DMS to poll all the nodes in the Always On cluster for transaction backups, set
// this attribute to false.
CleanSourceMetadataOnMismatch *bool
// Database name for the endpoint. For a MySQL source or target endpoint, don't
// explicitly specify the database using the DatabaseName request parameter on
// either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName
// when you create or modify a MySQL endpoint replicates all the task tables to
// this single database. For MySQL endpoints, you specify the database only when
// you specify the schema in the table-mapping rules of the DMS task.
DatabaseName *string
// Specifies how often to check the binary log for new changes/events when the
// database is idle. The default is five seconds. Example: eventsPollInterval=5; In
// the example, DMS checks for changes in the binary logs every five seconds.
EventsPollInterval *int32
// Specifies the maximum size (in KB) of any .csv file used to transfer data to a
// MySQL-compatible database. Example: maxFileSize=512
MaxFileSize *int32
// Improves performance when loading data into the MySQL-compatible target
// database. Specifies how many threads to use to load the data into the
// MySQL-compatible target database. Setting a large number of threads can have an
// adverse effect on database performance, because a separate connection is
// required for each thread. The default is one. Example: parallelLoadThreads=1
ParallelLoadThreads *int32
// Endpoint connection password.
Password *string
//
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the MySQL endpoint. You can specify one of two sets
// of values for these permissions. You can specify the values for this setting and
// SecretsManagerSecretId. Or you can specify clear-text values for UserName,
// Password, ServerName, and Port. You can't specify both. For more information on
// creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and
// SecretsManagerSecretId required to access it, see Using secrets to access
// Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the MySQL endpoint connection details.
SecretsManagerSecretId *string
// Endpoint TCP port.
ServerName *string
// Specifies the time zone for the source MySQL database. Example:
// serverTimezone=US/Pacific; Note: Do not enclose time zones in single quotes.
ServerTimezone *string
// Specifies where to migrate source tables on the target, either to a single
// database or multiple databases. Example: targetDbType=MULTIPLE_DATABASES
TargetDbType TargetDbType
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// Provides information that defines an IBM Db2 LUW endpoint.
type IBMDb2Settings struct {
// For ongoing replication (CDC), use CurrentLSN to specify a log sequence number
// (LSN) where you want the replication to start.
CurrentLsn *string
// Database name for the endpoint.
DatabaseName *string
// Maximum number of bytes per read, as a NUMBER value. The default is 64 KB.
MaxKBytesPerRead *int32
// Endpoint connection password.
Password *string
// Endpoint TCP port. The default value is 50000.
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the Db2 LUW endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the Db2 LUW endpoint connection details.
SecretsManagerSecretId *string
// Fully qualified domain name of the endpoint.
ServerName *string
// Enables ongoing replication (CDC) as a BOOLEAN value. The default is true.
SetDataCaptureChanges *bool
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// Describes a Fleet Advisor collector inventory.
type InventoryData struct {
// The number of databases in the Fleet Advisor collector inventory.
NumberOfDatabases *int32
// The number of schemas in the Fleet Advisor collector inventory.
NumberOfSchemas *int32
noSmithyDocumentSerde
}
// Provides information that describes an Apache Kafka endpoint. This information
// includes the output format of records applied to the endpoint and details of
// transaction and control table data information.
type KafkaSettings struct {
// A comma-separated list of one or more broker locations in your Kafka cluster
// that host your Kafka instance. Specify each broker location in the form
// broker-hostname-or-ip:port . For example,
// "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and
// examples of specifying a list of broker locations, see Using Apache Kafka as a
// target for Database Migration Service
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the
// Database Migration Service User Guide.
Broker *string
// Shows detailed control information for table definition, column definition, and
// table and column changes in the Kafka message output. The default is false.
IncludeControlDetails *bool
// Include NULL and empty columns for records migrated to the endpoint. The default
// is false.
IncludeNullAndEmpty *bool
// Shows the partition value within the Kafka message output unless the partition
// type is schema-table-type. The default is false.
IncludePartitionValue *bool
// Includes any data definition language (DDL) operations that change the table in
// the control data, such as rename-table, drop-table, add-column, drop-column, and
// rename-column. The default is false.
IncludeTableAlterOperations *bool
// Provides detailed transaction information from the source database. This
// information includes a commit timestamp, a log position, and values for
// transaction_id, previous transaction_id, and transaction_record_id (the record
// offset within a transaction). The default is false.
IncludeTransactionDetails *bool
// The output format for the records created on the endpoint. The message format is
// JSON (default) or JSON_UNFORMATTED (a single line with no tab).
MessageFormat MessageFormatValue
// The maximum size in bytes for records created on the endpoint The default is
// 1,000,000.
MessageMaxBytes *int32
// Set this optional parameter to true to avoid adding a '0x' prefix to raw data in
// hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB
// column type in hexadecimal format moving from an Oracle source to a Kafka
// target. Use the NoHexPrefix endpoint setting to enable migration of RAW data
// type columns without adding the '0x' prefix.
NoHexPrefix *bool
// Prefixes schema and table names to partition values, when the partition type is
// primary-key-type. Doing this increases data distribution among Kafka partitions.
// For example, suppose that a SysBench schema has thousands of tables and each
// table has only limited range for a primary key. In this case, the same primary
// key is sent from thousands of tables to the same partition, which causes
// throttling. The default is false.
PartitionIncludeSchemaTable *bool
// The secure password you created when you first set up your MSK cluster to
// validate a client identity and make an encrypted connection between server and
// client using SASL-SSL authentication.
SaslPassword *string
// The secure user name you created when you first set up your MSK cluster to
// validate a client identity and make an encrypted connection between server and
// client using SASL-SSL authentication.
SaslUsername *string
// Set secure connection to a Kafka target endpoint using Transport Layer Security
// (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl.
// sasl-ssl requires SaslUsername and SaslPassword.
SecurityProtocol KafkaSecurityProtocol
// The Amazon Resource Name (ARN) for the private certificate authority (CA) cert
// that DMS uses to securely connect to your Kafka target endpoint.
SslCaCertificateArn *string
// The Amazon Resource Name (ARN) of the client certificate used to securely
// connect to a Kafka target endpoint.
SslClientCertificateArn *string
// The Amazon Resource Name (ARN) for the client private key used to securely
// connect to a Kafka target endpoint.
SslClientKeyArn *string
// The password for the client private key used to securely connect to a Kafka
// target endpoint.
SslClientKeyPassword *string
// The topic to which you migrate the data. If you don't specify a topic, DMS
// specifies "kafka-default-topic" as the migration topic.
Topic *string
noSmithyDocumentSerde
}
// Provides information that describes an Amazon Kinesis Data Stream endpoint. This
// information includes the output format of records applied to the endpoint and
// details of transaction and control table data information.
type KinesisSettings struct {
// Shows detailed control information for table definition, column definition, and
// table and column changes in the Kinesis message output. The default is false.
IncludeControlDetails *bool
// Include NULL and empty columns for records migrated to the endpoint. The default
// is false.
IncludeNullAndEmpty *bool
// Shows the partition value within the Kinesis message output, unless the
// partition type is schema-table-type. The default is false.
IncludePartitionValue *bool
// Includes any data definition language (DDL) operations that change the table in
// the control data, such as rename-table, drop-table, add-column, drop-column, and
// rename-column. The default is false.
IncludeTableAlterOperations *bool
// Provides detailed transaction information from the source database. This
// information includes a commit timestamp, a log position, and values for
// transaction_id, previous transaction_id, and transaction_record_id (the record
// offset within a transaction). The default is false.
IncludeTransactionDetails *bool
// The output format for the records created on the endpoint. The message format is
// JSON (default) or JSON_UNFORMATTED (a single line with no tab).
MessageFormat MessageFormatValue
// Set this optional parameter to true to avoid adding a '0x' prefix to raw data in
// hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB
// column type in hexadecimal format moving from an Oracle source to an Amazon
// Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW
// data type columns without adding the '0x' prefix.
NoHexPrefix *bool
// Prefixes schema and table names to partition values, when the partition type is
// primary-key-type. Doing this increases data distribution among Kinesis shards.
// For example, suppose that a SysBench schema has thousands of tables and each
// table has only limited range for a primary key. In this case, the same primary
// key is sent from thousands of tables to the same shard, which causes throttling.
// The default is false.
PartitionIncludeSchemaTable *bool
// The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the
// Kinesis data stream. The role must allow the iam:PassRole action.
ServiceAccessRoleArn *string
// The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
StreamArn *string
noSmithyDocumentSerde
}
// Provides information that defines a Microsoft SQL Server endpoint.
type MicrosoftSQLServerSettings struct {
// The maximum size of the packets (in bytes) used to transfer data using BCP.
BcpPacketSize *int32
// Specifies a file group for the DMS internal tables. When the replication task
// starts, all the internal DMS control tables (awsdms_ apply_exception,
// awsdms_apply, awsdms_changes) are created for the specified file group.
ControlTablesFileGroup *string
// Database name for the endpoint.
DatabaseName *string
// Endpoint connection password.
Password *string
// Endpoint TCP port.
Port *int32
// Cleans and recreates table metadata information on the replication instance when
// a mismatch occurs. An example is a situation where running an alter DDL
// statement on a table might result in different information about the table
// cached in the replication instance.
QuerySingleAlwaysOnNode *bool
// When this attribute is set to Y, DMS only reads changes from transaction log
// backups and doesn't read from the active transaction log file during ongoing
// replication. Setting this parameter to Y enables you to control active
// transaction log file growth during full load and ongoing replication tasks.
// However, it can add some source latency to ongoing replication.
ReadBackupOnly *bool
// Use this attribute to minimize the need to access the backup log and enable DMS
// to prevent truncation using one of the following two methods. Start transactions
// in the database: This is the default method. When this method is used, DMS
// prevents TLOG truncation by mimicking a transaction in the database. As long as
// such a transaction is open, changes that appear after the transaction started
// aren't truncated. If you need Microsoft Replication to be enabled in your
// database, then you must choose this method. Exclusively use sp_repldone within a
// single task: When this method is used, DMS reads the changes and then uses
// sp_repldone to mark the TLOG transactions as ready for truncation. Although this
// method doesn't involve any transactional activities, it can only be used when
// Microsoft Replication isn't running. Also, when using this method, only one DMS
// task can access the database at any given time. Therefore, if you need to run
// parallel DMS tasks against the same database, use the default method.
SafeguardPolicy SafeguardPolicy
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the SQL Server endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the SQL Server endpoint connection details.
SecretsManagerSecretId *string
// Fully qualified domain name of the endpoint.
ServerName *string
// Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR
// data types during migration. The default value is true.
TrimSpaceInChar *bool
// Use this to attribute to transfer data for full-load operations using BCP. When
// the target table contains an identity column that does not exist in the source
// table, you must disable the use BCP for loading table option.
UseBcpFullLoad *bool
// When this attribute is set to Y, DMS processes third-party transaction log
// backups if they are created in native format.
UseThirdPartyBackupDevice *bool
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// Provides information that defines a MongoDB endpoint.
type MongoDbSettings struct {
// The authentication mechanism you use to access the MongoDB source endpoint. For
// the default value, in MongoDB version 2.x, "default" is "mongodb_cr". For
// MongoDB version 3.x or later, "default" is "scram_sha_1". This setting isn't
// used when AuthType is set to "no".
AuthMechanism AuthMechanismValue
// The MongoDB database name. This setting isn't used when AuthType is set to "no".
// The default is "admin".
AuthSource *string
// The authentication type you use to access the MongoDB source endpoint. When when
// set to "no", user name and password parameters are not used and can be empty.
AuthType AuthTypeValue
// The database name on the MongoDB source endpoint.
DatabaseName *string
// Indicates the number of documents to preview to determine the document
// organization. Use this setting when NestingLevel is set to "one". Must be a
// positive value greater than 0. Default value is 1000.
DocsToInvestigate *string
// Specifies the document ID. Use this setting when NestingLevel is set to "none".
// Default value is "false".
ExtractDocId *string
// The KMS key identifier that is used to encrypt the content on the replication
// instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses
// your default encryption key. KMS creates the default encryption key for your
// Amazon Web Services account. Your Amazon Web Services account has a different
// default encryption key for each Amazon Web Services Region.
KmsKeyId *string
// Specifies either document or table mode. Default value is "none". Specify "none"
// to use document mode. Specify "one" to use table mode.
NestingLevel NestingLevelValue
// The password for the user account you use to access the MongoDB source endpoint.
Password *string
// The port value for the MongoDB source endpoint.
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the MongoDB endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the MongoDB endpoint connection details.
SecretsManagerSecretId *string
// The name of the server on the MongoDB source endpoint.
ServerName *string
// The user name you use to access the MongoDB source endpoint.
Username *string
noSmithyDocumentSerde
}
// Provides information that defines a MySQL endpoint.
type MySQLSettings struct {
// Specifies a script to run immediately after DMS connects to the endpoint. The
// migration task continues running regardless if the SQL statement succeeds or
// fails. For this parameter, provide the code of the script itself, not the name
// of a file containing the script.
AfterConnectScript *string
// Adjusts the behavior of DMS when migrating from an SQL Server source database
// that is hosted as part of an Always On availability group cluster. If you need
// DMS to poll all the nodes in the Always On cluster for transaction backups, set
// this attribute to false.
CleanSourceMetadataOnMismatch *bool
// Database name for the endpoint. For a MySQL source or target endpoint, don't
// explicitly specify the database using the DatabaseName request parameter on
// either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName
// when you create or modify a MySQL endpoint replicates all the task tables to
// this single database. For MySQL endpoints, you specify the database only when
// you specify the schema in the table-mapping rules of the DMS task.
DatabaseName *string
// Specifies how often to check the binary log for new changes/events when the
// database is idle. The default is five seconds. Example: eventsPollInterval=5; In
// the example, DMS checks for changes in the binary logs every five seconds.
EventsPollInterval *int32
// Specifies the maximum size (in KB) of any .csv file used to transfer data to a
// MySQL-compatible database. Example: maxFileSize=512
MaxFileSize *int32
// Improves performance when loading data into the MySQL-compatible target
// database. Specifies how many threads to use to load the data into the
// MySQL-compatible target database. Setting a large number of threads can have an
// adverse effect on database performance, because a separate connection is
// required for each thread. The default is one. Example: parallelLoadThreads=1
ParallelLoadThreads *int32
// Endpoint connection password.
Password *string
// Endpoint TCP port.
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the MySQL endpoint. You can specify one of two sets
// of values for these permissions. You can specify the values for this setting and
// SecretsManagerSecretId. Or you can specify clear-text values for UserName,
// Password, ServerName, and Port. You can't specify both. For more information on
// creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and
// SecretsManagerSecretId required to access it, see Using secrets to access
// Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the MySQL endpoint connection details.
SecretsManagerSecretId *string
// Fully qualified domain name of the endpoint.
ServerName *string
// Specifies the time zone for the source MySQL database. Example:
// serverTimezone=US/Pacific; Note: Do not enclose time zones in single quotes.
ServerTimezone *string
// Specifies where to migrate source tables on the target, either to a single
// database or multiple databases. If you specify SPECIFIC_DATABASE, specify the
// database name using the DatabaseName parameter of the Endpoint object. Example:
// targetDbType=MULTIPLE_DATABASES
TargetDbType TargetDbType
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// Provides information that defines an Amazon Neptune endpoint.
type NeptuneSettings struct {
// A folder path where you want DMS to store migrated graph data in the S3 bucket
// specified by S3BucketName
//
// This member is required.
S3BucketFolder *string
// The name of the Amazon S3 bucket where DMS can temporarily store migrated graph
// data in .csv files before bulk-loading it to the Neptune target database. DMS
// maps the SQL source data to graph data before storing it in these .csv files.
//
// This member is required.
S3BucketName *string
// The number of milliseconds for DMS to wait to retry a bulk-load of migrated
// graph data to the Neptune target database before raising an error. The default
// is 250.
ErrorRetryDuration *int32
// If you want Identity and Access Management (IAM) authorization enabled for this
// endpoint, set this parameter to true. Then attach the appropriate IAM policy
// document to your service role specified by ServiceAccessRoleArn. The default is
// false.
IamAuthEnabled *bool
// The maximum size in kilobytes of migrated graph data stored in a .csv file
// before DMS bulk-loads the data to the Neptune target database. The default is
// 1,048,576 KB. If the bulk load is successful, DMS clears the bucket, ready to
// store the next batch of migrated graph data.
MaxFileSize *int32
// The number of times for DMS to retry a bulk load of migrated graph data to the
// Neptune target database before raising an error. The default is 5.
MaxRetryCount *int32
// The Amazon Resource Name (ARN) of the service role that you created for the
// Neptune target endpoint. The role must allow the iam:PassRole action. For more
// information, see Creating an IAM Service Role for Accessing Amazon Neptune as a
// Target
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole)
// in the Database Migration Service User Guide.
ServiceAccessRoleArn *string
noSmithyDocumentSerde
}
// Provides information that defines an Oracle endpoint.
type OracleSettings struct {
// Set this attribute to false in order to use the Binary Reader to capture change
// data for an Amazon RDS for Oracle as the source. This tells the DMS instance to
// not access redo logs through any specified path prefix replacement using direct
// file access.
AccessAlternateDirectly *bool
// Set this attribute to set up table-level supplemental logging for the Oracle
// database. This attribute enables PRIMARY KEY supplemental logging on all tables
// selected for a migration task. If you use this option, you still need to enable
// database-level supplemental logging.
AddSupplementalLogging *bool
// Set this attribute with ArchivedLogDestId in a primary/ standby setup. This
// attribute is useful in the case of a switchover. In this case, DMS needs to know
// which destination to get archive redo logs from to read changes. This need
// arises because the previous primary instance is now a standby instance after
// switchover. Although DMS supports the use of the Oracle RESETLOGS option to open
// the database, never use RESETLOGS unless necessary. For additional information
// about RESETLOGS, see RMAN Data Repair Concepts
// (https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B)
// in the Oracle Database Backup and Recovery User's Guide.
AdditionalArchivedLogDestId *int32
// Set this attribute to true to enable replication of Oracle tables containing
// columns that are nested tables or defined types.
AllowSelectNestedTables *bool
// Specifies the ID of the destination for the archived redo logs. This value
// should be the same as a number in the dest_id column of the v$archived_log view.
// If you work with an additional redo log destination, use the
// AdditionalArchivedLogDestId option to specify the additional destination ID.
// Doing this improves performance by ensuring that the correct logs are accessed
// from the outset.
ArchivedLogDestId *int32
// When this field is set to Y, DMS only accesses the archived redo logs. If the
// archived redo logs are stored on Oracle ASM only, the DMS user account needs to
// be granted ASM privileges.
ArchivedLogsOnly *bool
// For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM)
// password. You can set this value from the asm_user_password value. You set
// this value as part of the comma-separated value that you set to the Password
// request parameter when you create the endpoint to access transaction logs using
// Binary Reader. For more information, see Configuration for change data capture
// (CDC) on an Oracle source database
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).
AsmPassword *string
// For an Oracle source endpoint, your ASM server address. You can set this value
// from the asm_server value. You set asm_server as part of the extra connection
// attribute string to access an Oracle server with Binary Reader that uses ASM.
// For more information, see Configuration for change data capture (CDC) on an
// Oracle source database
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).
AsmServer *string
// For an Oracle source endpoint, your ASM user name. You can set this value from
// the asm_user value. You set asm_user as part of the extra connection attribute
// string to access an Oracle server with Binary Reader that uses ASM. For more
// information, see Configuration for change data capture (CDC) on an Oracle source
// database
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).
AsmUser *string
// Specifies whether the length of a character column is in bytes or in characters.
// To indicate that the character column length is in characters, set this
// attribute to CHAR. Otherwise, the character column length is in bytes. Example:
// charLengthSemantics=CHAR;
CharLengthSemantics CharLengthSemantics
// Database name for the endpoint.
DatabaseName *string
// When set to true, this attribute helps to increase the commit rate on the Oracle
// target database by writing directly to tables and not writing a trail to
// database logs.
DirectPathNoLog *bool
// When set to true, this attribute specifies a parallel load when
// useDirectPathFullLoad is set to Y. This attribute also only applies when you use
// the DMS parallel load feature. Note that the target table cannot have any
// constraints or indexes.
DirectPathParallelLoad *bool
// Set this attribute to enable homogenous tablespace replication and create
// existing tables or indexes under the same tablespace on the target.
EnableHomogenousTablespace *bool
// Specifies the IDs of one more destinations for one or more archived redo logs.
// These IDs are the values of the dest_id column in the v$archived_log view. Use
// this setting with the archivedLogDestId extra connection attribute in a
// primary-to-single setup or a primary-to-multiple-standby setup. This setting is
// useful in a switchover when you use an Oracle Data Guard database as a source.
// In this case, DMS needs information about what destination to get archive redo
// logs from to read changes. DMS needs this because after the switchover the
// previous primary is a standby instance. For example, in a primary-to-single
// standby setup you might apply the following settings. archivedLogDestId=1;
// ExtraArchivedLogDestIds=[2] In a primary-to-multiple-standby setup, you might
// apply the following settings. archivedLogDestId=1;
// ExtraArchivedLogDestIds=[2,3,4] Although DMS supports the use of the Oracle
// RESETLOGS option to open the database, never use RESETLOGS unless it's
// necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts
// (https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B)
// in the Oracle Database Backup and Recovery User's Guide.
ExtraArchivedLogDestIds []int32
// When set to true, this attribute causes a task to fail if the actual size of an
// LOB column is greater than the specified LobMaxSize. If a task is set to limited
// LOB mode and this option is set to true, the task fails instead of truncating
// the LOB data.
FailTasksOnLobTruncation *bool
// Specifies the number scale. You can select a scale up to 38, or you can select
// FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.
// Example: numberDataTypeScale=12
NumberDatatypeScale *int32
// Set this string attribute to the required value in order to use the Binary
// Reader to capture change data for an Amazon RDS for Oracle as the source. This
// value specifies the default Oracle root used to access the redo logs.
OraclePathPrefix *string
// Set this attribute to change the number of threads that DMS configures to
// perform a change data capture (CDC) load using Oracle Automatic Storage
// Management (ASM). You can specify an integer value between 2 (the default) and 8
// (the maximum). Use this attribute together with the readAheadBlocks attribute.
ParallelAsmReadThreads *int32
// Endpoint connection password.
Password *string
// Endpoint TCP port.
Port *int32
// Set this attribute to change the number of read-ahead blocks that DMS configures
// to perform a change data capture (CDC) load using Oracle Automatic Storage
// Management (ASM). You can specify an integer value between 1000 (the default)
// and 200,000 (the maximum).
ReadAheadBlocks *int32
// When set to true, this attribute supports tablespace replication.
ReadTableSpaceName *bool
// Set this attribute to true in order to use the Binary Reader to capture change
// data for an Amazon RDS for Oracle as the source. This setting tells DMS instance
// to replace the default Oracle root with the specified usePathPrefix setting to
// access the redo logs.
ReplacePathPrefix *bool
// Specifies the number of seconds that the system waits before resending a query.
// Example: retryInterval=6;
RetryInterval *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the Oracle endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The
// full ARN of the IAM role that specifies DMS as the trusted entity and grants the
// required permissions to access the SecretsManagerOracleAsmSecret. This
// SecretsManagerOracleAsmSecret has the secret value that allows access to the
// Oracle ASM of the endpoint. You can specify one of two sets of values for these
// permissions. You can specify the values for this setting and
// SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for
// AsmUserName, AsmPassword, and AsmServerName. You can't specify both. For more
// information on creating this SecretsManagerOracleAsmSecret and the
// SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId
// required to access it, see Using secrets to access Database Migration Service
// resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerOracleAsmAccessRoleArn *string
// Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The
// full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret
// that contains the Oracle ASM connection details for the Oracle endpoint.
SecretsManagerOracleAsmSecretId *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the Oracle endpoint connection details.
SecretsManagerSecretId *string
// For an Oracle source endpoint, the transparent data encryption (TDE) password
// required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary
// Reader. It is also the TDE_Password part of the comma-separated value you set
// to the Password request parameter when you create the endpoint. The
// SecurityDbEncryptian setting is related to this SecurityDbEncryptionName
// setting. For more information, see Supported encryption methods for using
// Oracle as a source for DMS
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption)
// in the Database Migration Service User Guide.
SecurityDbEncryption *string
// For an Oracle source endpoint, the name of a key used for the transparent data
// encryption (TDE) of the columns and tablespaces in an Oracle source database
// that is encrypted using TDE. The key value is the value of the
// SecurityDbEncryption setting. For more information on setting the key name value
// of SecurityDbEncryptionName, see the information and example for setting the
// securityDbEncryptionName extra connection attribute in Supported encryption
// methods for using Oracle as a source for DMS
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption)
// in the Database Migration Service User Guide.
SecurityDbEncryptionName *string
// Fully qualified domain name of the endpoint.
ServerName *string
// Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS
// calls the SDO2GEOJSON custom function if present and accessible. Or you can
// create your own custom function that mimics the operation of SDOGEOJSON and set
// SpatialDataOptionToGeoJsonFunctionName to call it instead.
SpatialDataOptionToGeoJsonFunctionName *string
// Use this attribute to specify a time in minutes for the delay in standby sync.
// If the source is an Oracle Active Data Guard standby database, use this
// attribute to specify the time lag between primary and standby databases. In DMS,
// you can create an Oracle CDC task that uses an Active Data Guard standby
// instance as a source for replicating ongoing changes. Doing this eliminates the
// need to connect to an active database that might be in production.
StandbyDelayTime *int32
// Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR
// data types during migration. The default value is true.
TrimSpaceInChar *bool
// Set this attribute to true in order to use the Binary Reader to capture change
// data for an Amazon RDS for Oracle as the source. This tells the DMS instance to
// use any specified prefix replacement to access all online redo logs.
UseAlternateFolderForOnline *bool
// Set this attribute to Y to capture change data using the Binary Reader utility.
// Set UseLogminerReader to N to set this attribute to Y. To use Binary Reader with
// Amazon RDS for Oracle as the source, you set additional attributes. For more
// information about using this setting with Oracle Automatic Storage Management
// (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC).
UseBFile *bool
// Set this attribute to Y to have DMS use a direct path full load. Specify this
// value to use the direct path protocol in the Oracle Call Interface (OCI). By
// using this OCI protocol, you can bulk-load Oracle target tables during a full
// load.
UseDirectPathFullLoad *bool
// Set this attribute to Y to capture change data using the Oracle LogMiner utility
// (the default). Set this attribute to N if you want to access the redo logs as a
// binary file. When you set UseLogminerReader to N, also set UseBfile to Y. For
// more information on this setting and using Oracle ASM, see Using Oracle
// LogMiner or DMS Binary Reader for CDC
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC)
// in the DMS User Guide.
UseLogminerReader *bool
// Set this string attribute to the required value in order to use the Binary
// Reader to capture change data for an Amazon RDS for Oracle as the source. This
// value specifies the path prefix used to replace the default Oracle root to
// access the redo logs.
UsePathPrefix *string
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// In response to the DescribeOrderableReplicationInstances operation, this object
// describes an available replication instance. This description includes the
// replication instance's type, engine version, and allocated storage.
type OrderableReplicationInstance struct {
// List of Availability Zones for this replication instance.
AvailabilityZones []string
// The default amount of storage (in gigabytes) that is allocated for the
// replication instance.
DefaultAllocatedStorage int32
// The version of the replication engine.
EngineVersion *string
// The amount of storage (in gigabytes) that is allocated for the replication
// instance.
IncludedAllocatedStorage int32
// The minimum amount of storage (in gigabytes) that can be allocated for the
// replication instance.
MaxAllocatedStorage int32
// The minimum amount of storage (in gigabytes) that can be allocated for the
// replication instance.
MinAllocatedStorage int32
// The value returned when the specified EngineVersion of the replication instance
// is in Beta or test mode. This indicates some features might not work as
// expected. DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
ReleaseStatus ReleaseStatusValues
// The compute and memory capacity of the replication instance as defined for the
// specified replication instance class. For example to specify the instance class
// dms.c4.large, set this parameter to "dms.c4.large". For more information on the
// settings and capacities for the available replication instance classes, see
// Selecting the right DMS replication instance for your migration
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth).
ReplicationInstanceClass *string
// The type of storage used by the replication instance.
StorageType *string
noSmithyDocumentSerde
}
// Describes a maintenance action pending for an DMS resource, including when and
// how it will be applied. This data type is a response element to the
// DescribePendingMaintenanceActions operation.
type PendingMaintenanceAction struct {
// The type of pending maintenance action that is available for the resource.
Action *string
// The date of the maintenance window when the action is to be applied. The
// maintenance action is applied to the resource during its first maintenance
// window after this date. If this date is specified, any next-maintenance opt-in
// requests are ignored.
AutoAppliedAfterDate *time.Time
// The effective date when the pending maintenance action will be applied to the
// resource. This date takes into account opt-in requests received from the
// ApplyPendingMaintenanceAction API operation, and also the AutoAppliedAfterDate
// and ForcedApplyDate parameter values. This value is blank if an opt-in request
// has not been received and nothing has been specified for AutoAppliedAfterDate or
// ForcedApplyDate.
CurrentApplyDate *time.Time
// A description providing more detail about the maintenance action.
Description *string
// The date when the maintenance action will be automatically applied. The
// maintenance action is applied to the resource on this date regardless of the
// maintenance window for the resource. If this date is specified, any immediate
// opt-in requests are ignored.
ForcedApplyDate *time.Time
// The type of opt-in request that has been received for the resource.
OptInStatus *string
noSmithyDocumentSerde
}
// Provides information that defines a PostgreSQL endpoint.
type PostgreSQLSettings struct {
// For use with change data capture (CDC) only, this attribute has DMS bypass
// foreign keys and user triggers to reduce the time it takes to bulk load data.
// Example: afterConnectScript=SET session_replication_role='replica'
AfterConnectScript *string
// To capture DDL events, DMS creates various artifacts in the PostgreSQL database
// when the task starts. You can later remove these artifacts. If this value is set
// to N, you don't have to create tables or triggers on the source database.
CaptureDdls *bool
// Database name for the endpoint.
DatabaseName *string
// The schema in which the operational DDL database artifacts are created. Example:
// ddlArtifactsSchema=xyzddlschema;
DdlArtifactsSchema *string
// Sets the client statement timeout for the PostgreSQL instance, in seconds. The
// default value is 60 seconds. Example: executeTimeout=100;
ExecuteTimeout *int32
// When set to true, this value causes a task to fail if the actual size of a LOB
// column is greater than the specified LobMaxSize. If task is set to Limited LOB
// mode and this option is set to true, the task fails instead of truncating the
// LOB data.
FailTasksOnLobTruncation *bool
// The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing
// this, it prevents idle logical replication slots from holding onto old WAL logs,
// which can result in storage full situations on the source. This heartbeat keeps
// restart_lsn moving and prevents storage full scenarios.
HeartbeatEnable *bool
// Sets the WAL heartbeat frequency (in minutes).
HeartbeatFrequency *int32
// Sets the schema in which the heartbeat artifacts are created.
HeartbeatSchema *string
// Specifies the maximum size (in KB) of any .csv file used to transfer data to
// PostgreSQL. Example: maxFileSize=512
MaxFileSize *int32
// Endpoint connection password.
Password *string
// Specifies the plugin to use to create a replication slot.
PluginName PluginNameValue
// Endpoint TCP port. The default is 5432.
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the PostgreSQL endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the PostgreSQL endpoint connection details.
SecretsManagerSecretId *string
// Fully qualified domain name of the endpoint.
ServerName *string
// Sets the name of a previously created logical replication slot for a change data
// capture (CDC) load of the PostgreSQL source instance. When used with the
// CdcStartPosition request parameter for the DMS API , this attribute also makes
// it possible to use native CDC start points. DMS verifies that the specified
// logical replication slot exists before starting the CDC load task. It also
// verifies that the task was created with a valid setting of CdcStartPosition. If
// the specified slot doesn't exist or the task doesn't have a valid
// CdcStartPosition setting, DMS raises an error. For more information about
// setting the CdcStartPosition request parameter, see Determining a CDC native
// start point in the Database Migration Service User Guide. For more information
// about using CdcStartPosition, see CreateReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html),
// StartReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html),
// and ModifyReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html).
SlotName *string
// Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR
// data types during migration. The default value is true.
TrimSpaceInChar *bool
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// Provides information that defines a Redis target endpoint.
type RedisSettings struct {
// Transmission Control Protocol (TCP) port for the endpoint.
//
// This member is required.
Port int32
// Fully qualified domain name of the endpoint.
//
// This member is required.
ServerName *string
// The password provided with the auth-role and auth-token options of the AuthType
// setting for a Redis target endpoint.
AuthPassword *string
// The type of authentication to perform when connecting to a Redis target. Options
// include none, auth-token, and auth-role. The auth-token option requires an
// AuthPassword value to be provided. The auth-role option requires AuthUserName
// and AuthPassword values to be provided.
AuthType RedisAuthTypeValue
// The user name provided with the auth-role option of the AuthType setting for a
// Redis target endpoint.
AuthUserName *string
// The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses
// to connect to your Redis target endpoint.
SslCaCertificateArn *string
// The connection to a Redis target endpoint using Transport Layer Security (TLS).
// Valid values include plaintext and ssl-encryption. The default is
// ssl-encryption. The ssl-encryption option makes an encrypted connection.
// Optionally, you can identify an Amazon Resource Name (ARN) for an SSL
// certificate authority (CA) using the SslCaCertificateArn setting. If an ARN
// isn't given for a CA, DMS uses the Amazon root CA. The plaintext option doesn't
// provide Transport Layer Security (TLS) encryption for traffic between endpoint
// and database.
SslSecurityProtocol SslSecurityProtocolValue
noSmithyDocumentSerde
}
// Provides information that defines an Amazon Redshift endpoint.
type RedshiftSettings struct {
// A value that indicates to allow any date format, including invalid formats such
// as 00/00/00 00:00:00, to be loaded without generating an error. You can choose
// true or false (the default). This parameter applies only to TIMESTAMP and DATE
// columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date
// format for the data doesn't match the DATEFORMAT specification, Amazon Redshift
// inserts a NULL value into that field.
AcceptAnyDate *bool
// Code to run after connecting. This parameter should contain the code itself, not
// the name of a file containing the code.
AfterConnectScript *string
// An S3 folder where the comma-separated-value (.csv) files are stored before
// being uploaded to the target Redshift cluster. For full load mode, DMS converts
// source records into .csv files and loads them to the BucketFolder/TableID path.
// DMS uses the Redshift COPY command to upload the .csv files to the target table.
// The files are deleted once the COPY operation has finished. For more
// information, see COPY
// (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the Amazon
// Redshift Database Developer Guide. For change-data-capture (CDC) mode, DMS
// creates a NetChanges table, and loads the .csv files to this
// BucketFolder/NetChangesTableID path.
BucketFolder *string
// The name of the intermediate S3 bucket used to store .csv files before uploading
// data to Redshift.
BucketName *string
// If Amazon Redshift is configured to support case sensitive schema names, set
// CaseSensitiveNames to true. The default is false.
CaseSensitiveNames *bool
// If you set CompUpdate to true Amazon Redshift applies automatic compression if
// the table is empty. This applies even if the table columns already have
// encodings other than RAW. If you set CompUpdate to false, automatic compression
// is disabled and existing column encodings aren't changed. The default is true.
CompUpdate *bool
// A value that sets the amount of time to wait (in milliseconds) before timing
// out, beginning from when you initially establish a connection.
ConnectionTimeout *int32
// The name of the Amazon Redshift data warehouse (service) that you are working
// with.
DatabaseName *string
// The date format that you are using. Valid values are auto (case-sensitive), your
// date format string enclosed in quotes, or NULL. If this parameter is left unset
// (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most
// strings, even some that aren't supported when you use a date format string. If
// your date and time values use formats different from each other, set this to
// auto.
DateFormat *string
// A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields
// as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default
// is false.
EmptyAsNull *bool
// The type of server-side encryption that you want to use for your data. This
// encryption type is part of the endpoint settings or the extra connections
// attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS.
// For the ModifyEndpoint operation, you can change the existing value of the
// EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the
// existing value from SSE_S3 to SSE_KMS. To use SSE_S3, create an Identity and
// Access Management (IAM) role with a policy that allows "arn:aws:s3:::*" to use
// the following actions: "s3:PutObject", "s3:ListBucket"
EncryptionMode EncryptionModeValue
// This setting is only valid for a full-load migration task. Set ExplicitIds to
// true to have tables with IDENTITY columns override their auto-generated values
// with explicit values loaded from the source data files used to populate the
// tables. The default is false.
ExplicitIds *bool
// The number of threads used to upload a single file. This parameter accepts a
// value from 1 through 64. It defaults to 10. The number of parallel streams used
// to upload a single .csv file to an S3 bucket using S3 Multipart Upload. For more
// information, see Multipart upload overview
// (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html).
// FileTransferUploadStreams accepts a value from 1 through 64. It defaults to 10.
FileTransferUploadStreams *int32
// The amount of time to wait (in milliseconds) before timing out of operations
// performed by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE,
// and UPDATE.
LoadTimeout *int32
// The maximum size (in KB) of any .csv file used to load data on an S3 bucket and
// transfer data to Amazon Redshift. It defaults to 1048576KB (1 GB).
MaxFileSize *int32
// The password for the user named in the username property.
Password *string
// The port number for Amazon Redshift. The default value is 5439.
Port *int32
// A value that specifies to remove surrounding quotation marks from strings in the
// incoming data. All characters within the quotation marks, including delimiters,
// are retained. Choose true to remove quotation marks. The default is false.
RemoveQuotes *bool
// A value that specifies to replaces the invalid characters specified in
// ReplaceInvalidChars, substituting the specified characters instead. The default
// is "?".
ReplaceChars *string
// A list of characters that you want to replace. Use with ReplaceChars.
ReplaceInvalidChars *string
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the Amazon Redshift endpoint. You can specify one
// of two sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the Amazon Redshift endpoint connection details.
SecretsManagerSecretId *string
// The name of the Amazon Redshift cluster you are using.
ServerName *string
// The KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this
// key ID. The key that you use needs an attached policy that enables IAM user
// permissions and allows use of the key.
ServerSideEncryptionKmsKeyId *string
// The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon
// Redshift service. The role must allow the iam:PassRole action.
ServiceAccessRoleArn *string
// The time format that you want to use. Valid values are auto (case-sensitive),
// 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using
// auto recognizes most strings, even some that aren't supported when you use a
// time format string. If your date and time values use formats different from each
// other, set this parameter to auto.
TimeFormat *string
// A value that specifies to remove the trailing white space characters from a
// VARCHAR string. This parameter applies only to columns with a VARCHAR data type.
// Choose true to remove unneeded white space. The default is false.
TrimBlanks *bool
// A value that specifies to truncate data in columns to the appropriate number of
// characters, so that the data fits in the column. This parameter applies only to
// columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less.
// Choose true to truncate data. The default is false.
TruncateColumns *bool
// An Amazon Redshift user name for a registered user.
Username *string
// The size (in KB) of the in-memory file write buffer used when generating .csv
// files on the local disk at the DMS replication instance. The default value is
// 1000 (buffer size is 1000KB).
WriteBufferSize *int32
noSmithyDocumentSerde
}
// Provides information that describes status of a schema at an endpoint specified
// by the DescribeRefreshSchemaStatus operation.
type RefreshSchemasStatus struct {
// The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
EndpointArn *string
// The last failure message for the schema.
LastFailureMessage *string
// The date the schema was last refreshed.
LastRefreshDate *time.Time
// The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstanceArn *string
// The status of the schema.
Status RefreshSchemasStatusTypeValue
noSmithyDocumentSerde
}
// Provides information that defines a replication instance.
type ReplicationInstance struct {
// The amount of storage (in gigabytes) that is allocated for the replication
// instance.
AllocatedStorage int32
// Boolean value indicating if minor version upgrades will be automatically applied
// to the instance.
AutoMinorVersionUpgrade bool
// The Availability Zone for the instance.
AvailabilityZone *string
// The DNS name servers supported for the replication instance to access your
// on-premise source or target database.
DnsNameServers *string
// The engine version number of the replication instance. If an engine version
// number is not specified when a replication instance is created, the default is
// the latest engine version available. When modifying a major engine version of an
// instance, also set AllowMajorVersionUpgrade to true.
EngineVersion *string
// The expiration date of the free replication instance that is part of the Free
// DMS program.
FreeUntil *time.Time
// The time the replication instance was created.
InstanceCreateTime *time.Time
// An KMS key identifier that is used to encrypt the data on the replication
// instance. If you don't specify a value for the KmsKeyId parameter, then DMS uses
// your default encryption key. KMS creates the default encryption key for your
// Amazon Web Services account. Your Amazon Web Services account has a different
// default encryption key for each Amazon Web Services Region.
KmsKeyId *string
// Specifies whether the replication instance is a Multi-AZ deployment. You can't
// set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
MultiAZ bool
// The pending modification values.
PendingModifiedValues *ReplicationPendingModifiedValues
// The maintenance window times for the replication instance. Any pending upgrades
// to the replication instance are performed during this time.
PreferredMaintenanceWindow *string
// Specifies the accessibility options for the replication instance. A value of
// true represents an instance with a public IP address. A value of false
// represents an instance with a private IP address. The default value is true.
PubliclyAccessible bool
// The Amazon Resource Name (ARN) of the replication instance.
ReplicationInstanceArn *string
// The compute and memory capacity of the replication instance as defined for the
// specified replication instance class. It is a required parameter, although a
// default value is pre-selected in the DMS console. For more information on the
// settings and capacities for the available replication instance classes, see
// Selecting the right DMS replication instance for your migration
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth).
ReplicationInstanceClass *string
// The replication instance identifier is a required parameter. This parameter is
// stored as a lowercase string. Constraints:
//
// * Must contain 1-63 alphanumeric
// characters or hyphens.
//
// * First character must be a letter.
//
// * Cannot end with a
// hyphen or contain two consecutive hyphens.
//
// Example: myrepinstance
ReplicationInstanceIdentifier *string
// The private IP address of the replication instance.
//
// Deprecated: This member has been deprecated.
ReplicationInstancePrivateIpAddress *string
// One or more private IP addresses for the replication instance.
ReplicationInstancePrivateIpAddresses []string
// The public IP address of the replication instance.
//
// Deprecated: This member has been deprecated.
ReplicationInstancePublicIpAddress *string
// One or more public IP addresses for the replication instance.
ReplicationInstancePublicIpAddresses []string
// The status of the replication instance. The possible return values include:
//
// *
// "available"
//
// * "creating"
//
// * "deleted"
//
// * "deleting"
//
// * "failed"
//
// *
// "modifying"
//
// * "upgrading"
//
// * "rebooting"
//
// * "resetting-master-credentials"
//
// *
// "storage-full"
//
// * "incompatible-credentials"
//
// * "incompatible-network"
//
// *
// "maintenance"
ReplicationInstanceStatus *string
// The subnet group for the replication instance.
ReplicationSubnetGroup *ReplicationSubnetGroup
// The Availability Zone of the standby replication instance in a Multi-AZ
// deployment.
SecondaryAvailabilityZone *string
// The VPC security group for the instance.
VpcSecurityGroups []VpcSecurityGroupMembership
noSmithyDocumentSerde
}
// Contains metadata for a replication instance task log.
type ReplicationInstanceTaskLog struct {
// The size, in bytes, of the replication task log.
ReplicationInstanceTaskLogSize int64
// The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskArn *string
// The name of the replication task.
ReplicationTaskName *string
noSmithyDocumentSerde
}
// Provides information about the values of pending modifications to a replication
// instance. This data type is an object of the ReplicationInstance
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_ReplicationInstance.html)
// user-defined data type.
type ReplicationPendingModifiedValues struct {
// The amount of storage (in gigabytes) that is allocated for the replication
// instance.
AllocatedStorage *int32
// The engine version number of the replication instance.
EngineVersion *string
// Specifies whether the replication instance is a Multi-AZ deployment. You can't
// set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.
MultiAZ *bool
// The compute and memory capacity of the replication instance as defined for the
// specified replication instance class. For more information on the settings and
// capacities for the available replication instance classes, see Selecting the
// right DMS replication instance for your migration
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth).
ReplicationInstanceClass *string
noSmithyDocumentSerde
}
// Describes a subnet group in response to a request by the
// DescribeReplicationSubnetGroups operation.
type ReplicationSubnetGroup struct {
// A description for the replication subnet group.
ReplicationSubnetGroupDescription *string
// The identifier of the replication instance subnet group.
ReplicationSubnetGroupIdentifier *string
// The status of the subnet group.
SubnetGroupStatus *string
// The subnets that are in the subnet group.
Subnets []Subnet
// The ID of the VPC.
VpcId *string
noSmithyDocumentSerde
}
// Provides information that describes a replication task created by the
// CreateReplicationTask operation.
type ReplicationTask struct {
// Indicates when you want a change data capture (CDC) operation to start. Use
// either CdcStartPosition or CdcStartTime to specify when you want the CDC
// operation to start. Specifying both values results in an error. The value can be
// in date, checkpoint, or LSN/SCN format. Date Example: --cdc-start-position
// “2018-03-08T12:12:12” Checkpoint Example: --cdc-start-position
// "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
// LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
CdcStartPosition *string
// Indicates when you want a change data capture (CDC) operation to stop. The value
// can be either server time or commit time. Server time example:
// --cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example:
// --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “
CdcStopPosition *string
// The last error (failure) message generated for the replication task.
LastFailureMessage *string
// The type of migration.
MigrationType MigrationTypeValue
// Indicates the last checkpoint that occurred during a change data capture (CDC)
// operation. You can provide this value to the CdcStartPosition parameter to start
// a CDC operation that begins at that checkpoint.
RecoveryCheckpoint *string
// The ARN of the replication instance.
ReplicationInstanceArn *string
// The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskArn *string
// The date the replication task was created.
ReplicationTaskCreationDate *time.Time
// The user-assigned replication task identifier or name. Constraints:
//
// * Must
// contain 1-255 alphanumeric characters or hyphens.
//
// * First character must be a
// letter.
//
// * Cannot end with a hyphen or contain two consecutive hyphens.
ReplicationTaskIdentifier *string
// The settings for the replication task.
ReplicationTaskSettings *string
// The date the replication task is scheduled to start.
ReplicationTaskStartDate *time.Time
// The statistics for the task, including elapsed time, tables loaded, and table
// errors.
ReplicationTaskStats *ReplicationTaskStats
// The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
SourceEndpointArn *string
// The status of the replication task. This response parameter can return one of
// the following values:
//
// * "moving" – The task is being moved in response to
// running the MoveReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html)
// operation.
//
// * "creating" – The task is being created in response to running the
// CreateReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html)
// operation.
//
// * "deleting" – The task is being deleted in response to running the
// DeleteReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html)
// operation.
//
// * "failed" – The task failed to successfully complete the database
// migration in response to running the StartReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
// operation.
//
// * "failed-move" – The task failed to move in response to running the
// MoveReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html)
// operation.
//
// * "modifying" – The task definition is being modified in response to
// running the ModifyReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html)
// operation.
//
// * "ready" – The task is in a ready state where it can respond to
// other task operations, such as StartReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
// or DeleteReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html).
//
// *
// "running" – The task is performing a database migration in response to running
// the StartReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
// operation.
//
// * "starting" – The task is preparing to perform a database migration
// in response to running the StartReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html)
// operation.
//
// * "stopped" – The task has stopped in response to running the
// StopReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html)
// operation.
//
// * "stopping" – The task is preparing to stop in response to running
// the StopReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html)
// operation.
//
// * "testing" – The database migration specified for this task is
// being tested in response to running either the StartReplicationTaskAssessmentRun
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html)
// or the StartReplicationTaskAssessment
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html)
// operation. StartReplicationTaskAssessmentRun
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html)
// is an improved premigration task assessment operation. The
// StartReplicationTaskAssessment
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html)
// operation assesses data type compatibility only between the source and target
// database of a given migration task. In contrast,
// StartReplicationTaskAssessmentRun
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html)
// enables you to specify a variety of premigration task assessments in addition to
// data type compatibility. These assessments include ones for the validity of
// primary key definitions and likely issues with database migration performance,
// among others.
Status *string
// The reason the replication task was stopped. This response parameter can return
// one of the following values:
//
// * "Stop Reason NORMAL"
//
// * "Stop Reason
// RECOVERABLE_ERROR"
//
// * "Stop Reason FATAL_ERROR"
//
// * "Stop Reason
// FULL_LOAD_ONLY_FINISHED"
//
// * "Stop Reason STOPPED_AFTER_FULL_LOAD" – Full load
// completed, with cached changes not applied
//
// * "Stop Reason
// STOPPED_AFTER_CACHED_EVENTS" – Full load completed, with cached changes
// applied
//
// * "Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
//
// * "Stop Reason
// STOPPED_AFTER_DDL_APPLY" – User-defined stop task after DDL applied
//
// * "Stop
// Reason STOPPED_DUE_TO_LOW_MEMORY"
//
// * "Stop Reason STOPPED_DUE_TO_LOW_DISK"
//
// *
// "Stop Reason STOPPED_AT_SERVER_TIME" – User-defined server time for stopping
// task
//
// * "Stop Reason STOPPED_AT_COMMIT_TIME" – User-defined commit time for
// stopping task
//
// * "Stop Reason RECONFIGURATION_RESTART"
//
// * "Stop Reason
// RECYCLE_TASK"
StopReason *string
// Table mappings specified in the task.
TableMappings *string
// The ARN that uniquely identifies the endpoint.
TargetEndpointArn *string
// The ARN of the replication instance to which this task is moved in response to
// running the MoveReplicationTask
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html)
// operation. Otherwise, this response parameter isn't a member of the
// ReplicationTask object.
TargetReplicationInstanceArn *string
// Supplemental information that the task requires to migrate the data for certain
// source and target endpoints. For more information, see Specifying Supplemental
// Data for Task Settings
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in
// the Database Migration Service User Guide.
TaskData *string
noSmithyDocumentSerde
}
// The task assessment report in JSON format.
type ReplicationTaskAssessmentResult struct {
// The task assessment results in JSON format. The response object only contains
// this field if you provide
// DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the
// request.
AssessmentResults *string
// The file containing the results of the task assessment.
AssessmentResultsFile *string
// The status of the task assessment.
AssessmentStatus *string
// The Amazon Resource Name (ARN) of the replication task.
ReplicationTaskArn *string
// The replication task identifier of the task on which the task assessment was
// run.
ReplicationTaskIdentifier *string
// The date the task assessment was completed.
ReplicationTaskLastAssessmentDate *time.Time
// The URL of the S3 object containing the task assessment results. The response
// object only contains this field if you provide
// DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn in the
// request.
S3ObjectUrl *string
noSmithyDocumentSerde
}
// Provides information that describes a premigration assessment run that you have
// started using the StartReplicationTaskAssessmentRun operation. Some of the
// information appears based on other operations that can return the
// ReplicationTaskAssessmentRun object.
type ReplicationTaskAssessmentRun struct {
// Indication of the completion progress for the individual assessments specified
// to run.
AssessmentProgress *ReplicationTaskAssessmentRunProgress
// Unique name of the assessment run.
AssessmentRunName *string
// Last message generated by an individual assessment failure.
LastFailureMessage *string
// ARN of the migration task associated with this premigration assessment run.
ReplicationTaskArn *string
// Amazon Resource Name (ARN) of this assessment run.
ReplicationTaskAssessmentRunArn *string
// Date on which the assessment run was created using the
// StartReplicationTaskAssessmentRun operation.
ReplicationTaskAssessmentRunCreationDate *time.Time
// Encryption mode used to encrypt the assessment run results.
ResultEncryptionMode *string
// ARN of the KMS encryption key used to encrypt the assessment run results.
ResultKmsKeyArn *string
// Amazon S3 bucket where DMS stores the results of this assessment run.
ResultLocationBucket *string
// Folder in an Amazon S3 bucket where DMS stores the results of this assessment
// run.
ResultLocationFolder *string
// ARN of the service role used to start the assessment run using the
// StartReplicationTaskAssessmentRun operation. The role must allow the
// iam:PassRole action.
ServiceAccessRoleArn *string
// Assessment run status. This status can have one of the following values:
//
// *
// "cancelling" – The assessment run was canceled by the
// CancelReplicationTaskAssessmentRun operation.
//
// * "deleting" – The assessment run
// was deleted by the DeleteReplicationTaskAssessmentRun operation.
//
// * "failed" –
// At least one individual assessment completed with a failed status.
//
// *
// "error-provisioning" – An internal error occurred while resources were
// provisioned (during provisioning status).
//
// * "error-executing" – An internal
// error occurred while individual assessments ran (during running status).
//
// *
// "invalid state" – The assessment run is in an unknown state.
//
// * "passed" – All
// individual assessments have completed, and none has a failed status.
//
// *
// "provisioning" – Resources required to run individual assessments are being
// provisioned.
//
// * "running" – Individual assessments are being run.
//
// * "starting"
// – The assessment run is starting, but resources are not yet being provisioned
// for individual assessments.
Status *string
noSmithyDocumentSerde
}
// The progress values reported by the AssessmentProgress response element.
type ReplicationTaskAssessmentRunProgress struct {
// The number of individual assessments that have completed, successfully or not.
IndividualAssessmentCompletedCount int32
// The number of individual assessments that are specified to run.
IndividualAssessmentCount int32
noSmithyDocumentSerde
}
// Provides information that describes an individual assessment from a premigration
// assessment run.
type ReplicationTaskIndividualAssessment struct {
// Name of this individual assessment.
IndividualAssessmentName *string
// ARN of the premigration assessment run that is created to run this individual
// assessment.
ReplicationTaskAssessmentRunArn *string
// Amazon Resource Name (ARN) of this individual assessment.
ReplicationTaskIndividualAssessmentArn *string
// Date when this individual assessment was started as part of running the
// StartReplicationTaskAssessmentRun operation.
ReplicationTaskIndividualAssessmentStartDate *time.Time
// Individual assessment status. This status can have one of the following
// values:
//
// * "cancelled"
//
// * "error"
//
// * "failed"
//
// * "passed"
//
// * "pending"
//
// *
// "running"
Status *string
noSmithyDocumentSerde
}
// In response to a request by the DescribeReplicationTasks operation, this object
// provides a collection of statistics about a replication task.
type ReplicationTaskStats struct {
// The elapsed time of the task, in milliseconds.
ElapsedTimeMillis int64
// The date the replication task was started either with a fresh start or a target
// reload.
FreshStartDate *time.Time
// The date the replication task full load was completed.
FullLoadFinishDate *time.Time
// The percent complete for the full load migration task.
FullLoadProgressPercent int32
// The date the replication task full load was started.
FullLoadStartDate *time.Time
// The date the replication task was started either with a fresh start or a resume.
// For more information, see StartReplicationTaskType
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html#DMS-StartReplicationTask-request-StartReplicationTaskType).
StartDate *time.Time
// The date the replication task was stopped.
StopDate *time.Time
// The number of errors that have occurred during this task.
TablesErrored int32
// The number of tables loaded for this task.
TablesLoaded int32
// The number of tables currently loading for this task.
TablesLoading int32
// The number of tables queued for this task.
TablesQueued int32
noSmithyDocumentSerde
}
// Identifies an DMS resource and any pending actions for it.
type ResourcePendingMaintenanceActions struct {
// Detailed information about the pending maintenance action.
PendingMaintenanceActionDetails []PendingMaintenanceAction
// The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance
// action applies to. For information about creating an ARN, see Constructing an
// Amazon Resource Name (ARN) for DMS
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Introduction.AWS.ARN.html)
// in the DMS documentation.
ResourceIdentifier *string
noSmithyDocumentSerde
}
// Settings for exporting data to Amazon S3.
type S3Settings struct {
// An optional parameter that, when set to true or y, you can use to add column
// name information to the .csv output file. The default value is false. Valid
// values are true, false, y, and n.
AddColumnName *bool
// Use the S3 target endpoint setting AddTrailingPaddingCharacter to add padding on
// string data. The default value is false.
AddTrailingPaddingCharacter *bool
// An optional parameter to set a folder name in the S3 bucket. If provided, tables
// are created in the path bucketFolder/schema_name/table_name/. If this parameter
// isn't specified, then the path used is schema_name/table_name/.
BucketFolder *string
// The name of the S3 bucket.
BucketName *string
// A value that enables DMS to specify a predefined (canned) access control list
// for objects created in an Amazon S3 bucket as .csv or .parquet files. For more
// information about Amazon S3 canned ACLs, see Canned ACL
// (http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in
// the Amazon S3 Developer Guide. The default value is NONE. Valid values include
// NONE, PRIVATE, PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ,
// AWS_EXEC_READ, BUCKET_OWNER_READ, and BUCKET_OWNER_FULL_CONTROL.
CannedAclForObjects CannedAclForObjectsValue
// A value that enables a change data capture (CDC) load to write INSERT and UPDATE
// operations to .csv or .parquet (columnar storage) output files. The default
// setting is false, but when CdcInsertsAndUpdates is set to true or y, only
// INSERTs and UPDATEs from the source database are migrated to the .csv or
// .parquet file. For .csv file format only, how these INSERTs and UPDATEs are
// recorded depends on the value of the IncludeOpForFullLoad parameter. If
// IncludeOpForFullLoad is set to true, the first field of every CDC record is set
// to either I or U to indicate INSERT and UPDATE operations at the source. But if
// IncludeOpForFullLoad is set to false, CDC records are written without an
// indication of INSERT or UPDATE operations at the source. For more information
// about how these settings work together, see Indicating Source DB Operations in
// Migrated S3 Data
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps)
// in the Database Migration Service User Guide.. DMS supports the use of the
// CdcInsertsAndUpdates parameter in versions 3.3.1 and later. CdcInsertsOnly and
// CdcInsertsAndUpdates can't both be set to true for the same endpoint. Set either
// CdcInsertsOnly or CdcInsertsAndUpdates to true for the same endpoint, but not
// both.
CdcInsertsAndUpdates *bool
// A value that enables a change data capture (CDC) load to write only INSERT
// operations to .csv or columnar storage (.parquet) output files. By default (the
// false setting), the first field in a .csv or .parquet record contains the letter
// I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was
// inserted, updated, or deleted at the source database for a CDC load to the
// target. If CdcInsertsOnly is set to true or y, only INSERTs from the source
// database are migrated to the .csv or .parquet file. For .csv format only, how
// these INSERTs are recorded depends on the value of IncludeOpForFullLoad. If
// IncludeOpForFullLoad is set to true, the first field of every CDC record is set
// to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is
// set to false, every CDC record is written without a first field to indicate the
// INSERT operation at the source. For more information about how these settings
// work together, see Indicating Source DB Operations in Migrated S3 Data
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps)
// in the Database Migration Service User Guide.. DMS supports the interaction
// described preceding between the CdcInsertsOnly and IncludeOpForFullLoad
// parameters in versions 3.1.4 and later. CdcInsertsOnly and CdcInsertsAndUpdates
// can't both be set to true for the same endpoint. Set either CdcInsertsOnly or
// CdcInsertsAndUpdates to true for the same endpoint, but not both.
CdcInsertsOnly *bool
// Maximum length of the interval, defined in seconds, after which to output a file
// to Amazon S3. When CdcMaxBatchInterval and CdcMinFileSize are both specified,
// the file write is triggered by whichever parameter condition is met first within
// an DMS CloudFormation template. The default value is 60 seconds.
CdcMaxBatchInterval *int32
// Minimum file size, defined in megabytes, to reach for a file output to Amazon
// S3. When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file
// write is triggered by whichever parameter condition is met first within an DMS
// CloudFormation template. The default value is 32 MB.
CdcMinFileSize *int32
// Specifies the folder path of CDC files. For an S3 source, this setting is
// required if a task captures change data; otherwise, it's optional. If CdcPath is
// set, DMS reads CDC files from this path and replicates the data changes to the
// target endpoint. For an S3 target if you set PreserveTransactions
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions)
// to true, DMS verifies that you have set this parameter to a folder path on your
// S3 target where DMS can save the transaction order for the CDC load. DMS creates
// this CDC folder path in either your S3 target working directory or the S3 target
// location specified by BucketFolder
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder)
// and BucketName
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName).
// For example, if you specify CdcPath as MyChangedData, and you specify BucketName
// as MyTargetBucket but do not specify BucketFolder, DMS creates the CDC folder
// path following: MyTargetBucket/MyChangedData. If you specify the same CdcPath,
// and you specify BucketName as MyTargetBucket and BucketFolder as MyTargetData,
// DMS creates the CDC folder path following:
// MyTargetBucket/MyTargetData/MyChangedData. For more information on CDC including
// transaction order on an S3 target, see Capturing data changes (CDC) including
// transaction order on the S3 target
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath).
// This setting is supported in DMS versions 3.4.2 and later.
CdcPath *string
// An optional parameter to use GZIP to compress the target files. Set to GZIP to
// compress the target files. Either set this parameter to NONE (the default) or
// don't use it to leave the files uncompressed. This parameter applies to both
// .csv and .parquet file formats.
CompressionType CompressionTypeValue
// The delimiter used to separate columns in the .csv file for both source and
// target. The default is a comma.
CsvDelimiter *string
// This setting only applies if your Amazon S3 output files during a change data
// capture (CDC) load are written in .csv format. If UseCsvNoSupValue
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue)
// is set to true, specify a string value that you want DMS to use for all columns
// not included in the supplemental log. If you do not specify a string value, DMS
// uses the null value for these columns regardless of the UseCsvNoSupValue
// setting. This setting is supported in DMS versions 3.4.1 and later.
CsvNoSupValue *string
// An optional parameter that specifies how DMS treats null values. While handling
// the null value, you can use this parameter to pass a user-defined string as null
// when writing to the target. For example, when target columns are not nullable,
// you can use this option to differentiate between the empty string value and the
// null value. So, if you set this parameter value to the empty string ("" or ''),
// DMS treats the empty string as the null value instead of NULL. The default value
// is NULL. Valid values include any valid string.
CsvNullValue *string
// The delimiter used to separate rows in the .csv file for both source and target.
// The default is a carriage return (\n).
CsvRowDelimiter *string
// The format of the data that you want to use for output. You can choose one of
// the following:
//
// * csv : This is a row-based file format with comma-separated
// values (.csv).
//
// * parquet : Apache Parquet (.parquet) is a columnar storage file
// format that features efficient compression and provides faster query response.
DataFormat DataFormatValue
// The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes
// (1 MiB). This number is used for .parquet file format only.
DataPageSize *int32
// Specifies a date separating delimiter to use during folder partitioning. The
// default value is SLASH. Use this parameter when DatePartitionedEnabled is set to
// true.
DatePartitionDelimiter DatePartitionDelimiterValue
// When set to true, this parameter partitions S3 bucket folders based on
// transaction commit dates. The default value is false. For more information about
// date-based folder partitioning, see Using date-based folder partitioning
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning).
DatePartitionEnabled *bool
// Identifies the sequence of the date format to use during folder partitioning.
// The default value is YYYYMMDD. Use this parameter when DatePartitionedEnabled is
// set to true.
DatePartitionSequence DatePartitionSequenceValue
// When creating an S3 target endpoint, set DatePartitionTimezone to convert the
// current UTC time into a specified time zone. The conversion occurs when a date
// partition folder is created and a CDC filename is generated. The time zone
// format is Area/Location. Use this parameter when DatePartitionedEnabled is set
// to true, as shown in the following example.
// s3-settings='{"DatePartitionEnabled": true, "DatePartitionSequence":
// "YYYYMMDDHH", "DatePartitionDelimiter": "SLASH",
// "DatePartitionTimezone":"Asia/Seoul", "BucketName": "dms-nattarat-test"}'
DatePartitionTimezone *string
// The maximum size of an encoded dictionary page of a column. If the dictionary
// page exceeds this, this column is stored using an encoding type of PLAIN. This
// parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a
// dictionary page before it reverts to PLAIN encoding. This size is used for
// .parquet file format only.
DictPageSizeLimit *int32
// A value that enables statistics for Parquet pages and row groups. Choose true to
// enable statistics, false to disable. Statistics include NULL, DISTINCT, MAX, and
// MIN values. This parameter defaults to true. This value is used for .parquet
// file format only.
EnableStatistics *bool
// The type of encoding you are using:
//
// * RLE_DICTIONARY uses a combination of
// bit-packing and run-length encoding to store repeated values more efficiently.
// This is the default.
//
// * PLAIN doesn't use encoding at all. Values are stored as
// they are.
//
// * PLAIN_DICTIONARY builds a dictionary of the values encountered in a
// given column. The dictionary is stored in a dictionary page for each column
// chunk.
EncodingType EncodingTypeValue
// The type of server-side encryption that you want to use for your data. This
// encryption type is part of the endpoint settings or the extra connections
// attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS.
// For the ModifyEndpoint operation, you can change the existing value of the
// EncryptionMode parameter from SSE_KMS to SSE_S3. But you can’t change the
// existing value from SSE_S3 to SSE_KMS. To use SSE_S3, you need an Identity and
// Access Management (IAM) role with permission to allow "arn:aws:s3:::dms-*" to
// use the following actions:
//
// * s3:CreateBucket
//
// * s3:ListBucket
//
// *
// s3:DeleteBucket
//
// * s3:GetBucketLocation
//
// * s3:GetObject
//
// * s3:PutObject
//
// *
// s3:DeleteObject
//
// * s3:GetObjectVersion
//
// * s3:GetBucketPolicy
//
// *
// s3:PutBucketPolicy
//
// * s3:DeleteBucketPolicy
EncryptionMode EncryptionModeValue
// To specify a bucket owner and prevent sniping, you can use the
// ExpectedBucketOwner endpoint setting. Example:
// --s3-settings='{"ExpectedBucketOwner": "AWS_Account_ID"}' When you make a
// request to test a connection or perform a migration, S3 checks the account ID of
// the bucket owner against the specified parameter.
ExpectedBucketOwner *string
// Specifies how tables are defined in the S3 source files only.
ExternalTableDefinition *string
// When this value is set to 1, DMS ignores the first row header in a .csv file. A
// value of 1 turns on the feature; a value of 0 turns off the feature. The default
// is 0.
IgnoreHeaderRows *int32
// A value that enables a full load to write INSERT operations to the
// comma-separated value (.csv) output files only to indicate how the rows were
// added to the source database. DMS supports the IncludeOpForFullLoad parameter in
// versions 3.1.4 and later. For full load, records can only be inserted. By
// default (the false setting), no information is recorded in these output files
// for a full load to indicate that the rows were inserted at the source database.
// If IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I
// annotation in the first field of the .csv file. This allows the format of your
// target records from a full load to be consistent with the target records from a
// CDC load. This setting works together with the CdcInsertsOnly and the
// CdcInsertsAndUpdates parameters for output to .csv files only. For more
// information about how these settings work together, see Indicating Source DB
// Operations in Migrated S3 Data
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps)
// in the Database Migration Service User Guide..
IncludeOpForFullLoad *bool
// A value that specifies the maximum size (in KB) of any .csv file to be created
// while migrating to an S3 target during full load. The default value is 1,048,576
// KB (1 GB). Valid values include 1 to 1,048,576.
MaxFileSize *int32
// A value that specifies the precision of any TIMESTAMP column values that are
// written to an Amazon S3 object file in .parquet format. DMS supports the
// ParquetTimestampInMillisecond parameter in versions 3.1.4 and later. When
// ParquetTimestampInMillisecond is set to true or y, DMS writes all TIMESTAMP
// columns in a .parquet formatted file with millisecond precision. Otherwise, DMS
// writes them with microsecond precision. Currently, Amazon Athena and Glue can
// handle only millisecond precision for TIMESTAMP values. Set this parameter to
// true for S3 endpoint object files that are .parquet formatted only if you plan
// to query or process the data with Athena or Glue. DMS writes any TIMESTAMP
// column values written to an S3 file in .csv format with microsecond precision.
// Setting ParquetTimestampInMillisecond has no effect on the string format of the
// timestamp column value that is inserted by setting the TimestampColumnName
// parameter.
ParquetTimestampInMillisecond *bool
// The version of the Apache Parquet format that you want to use: parquet_1_0 (the
// default) or parquet_2_0.
ParquetVersion ParquetVersionValue
// If set to true, DMS saves the transaction order for a change data capture (CDC)
// load on the Amazon S3 target specified by CdcPath
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath).
// For more information, see Capturing data changes (CDC) including transaction
// order on the S3 target
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath).
// This setting is supported in DMS versions 3.4.2 and later.
PreserveTransactions *bool
// For an S3 source, when this value is set to true or y, each leading double
// quotation mark has to be followed by an ending double quotation mark. This
// formatting complies with RFC 4180. When this value is set to false or n, string
// literals are copied to the target as is. In this case, a delimiter (row or
// column) signals the end of the field. Thus, you can't use a delimiter as part of
// the string, because it signals the end of the value. For an S3 target, an
// optional parameter used to set behavior to comply with RFC 4180 for data
// migrated to Amazon S3 using .csv file format only. When this value is set to
// true or y using Amazon S3 as a target, if the data has quotation marks or
// newline characters in it, DMS encloses the entire column with an additional pair
// of double quotation marks ("). Every quotation mark within the data is repeated
// twice. The default value is true. Valid values include true, false, y, and n.
Rfc4180 *bool
// The number of rows in a row group. A smaller row group size provides faster
// reads. But as the number of row groups grows, the slower writes become. This
// parameter defaults to 10,000 rows. This number is used for .parquet file format
// only. If you choose a value larger than the maximum, RowGroupLength is set to
// the max row group length in bytes (64 * 1024 * 1024).
RowGroupLength *int32
// If you are using SSE_KMS for the EncryptionMode, provide the KMS key ID. The key
// that you use needs an attached policy that enables Identity and Access
// Management (IAM) user permissions and allows use of the key. Here is a CLI
// example: aws dms create-endpoint --endpoint-identifier value --endpoint-type
// target --engine-name s3 --s3-settings
// ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value
ServerSideEncryptionKmsKeyId *string
// The Amazon Resource Name (ARN) used by the service to access the IAM role. The
// role must allow the iam:PassRole action. It is a required parameter that enables
// DMS to write and read objects from an S3 bucket.
ServiceAccessRoleArn *string
// A value that when nonblank causes DMS to add a column with timestamp information
// to the endpoint data for an Amazon S3 target. DMS supports the
// TimestampColumnName parameter in versions 3.1.4 and later. DMS includes an
// additional STRING column in the .csv or .parquet object files of your migrated
// data when you set TimestampColumnName to a nonblank value. For a full load, each
// row of this timestamp column contains a timestamp for when the data was
// transferred from the source to the target by DMS. For a change data capture
// (CDC) load, each row of the timestamp column contains the timestamp for the
// commit of that row in the source database. The string format for this timestamp
// column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this
// value is in microseconds. For a CDC load, the rounding of the precision depends
// on the commit timestamp supported by DMS for the source database. When the
// AddColumnName parameter is set to true, DMS also includes a name for the
// timestamp column that you set with TimestampColumnName.
TimestampColumnName *string
// This setting applies if the S3 output files during a change data capture (CDC)
// load are written in .csv format. If set to true for columns not included in the
// supplemental log, DMS uses the value specified by CsvNoSupValue
// (https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue).
// If not set or set to false, DMS uses the null value for these columns. This
// setting is supported in DMS versions 3.4.1 and later.
UseCsvNoSupValue *bool
// When set to true, this parameter uses the task start time as the timestamp
// column value instead of the time data is written to target. For full load, when
// useTaskStartTimeForFullLoadTimestamp is set to true, each row of the timestamp
// column contains the task start time. For CDC loads, each row of the timestamp
// column contains the transaction commit time. When
// useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp in
// the timestamp column increments with the time data arrives at the target.
UseTaskStartTimeForFullLoadTimestamp *bool
noSmithyDocumentSerde
}
// Describes a schema in a Fleet Advisor collector inventory.
type SchemaResponse struct {
// The number of lines of code in a schema in a Fleet Advisor collector inventory.
CodeLineCount *int64
// The size level of the code in a schema in a Fleet Advisor collector inventory.
CodeSize *int64
// The complexity level of the code in a schema in a Fleet Advisor collector
// inventory.
Complexity *string
// The database for a schema in a Fleet Advisor collector inventory.
DatabaseInstance *DatabaseShortInfoResponse
// Describes a schema in a Fleet Advisor collector inventory.
OriginalSchema *SchemaShortInfoResponse
// The ID of a schema in a Fleet Advisor collector inventory.
SchemaId *string
// The name of a schema in a Fleet Advisor collector inventory.
SchemaName *string
// The database server for a schema in a Fleet Advisor collector inventory.
Server *ServerShortInfoResponse
// The similarity value for a schema in a Fleet Advisor collector inventory. A
// higher similarity value indicates that a schema is likely to be a duplicate.
Similarity *float64
noSmithyDocumentSerde
}
// Describes a schema in a Fleet Advisor collector inventory.
type SchemaShortInfoResponse struct {
// The ID of a database in a Fleet Advisor collector inventory.
DatabaseId *string
// The IP address of a database in a Fleet Advisor collector inventory.
DatabaseIpAddress *string
// The name of a database in a Fleet Advisor collector inventory.
DatabaseName *string
// The ID of a schema in a Fleet Advisor collector inventory.
SchemaId *string
// The name of a schema in a Fleet Advisor collector inventory.
SchemaName *string
noSmithyDocumentSerde
}
// Describes a server in a Fleet Advisor collector inventory.
type ServerShortInfoResponse struct {
// The IP address of a server in a Fleet Advisor collector inventory.
IpAddress *string
// The ID of a server in a Fleet Advisor collector inventory.
ServerId *string
// The name address of a server in a Fleet Advisor collector inventory.
ServerName *string
noSmithyDocumentSerde
}
// In response to a request by the DescribeReplicationSubnetGroups operation, this
// object identifies a subnet by its given Availability Zone, subnet identifier,
// and status.
type Subnet struct {
// The Availability Zone of the subnet.
SubnetAvailabilityZone *AvailabilityZone
// The subnet identifier.
SubnetIdentifier *string
// The status of the subnet.
SubnetStatus *string
noSmithyDocumentSerde
}
// Provides information about types of supported endpoints in response to a request
// by the DescribeEndpointTypes operation. This information includes the type of
// endpoint, the database engine name, and whether change data capture (CDC) is
// supported.
type SupportedEndpointType struct {
// The type of endpoint. Valid values are source and target.
EndpointType ReplicationEndpointTypeValue
// The expanded name for the engine name. For example, if the EngineName parameter
// is "aurora," this value would be "Amazon Aurora MySQL."
EngineDisplayName *string
// The database engine name. Valid values, depending on the EndpointType, include
// "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql",
// "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis",
// "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".
EngineName *string
// The earliest DMS engine version that supports this endpoint engine. Note that
// endpoint engines released with DMS versions earlier than 3.1.1 do not return a
// value for this parameter.
ReplicationInstanceEngineMinimumVersion *string
// Indicates if change data capture (CDC) is supported.
SupportsCDC bool
noSmithyDocumentSerde
}
// Provides information that defines a SAP ASE endpoint.
type SybaseSettings struct {
// Database name for the endpoint.
DatabaseName *string
// Endpoint connection password.
Password *string
// Endpoint TCP port. The default is 5000.
Port *int32
// The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
// trusted entity and grants the required permissions to access the value in
// SecretsManagerSecret. The role must allow the iam:PassRole action.
// SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
// secret that allows access to the SAP ASE endpoint. You can specify one of two
// sets of values for these permissions. You can specify the values for this
// setting and SecretsManagerSecretId. Or you can specify clear-text values for
// UserName, Password, ServerName, and Port. You can't specify both. For more
// information on creating this SecretsManagerSecret and the
// SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it,
// see Using secrets to access Database Migration Service resources
// (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
// in the Database Migration Service User Guide.
SecretsManagerAccessRoleArn *string
// The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that
// contains the SAP SAE endpoint connection details.
SecretsManagerSecretId *string
// Fully qualified domain name of the endpoint.
ServerName *string
// Endpoint connection user name.
Username *string
noSmithyDocumentSerde
}
// Provides a collection of table statistics in response to a request by the
// DescribeTableStatistics operation.
type TableStatistics struct {
// The data definition language (DDL) used to build and modify the structure of
// your tables.
Ddls int64
// The number of delete actions performed on a table.
Deletes int64
// The number of rows that failed conditional checks during the full load operation
// (valid only for migrations where DynamoDB is the target).
FullLoadCondtnlChkFailedRows int64
// The time when the full load operation completed.
FullLoadEndTime *time.Time
// The number of rows that failed to load during the full load operation (valid
// only for migrations where DynamoDB is the target).
FullLoadErrorRows int64
// A value that indicates if the table was reloaded (true) or loaded as part of a
// new full load operation (false).
FullLoadReloaded *bool
// The number of rows added during the full load operation.
FullLoadRows int64
// The time when the full load operation started.
FullLoadStartTime *time.Time
// The number of insert actions performed on a table.
Inserts int64
// The last time a table was updated.
LastUpdateTime *time.Time
// The schema name.
SchemaName *string
// The name of the table.
TableName *string
// The state of the tables described. Valid states: Table does not exist | Before
// load | Full load | Table completed | Table cancelled | Table error | Table is
// being reloaded
TableState *string
// The number of update actions performed on a table.
Updates int64
// The number of records that failed validation.
ValidationFailedRecords int64
// The number of records that have yet to be validated.
ValidationPendingRecords int64
// The validation state of the table. This parameter can have the following
// values:
//
// * Not enabled – Validation isn't enabled for the table in the migration
// task.
//
// * Pending records – Some records in the table are waiting for
// validation.
//
// * Mismatched records – Some records in the table don't match
// between the source and target.
//
// * Suspended records – Some records in the table
// couldn't be validated.
//
// * No primary key –The table couldn't be validated
// because it has no primary key.
//
// * Table error – The table wasn't validated
// because it's in an error state and some data wasn't migrated.
//
// * Validated – All
// rows in the table are validated. If the table is updated, the status can change
// from Validated.
//
// * Error – The table couldn't be validated because of an
// unexpected error.
//
// * Pending validation – The table is waiting validation.
//
// *
// Preparing table – Preparing the table enabled in the migration task for
// validation.
//
// * Pending revalidation – All rows in the table are pending
// validation after the table was updated.
ValidationState *string
// Additional details about the state of validation.
ValidationStateDetails *string
// The number of records that couldn't be validated.
ValidationSuspendedRecords int64
noSmithyDocumentSerde
}
// Provides the name of the schema and table to be reloaded.
type TableToReload struct {
// The schema name of the table to be reloaded.
//
// This member is required.
SchemaName *string
// The table name of the table to be reloaded.
//
// This member is required.
TableName *string
noSmithyDocumentSerde
}
// A user-defined key-value pair that describes metadata added to an DMS resource
// and that is used by operations such as the following:
//
// * AddTagsToResource
//
// *
// ListTagsForResource
//
// * RemoveTagsFromResource
type Tag struct {
// A key is the required name of the tag. The string value can be 1-128 Unicode
// characters in length and can't be prefixed with "aws:" or "dms:". The string can
// only contain only the set of Unicode letters, digits, white-space, '_', '.',
// '/', '=', '+', '-' (Java regular expressions:
// "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
Key *string
// The Amazon Resource Name (ARN) string that uniquely identifies the resource for
// which the tag is created.
ResourceArn *string
// A value is the optional value of the tag. The string value can be 1-256 Unicode
// characters in length and can't be prefixed with "aws:" or "dms:". The string can
// only contain only the set of Unicode letters, digits, white-space, '_', '.',
// '/', '=', '+', '-' (Java regular expressions:
// "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
Value *string
noSmithyDocumentSerde
}
// Describes the status of a security group associated with the virtual private
// cloud (VPC) hosting your replication and DB instances.
type VpcSecurityGroupMembership struct {
// The status of the VPC security group.
Status *string
// The VPC security group ID.
VpcSecurityGroupId *string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|