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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum MacAlgorithmSpec {
#[allow(missing_docs)] // documentation missing in model
HmacSha224,
#[allow(missing_docs)] // documentation missing in model
HmacSha256,
#[allow(missing_docs)] // documentation missing in model
HmacSha384,
#[allow(missing_docs)] // documentation missing in model
HmacSha512,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for MacAlgorithmSpec {
fn from(s: &str) -> Self {
match s {
"HMAC_SHA_224" => MacAlgorithmSpec::HmacSha224,
"HMAC_SHA_256" => MacAlgorithmSpec::HmacSha256,
"HMAC_SHA_384" => MacAlgorithmSpec::HmacSha384,
"HMAC_SHA_512" => MacAlgorithmSpec::HmacSha512,
other => MacAlgorithmSpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for MacAlgorithmSpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(MacAlgorithmSpec::from(s))
}
}
impl MacAlgorithmSpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
MacAlgorithmSpec::HmacSha224 => "HMAC_SHA_224",
MacAlgorithmSpec::HmacSha256 => "HMAC_SHA_256",
MacAlgorithmSpec::HmacSha384 => "HMAC_SHA_384",
MacAlgorithmSpec::HmacSha512 => "HMAC_SHA_512",
MacAlgorithmSpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"HMAC_SHA_224",
"HMAC_SHA_256",
"HMAC_SHA_384",
"HMAC_SHA_512",
]
}
}
impl AsRef<str> for MacAlgorithmSpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum SigningAlgorithmSpec {
#[allow(missing_docs)] // documentation missing in model
EcdsaSha256,
#[allow(missing_docs)] // documentation missing in model
EcdsaSha384,
#[allow(missing_docs)] // documentation missing in model
EcdsaSha512,
#[allow(missing_docs)] // documentation missing in model
RsassaPkcs1V15Sha256,
#[allow(missing_docs)] // documentation missing in model
RsassaPkcs1V15Sha384,
#[allow(missing_docs)] // documentation missing in model
RsassaPkcs1V15Sha512,
#[allow(missing_docs)] // documentation missing in model
RsassaPssSha256,
#[allow(missing_docs)] // documentation missing in model
RsassaPssSha384,
#[allow(missing_docs)] // documentation missing in model
RsassaPssSha512,
#[allow(missing_docs)] // documentation missing in model
Sm2Dsa,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for SigningAlgorithmSpec {
fn from(s: &str) -> Self {
match s {
"ECDSA_SHA_256" => SigningAlgorithmSpec::EcdsaSha256,
"ECDSA_SHA_384" => SigningAlgorithmSpec::EcdsaSha384,
"ECDSA_SHA_512" => SigningAlgorithmSpec::EcdsaSha512,
"RSASSA_PKCS1_V1_5_SHA_256" => SigningAlgorithmSpec::RsassaPkcs1V15Sha256,
"RSASSA_PKCS1_V1_5_SHA_384" => SigningAlgorithmSpec::RsassaPkcs1V15Sha384,
"RSASSA_PKCS1_V1_5_SHA_512" => SigningAlgorithmSpec::RsassaPkcs1V15Sha512,
"RSASSA_PSS_SHA_256" => SigningAlgorithmSpec::RsassaPssSha256,
"RSASSA_PSS_SHA_384" => SigningAlgorithmSpec::RsassaPssSha384,
"RSASSA_PSS_SHA_512" => SigningAlgorithmSpec::RsassaPssSha512,
"SM2DSA" => SigningAlgorithmSpec::Sm2Dsa,
other => SigningAlgorithmSpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for SigningAlgorithmSpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(SigningAlgorithmSpec::from(s))
}
}
impl SigningAlgorithmSpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
SigningAlgorithmSpec::EcdsaSha256 => "ECDSA_SHA_256",
SigningAlgorithmSpec::EcdsaSha384 => "ECDSA_SHA_384",
SigningAlgorithmSpec::EcdsaSha512 => "ECDSA_SHA_512",
SigningAlgorithmSpec::RsassaPkcs1V15Sha256 => "RSASSA_PKCS1_V1_5_SHA_256",
SigningAlgorithmSpec::RsassaPkcs1V15Sha384 => "RSASSA_PKCS1_V1_5_SHA_384",
SigningAlgorithmSpec::RsassaPkcs1V15Sha512 => "RSASSA_PKCS1_V1_5_SHA_512",
SigningAlgorithmSpec::RsassaPssSha256 => "RSASSA_PSS_SHA_256",
SigningAlgorithmSpec::RsassaPssSha384 => "RSASSA_PSS_SHA_384",
SigningAlgorithmSpec::RsassaPssSha512 => "RSASSA_PSS_SHA_512",
SigningAlgorithmSpec::Sm2Dsa => "SM2DSA",
SigningAlgorithmSpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"ECDSA_SHA_256",
"ECDSA_SHA_384",
"ECDSA_SHA_512",
"RSASSA_PKCS1_V1_5_SHA_256",
"RSASSA_PKCS1_V1_5_SHA_384",
"RSASSA_PKCS1_V1_5_SHA_512",
"RSASSA_PSS_SHA_256",
"RSASSA_PSS_SHA_384",
"RSASSA_PSS_SHA_512",
"SM2DSA",
]
}
}
impl AsRef<str> for SigningAlgorithmSpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum MessageType {
#[allow(missing_docs)] // documentation missing in model
Digest,
#[allow(missing_docs)] // documentation missing in model
Raw,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for MessageType {
fn from(s: &str) -> Self {
match s {
"DIGEST" => MessageType::Digest,
"RAW" => MessageType::Raw,
other => MessageType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for MessageType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(MessageType::from(s))
}
}
impl MessageType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
MessageType::Digest => "DIGEST",
MessageType::Raw => "RAW",
MessageType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["DIGEST", "RAW"]
}
}
impl AsRef<str> for MessageType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p>
/// <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct Tag {
/// <p>The key of the tag.</p>
#[doc(hidden)]
pub tag_key: std::option::Option<std::string::String>,
/// <p>The value of the tag.</p>
#[doc(hidden)]
pub tag_value: std::option::Option<std::string::String>,
}
impl Tag {
/// <p>The key of the tag.</p>
pub fn tag_key(&self) -> std::option::Option<&str> {
self.tag_key.as_deref()
}
/// <p>The value of the tag.</p>
pub fn tag_value(&self) -> std::option::Option<&str> {
self.tag_value.as_deref()
}
}
impl std::fmt::Debug for Tag {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("Tag");
formatter.field("tag_key", &self.tag_key);
formatter.field("tag_value", &self.tag_value);
formatter.finish()
}
}
/// See [`Tag`](crate::model::Tag).
pub mod tag {
/// A builder for [`Tag`](crate::model::Tag).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) tag_key: std::option::Option<std::string::String>,
pub(crate) tag_value: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>The key of the tag.</p>
pub fn tag_key(mut self, input: impl Into<std::string::String>) -> Self {
self.tag_key = Some(input.into());
self
}
/// <p>The key of the tag.</p>
pub fn set_tag_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.tag_key = input;
self
}
/// <p>The value of the tag.</p>
pub fn tag_value(mut self, input: impl Into<std::string::String>) -> Self {
self.tag_value = Some(input.into());
self
}
/// <p>The value of the tag.</p>
pub fn set_tag_value(mut self, input: std::option::Option<std::string::String>) -> Self {
self.tag_value = input;
self
}
/// Consumes the builder and constructs a [`Tag`](crate::model::Tag).
pub fn build(self) -> crate::model::Tag {
crate::model::Tag {
tag_key: self.tag_key,
tag_value: self.tag_value,
}
}
}
}
impl Tag {
/// Creates a new builder-style object to manufacture [`Tag`](crate::model::Tag).
pub fn builder() -> crate::model::tag::Builder {
crate::model::tag::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum KeyState {
#[allow(missing_docs)] // documentation missing in model
Creating,
#[allow(missing_docs)] // documentation missing in model
Disabled,
#[allow(missing_docs)] // documentation missing in model
Enabled,
#[allow(missing_docs)] // documentation missing in model
PendingDeletion,
#[allow(missing_docs)] // documentation missing in model
PendingImport,
#[allow(missing_docs)] // documentation missing in model
PendingReplicaDeletion,
#[allow(missing_docs)] // documentation missing in model
Unavailable,
#[allow(missing_docs)] // documentation missing in model
Updating,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for KeyState {
fn from(s: &str) -> Self {
match s {
"Creating" => KeyState::Creating,
"Disabled" => KeyState::Disabled,
"Enabled" => KeyState::Enabled,
"PendingDeletion" => KeyState::PendingDeletion,
"PendingImport" => KeyState::PendingImport,
"PendingReplicaDeletion" => KeyState::PendingReplicaDeletion,
"Unavailable" => KeyState::Unavailable,
"Updating" => KeyState::Updating,
other => KeyState::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for KeyState {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(KeyState::from(s))
}
}
impl KeyState {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
KeyState::Creating => "Creating",
KeyState::Disabled => "Disabled",
KeyState::Enabled => "Enabled",
KeyState::PendingDeletion => "PendingDeletion",
KeyState::PendingImport => "PendingImport",
KeyState::PendingReplicaDeletion => "PendingReplicaDeletion",
KeyState::Unavailable => "Unavailable",
KeyState::Updating => "Updating",
KeyState::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"Creating",
"Disabled",
"Enabled",
"PendingDeletion",
"PendingImport",
"PendingReplicaDeletion",
"Unavailable",
"Updating",
]
}
}
impl AsRef<str> for KeyState {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Contains metadata about a KMS key.</p>
/// <p>This data type is used as a response element for the <code>CreateKey</code> and <code>DescribeKey</code> operations.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct KeyMetadata {
/// <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
#[doc(hidden)]
pub aws_account_id: std::option::Option<std::string::String>,
/// <p>The globally unique identifier for the KMS key.</p>
#[doc(hidden)]
pub key_id: std::option::Option<std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</p>
#[doc(hidden)]
pub arn: std::option::Option<std::string::String>,
/// <p>The date and time when the KMS key was created.</p>
#[doc(hidden)]
pub creation_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is <code>Enabled</code> this value is true, otherwise it is false.</p>
#[doc(hidden)]
pub enabled: bool,
/// <p>The description of the KMS key.</p>
#[doc(hidden)]
pub description: std::option::Option<std::string::String>,
/// <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
#[doc(hidden)]
pub key_usage: std::option::Option<crate::model::KeyUsageType>,
/// <p>The current status of the KMS key.</p>
/// <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
#[doc(hidden)]
pub key_state: std::option::Option<crate::model::KeyState>,
/// <p>The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is <code>PendingDeletion</code>.</p>
/// <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting period is displayed in the <code>PendingDeletionWindowInDays</code> field.</p>
#[doc(hidden)]
pub deletion_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
#[doc(hidden)]
pub valid_to: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>, KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was imported or the KMS key doesn't have any key material. When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster associated with a custom key store.</p>
#[doc(hidden)]
pub origin: std::option::Option<crate::model::OriginType>,
/// <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This value is present only when the KMS key is created in a custom key store.</p>
#[doc(hidden)]
pub custom_key_store_id: std::option::Option<std::string::String>,
/// <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.</p>
#[doc(hidden)]
pub cloud_hsm_cluster_id: std::option::Option<std::string::String>,
/// <p>Specifies whether the KMS key's key material expires. This value is present only when <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
#[doc(hidden)]
pub expiration_model: std::option::Option<crate::model::ExpirationModelType>,
/// <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
#[doc(hidden)]
pub key_manager: std::option::Option<crate::model::KeyManagerType>,
/// <p>Instead, use the <code>KeySpec</code> field.</p>
/// <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same value. We recommend that you use the <code>KeySpec</code> field in your code. However, to avoid breaking changes, KMS will support both fields.</p>
#[deprecated(note = "This field has been deprecated. Instead, use the KeySpec field.")]
#[doc(hidden)]
pub customer_master_key_spec: std::option::Option<crate::model::CustomerMasterKeySpec>,
/// <p>Describes the type of key material in the KMS key.</p>
#[doc(hidden)]
pub key_spec: std::option::Option<crate::model::KeySpec>,
/// <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>ENCRYPT_DECRYPT</code>.</p>
#[doc(hidden)]
pub encryption_algorithms:
std::option::Option<std::vec::Vec<crate::model::EncryptionAlgorithmSpec>>,
/// <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.</p>
/// <p>This field appears only when the <code>KeyUsage</code> of the KMS key is <code>SIGN_VERIFY</code>.</p>
#[doc(hidden)]
pub signing_algorithms: std::option::Option<std::vec::Vec<crate::model::SigningAlgorithmSpec>>,
/// <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and replica keys and <code>False</code> for regional KMS keys.</p>
/// <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
#[doc(hidden)]
pub multi_region: std::option::Option<bool>,
/// <p>Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
/// <p>For more information about any listed KMS key, use the <code>DescribeKey</code> operation.</p>
/// <ul>
/// <li> <p> <code>MultiRegionKeyType</code> indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p> </li>
/// <li> <p> <code>PrimaryKey</code> displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.</p> </li>
/// <li> <p> <code>ReplicaKeys</code> displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p> </li>
/// </ul>
#[doc(hidden)]
pub multi_region_configuration: std::option::Option<crate::model::MultiRegionConfiguration>,
/// <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.</p>
/// <p>When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the <code>DeletionDate</code> field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the <code>KeyState</code> of the scheduled primary key changes from <code>PendingReplicaDeletion</code> to <code>PendingDeletion</code> and the deletion date appears in the <code>DeletionDate</code> field.</p>
#[doc(hidden)]
pub pending_deletion_window_in_days: std::option::Option<i32>,
/// <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>GENERATE_VERIFY_MAC</code>.</p>
#[doc(hidden)]
pub mac_algorithms: std::option::Option<std::vec::Vec<crate::model::MacAlgorithmSpec>>,
}
impl KeyMetadata {
/// <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
pub fn aws_account_id(&self) -> std::option::Option<&str> {
self.aws_account_id.as_deref()
}
/// <p>The globally unique identifier for the KMS key.</p>
pub fn key_id(&self) -> std::option::Option<&str> {
self.key_id.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</p>
pub fn arn(&self) -> std::option::Option<&str> {
self.arn.as_deref()
}
/// <p>The date and time when the KMS key was created.</p>
pub fn creation_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.creation_date.as_ref()
}
/// <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is <code>Enabled</code> this value is true, otherwise it is false.</p>
pub fn enabled(&self) -> bool {
self.enabled
}
/// <p>The description of the KMS key.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
pub fn key_usage(&self) -> std::option::Option<&crate::model::KeyUsageType> {
self.key_usage.as_ref()
}
/// <p>The current status of the KMS key.</p>
/// <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn key_state(&self) -> std::option::Option<&crate::model::KeyState> {
self.key_state.as_ref()
}
/// <p>The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is <code>PendingDeletion</code>.</p>
/// <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting period is displayed in the <code>PendingDeletionWindowInDays</code> field.</p>
pub fn deletion_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.deletion_date.as_ref()
}
/// <p>The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
pub fn valid_to(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.valid_to.as_ref()
}
/// <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>, KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was imported or the KMS key doesn't have any key material. When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster associated with a custom key store.</p>
pub fn origin(&self) -> std::option::Option<&crate::model::OriginType> {
self.origin.as_ref()
}
/// <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This value is present only when the KMS key is created in a custom key store.</p>
pub fn custom_key_store_id(&self) -> std::option::Option<&str> {
self.custom_key_store_id.as_deref()
}
/// <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.</p>
pub fn cloud_hsm_cluster_id(&self) -> std::option::Option<&str> {
self.cloud_hsm_cluster_id.as_deref()
}
/// <p>Specifies whether the KMS key's key material expires. This value is present only when <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
pub fn expiration_model(&self) -> std::option::Option<&crate::model::ExpirationModelType> {
self.expiration_model.as_ref()
}
/// <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn key_manager(&self) -> std::option::Option<&crate::model::KeyManagerType> {
self.key_manager.as_ref()
}
/// <p>Instead, use the <code>KeySpec</code> field.</p>
/// <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same value. We recommend that you use the <code>KeySpec</code> field in your code. However, to avoid breaking changes, KMS will support both fields.</p>
#[deprecated(note = "This field has been deprecated. Instead, use the KeySpec field.")]
pub fn customer_master_key_spec(
&self,
) -> std::option::Option<&crate::model::CustomerMasterKeySpec> {
self.customer_master_key_spec.as_ref()
}
/// <p>Describes the type of key material in the KMS key.</p>
pub fn key_spec(&self) -> std::option::Option<&crate::model::KeySpec> {
self.key_spec.as_ref()
}
/// <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>ENCRYPT_DECRYPT</code>.</p>
pub fn encryption_algorithms(
&self,
) -> std::option::Option<&[crate::model::EncryptionAlgorithmSpec]> {
self.encryption_algorithms.as_deref()
}
/// <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.</p>
/// <p>This field appears only when the <code>KeyUsage</code> of the KMS key is <code>SIGN_VERIFY</code>.</p>
pub fn signing_algorithms(&self) -> std::option::Option<&[crate::model::SigningAlgorithmSpec]> {
self.signing_algorithms.as_deref()
}
/// <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and replica keys and <code>False</code> for regional KMS keys.</p>
/// <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn multi_region(&self) -> std::option::Option<bool> {
self.multi_region
}
/// <p>Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
/// <p>For more information about any listed KMS key, use the <code>DescribeKey</code> operation.</p>
/// <ul>
/// <li> <p> <code>MultiRegionKeyType</code> indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p> </li>
/// <li> <p> <code>PrimaryKey</code> displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.</p> </li>
/// <li> <p> <code>ReplicaKeys</code> displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p> </li>
/// </ul>
pub fn multi_region_configuration(
&self,
) -> std::option::Option<&crate::model::MultiRegionConfiguration> {
self.multi_region_configuration.as_ref()
}
/// <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.</p>
/// <p>When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the <code>DeletionDate</code> field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the <code>KeyState</code> of the scheduled primary key changes from <code>PendingReplicaDeletion</code> to <code>PendingDeletion</code> and the deletion date appears in the <code>DeletionDate</code> field.</p>
pub fn pending_deletion_window_in_days(&self) -> std::option::Option<i32> {
self.pending_deletion_window_in_days
}
/// <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>GENERATE_VERIFY_MAC</code>.</p>
pub fn mac_algorithms(&self) -> std::option::Option<&[crate::model::MacAlgorithmSpec]> {
self.mac_algorithms.as_deref()
}
}
impl std::fmt::Debug for KeyMetadata {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("KeyMetadata");
formatter.field("aws_account_id", &self.aws_account_id);
formatter.field("key_id", &self.key_id);
formatter.field("arn", &self.arn);
formatter.field("creation_date", &self.creation_date);
formatter.field("enabled", &self.enabled);
formatter.field("description", &self.description);
formatter.field("key_usage", &self.key_usage);
formatter.field("key_state", &self.key_state);
formatter.field("deletion_date", &self.deletion_date);
formatter.field("valid_to", &self.valid_to);
formatter.field("origin", &self.origin);
formatter.field("custom_key_store_id", &self.custom_key_store_id);
formatter.field("cloud_hsm_cluster_id", &self.cloud_hsm_cluster_id);
formatter.field("expiration_model", &self.expiration_model);
formatter.field("key_manager", &self.key_manager);
formatter.field("customer_master_key_spec", &self.customer_master_key_spec);
formatter.field("key_spec", &self.key_spec);
formatter.field("encryption_algorithms", &self.encryption_algorithms);
formatter.field("signing_algorithms", &self.signing_algorithms);
formatter.field("multi_region", &self.multi_region);
formatter.field(
"multi_region_configuration",
&self.multi_region_configuration,
);
formatter.field(
"pending_deletion_window_in_days",
&self.pending_deletion_window_in_days,
);
formatter.field("mac_algorithms", &self.mac_algorithms);
formatter.finish()
}
}
/// See [`KeyMetadata`](crate::model::KeyMetadata).
pub mod key_metadata {
/// A builder for [`KeyMetadata`](crate::model::KeyMetadata).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) aws_account_id: std::option::Option<std::string::String>,
pub(crate) key_id: std::option::Option<std::string::String>,
pub(crate) arn: std::option::Option<std::string::String>,
pub(crate) creation_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) enabled: std::option::Option<bool>,
pub(crate) description: std::option::Option<std::string::String>,
pub(crate) key_usage: std::option::Option<crate::model::KeyUsageType>,
pub(crate) key_state: std::option::Option<crate::model::KeyState>,
pub(crate) deletion_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) valid_to: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) origin: std::option::Option<crate::model::OriginType>,
pub(crate) custom_key_store_id: std::option::Option<std::string::String>,
pub(crate) cloud_hsm_cluster_id: std::option::Option<std::string::String>,
pub(crate) expiration_model: std::option::Option<crate::model::ExpirationModelType>,
pub(crate) key_manager: std::option::Option<crate::model::KeyManagerType>,
pub(crate) customer_master_key_spec:
std::option::Option<crate::model::CustomerMasterKeySpec>,
pub(crate) key_spec: std::option::Option<crate::model::KeySpec>,
pub(crate) encryption_algorithms:
std::option::Option<std::vec::Vec<crate::model::EncryptionAlgorithmSpec>>,
pub(crate) signing_algorithms:
std::option::Option<std::vec::Vec<crate::model::SigningAlgorithmSpec>>,
pub(crate) multi_region: std::option::Option<bool>,
pub(crate) multi_region_configuration:
std::option::Option<crate::model::MultiRegionConfiguration>,
pub(crate) pending_deletion_window_in_days: std::option::Option<i32>,
pub(crate) mac_algorithms:
std::option::Option<std::vec::Vec<crate::model::MacAlgorithmSpec>>,
}
impl Builder {
/// <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
self.aws_account_id = Some(input.into());
self
}
/// <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
pub fn set_aws_account_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.aws_account_id = input;
self
}
/// <p>The globally unique identifier for the KMS key.</p>
pub fn key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.key_id = Some(input.into());
self
}
/// <p>The globally unique identifier for the KMS key.</p>
pub fn set_key_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.key_id = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</p>
pub fn arn(mut self, input: impl Into<std::string::String>) -> Self {
self.arn = Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</p>
pub fn set_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.arn = input;
self
}
/// <p>The date and time when the KMS key was created.</p>
pub fn creation_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.creation_date = Some(input);
self
}
/// <p>The date and time when the KMS key was created.</p>
pub fn set_creation_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.creation_date = input;
self
}
/// <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is <code>Enabled</code> this value is true, otherwise it is false.</p>
pub fn enabled(mut self, input: bool) -> Self {
self.enabled = Some(input);
self
}
/// <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is <code>Enabled</code> this value is true, otherwise it is false.</p>
pub fn set_enabled(mut self, input: std::option::Option<bool>) -> Self {
self.enabled = input;
self
}
/// <p>The description of the KMS key.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>The description of the KMS key.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
pub fn key_usage(mut self, input: crate::model::KeyUsageType) -> Self {
self.key_usage = Some(input);
self
}
/// <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
pub fn set_key_usage(
mut self,
input: std::option::Option<crate::model::KeyUsageType>,
) -> Self {
self.key_usage = input;
self
}
/// <p>The current status of the KMS key.</p>
/// <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn key_state(mut self, input: crate::model::KeyState) -> Self {
self.key_state = Some(input);
self
}
/// <p>The current status of the KMS key.</p>
/// <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn set_key_state(mut self, input: std::option::Option<crate::model::KeyState>) -> Self {
self.key_state = input;
self
}
/// <p>The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is <code>PendingDeletion</code>.</p>
/// <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting period is displayed in the <code>PendingDeletionWindowInDays</code> field.</p>
pub fn deletion_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.deletion_date = Some(input);
self
}
/// <p>The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is <code>PendingDeletion</code>.</p>
/// <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting period is displayed in the <code>PendingDeletionWindowInDays</code> field.</p>
pub fn set_deletion_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.deletion_date = input;
self
}
/// <p>The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
pub fn valid_to(mut self, input: aws_smithy_types::DateTime) -> Self {
self.valid_to = Some(input);
self
}
/// <p>The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
pub fn set_valid_to(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.valid_to = input;
self
}
/// <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>, KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was imported or the KMS key doesn't have any key material. When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster associated with a custom key store.</p>
pub fn origin(mut self, input: crate::model::OriginType) -> Self {
self.origin = Some(input);
self
}
/// <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>, KMS created the key material. When this value is <code>EXTERNAL</code>, the key material was imported or the KMS key doesn't have any key material. When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster associated with a custom key store.</p>
pub fn set_origin(mut self, input: std::option::Option<crate::model::OriginType>) -> Self {
self.origin = input;
self
}
/// <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This value is present only when the KMS key is created in a custom key store.</p>
pub fn custom_key_store_id(mut self, input: impl Into<std::string::String>) -> Self {
self.custom_key_store_id = Some(input.into());
self
}
/// <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This value is present only when the KMS key is created in a custom key store.</p>
pub fn set_custom_key_store_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.custom_key_store_id = input;
self
}
/// <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.</p>
pub fn cloud_hsm_cluster_id(mut self, input: impl Into<std::string::String>) -> Self {
self.cloud_hsm_cluster_id = Some(input.into());
self
}
/// <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.</p>
pub fn set_cloud_hsm_cluster_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.cloud_hsm_cluster_id = input;
self
}
/// <p>Specifies whether the KMS key's key material expires. This value is present only when <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
pub fn expiration_model(mut self, input: crate::model::ExpirationModelType) -> Self {
self.expiration_model = Some(input);
self
}
/// <p>Specifies whether the KMS key's key material expires. This value is present only when <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
pub fn set_expiration_model(
mut self,
input: std::option::Option<crate::model::ExpirationModelType>,
) -> Self {
self.expiration_model = input;
self
}
/// <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn key_manager(mut self, input: crate::model::KeyManagerType) -> Self {
self.key_manager = Some(input);
self
}
/// <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn set_key_manager(
mut self,
input: std::option::Option<crate::model::KeyManagerType>,
) -> Self {
self.key_manager = input;
self
}
/// <p>Instead, use the <code>KeySpec</code> field.</p>
/// <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same value. We recommend that you use the <code>KeySpec</code> field in your code. However, to avoid breaking changes, KMS will support both fields.</p>
#[deprecated(note = "This field has been deprecated. Instead, use the KeySpec field.")]
pub fn customer_master_key_spec(
mut self,
input: crate::model::CustomerMasterKeySpec,
) -> Self {
self.customer_master_key_spec = Some(input);
self
}
/// <p>Instead, use the <code>KeySpec</code> field.</p>
/// <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same value. We recommend that you use the <code>KeySpec</code> field in your code. However, to avoid breaking changes, KMS will support both fields.</p>
#[deprecated(note = "This field has been deprecated. Instead, use the KeySpec field.")]
pub fn set_customer_master_key_spec(
mut self,
input: std::option::Option<crate::model::CustomerMasterKeySpec>,
) -> Self {
self.customer_master_key_spec = input;
self
}
/// <p>Describes the type of key material in the KMS key.</p>
pub fn key_spec(mut self, input: crate::model::KeySpec) -> Self {
self.key_spec = Some(input);
self
}
/// <p>Describes the type of key material in the KMS key.</p>
pub fn set_key_spec(mut self, input: std::option::Option<crate::model::KeySpec>) -> Self {
self.key_spec = input;
self
}
/// Appends an item to `encryption_algorithms`.
///
/// To override the contents of this collection use [`set_encryption_algorithms`](Self::set_encryption_algorithms).
///
/// <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>ENCRYPT_DECRYPT</code>.</p>
pub fn encryption_algorithms(
mut self,
input: crate::model::EncryptionAlgorithmSpec,
) -> Self {
let mut v = self.encryption_algorithms.unwrap_or_default();
v.push(input);
self.encryption_algorithms = Some(v);
self
}
/// <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>ENCRYPT_DECRYPT</code>.</p>
pub fn set_encryption_algorithms(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::EncryptionAlgorithmSpec>>,
) -> Self {
self.encryption_algorithms = input;
self
}
/// Appends an item to `signing_algorithms`.
///
/// To override the contents of this collection use [`set_signing_algorithms`](Self::set_signing_algorithms).
///
/// <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.</p>
/// <p>This field appears only when the <code>KeyUsage</code> of the KMS key is <code>SIGN_VERIFY</code>.</p>
pub fn signing_algorithms(mut self, input: crate::model::SigningAlgorithmSpec) -> Self {
let mut v = self.signing_algorithms.unwrap_or_default();
v.push(input);
self.signing_algorithms = Some(v);
self
}
/// <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.</p>
/// <p>This field appears only when the <code>KeyUsage</code> of the KMS key is <code>SIGN_VERIFY</code>.</p>
pub fn set_signing_algorithms(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::SigningAlgorithmSpec>>,
) -> Self {
self.signing_algorithms = input;
self
}
/// <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and replica keys and <code>False</code> for regional KMS keys.</p>
/// <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn multi_region(mut self, input: bool) -> Self {
self.multi_region = Some(input);
self
}
/// <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and replica keys and <code>False</code> for regional KMS keys.</p>
/// <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Multi-Region keys in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn set_multi_region(mut self, input: std::option::Option<bool>) -> Self {
self.multi_region = input;
self
}
/// <p>Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
/// <p>For more information about any listed KMS key, use the <code>DescribeKey</code> operation.</p>
/// <ul>
/// <li> <p> <code>MultiRegionKeyType</code> indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p> </li>
/// <li> <p> <code>PrimaryKey</code> displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.</p> </li>
/// <li> <p> <code>ReplicaKeys</code> displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p> </li>
/// </ul>
pub fn multi_region_configuration(
mut self,
input: crate::model::MultiRegionConfiguration,
) -> Self {
self.multi_region_configuration = Some(input);
self
}
/// <p>Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
/// <p>For more information about any listed KMS key, use the <code>DescribeKey</code> operation.</p>
/// <ul>
/// <li> <p> <code>MultiRegionKeyType</code> indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p> </li>
/// <li> <p> <code>PrimaryKey</code> displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.</p> </li>
/// <li> <p> <code>ReplicaKeys</code> displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p> </li>
/// </ul>
pub fn set_multi_region_configuration(
mut self,
input: std::option::Option<crate::model::MultiRegionConfiguration>,
) -> Self {
self.multi_region_configuration = input;
self
}
/// <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.</p>
/// <p>When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the <code>DeletionDate</code> field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the <code>KeyState</code> of the scheduled primary key changes from <code>PendingReplicaDeletion</code> to <code>PendingDeletion</code> and the deletion date appears in the <code>DeletionDate</code> field.</p>
pub fn pending_deletion_window_in_days(mut self, input: i32) -> Self {
self.pending_deletion_window_in_days = Some(input);
self
}
/// <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.</p>
/// <p>When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the <code>DeletionDate</code> field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the <code>KeyState</code> of the scheduled primary key changes from <code>PendingReplicaDeletion</code> to <code>PendingDeletion</code> and the deletion date appears in the <code>DeletionDate</code> field.</p>
pub fn set_pending_deletion_window_in_days(
mut self,
input: std::option::Option<i32>,
) -> Self {
self.pending_deletion_window_in_days = input;
self
}
/// Appends an item to `mac_algorithms`.
///
/// To override the contents of this collection use [`set_mac_algorithms`](Self::set_mac_algorithms).
///
/// <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>GENERATE_VERIFY_MAC</code>.</p>
pub fn mac_algorithms(mut self, input: crate::model::MacAlgorithmSpec) -> Self {
let mut v = self.mac_algorithms.unwrap_or_default();
v.push(input);
self.mac_algorithms = Some(v);
self
}
/// <p>The message authentication code (MAC) algorithm that the HMAC KMS key supports.</p>
/// <p>This value is present only when the <code>KeyUsage</code> of the KMS key is <code>GENERATE_VERIFY_MAC</code>.</p>
pub fn set_mac_algorithms(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::MacAlgorithmSpec>>,
) -> Self {
self.mac_algorithms = input;
self
}
/// Consumes the builder and constructs a [`KeyMetadata`](crate::model::KeyMetadata).
pub fn build(self) -> crate::model::KeyMetadata {
crate::model::KeyMetadata {
aws_account_id: self.aws_account_id,
key_id: self.key_id,
arn: self.arn,
creation_date: self.creation_date,
enabled: self.enabled.unwrap_or_default(),
description: self.description,
key_usage: self.key_usage,
key_state: self.key_state,
deletion_date: self.deletion_date,
valid_to: self.valid_to,
origin: self.origin,
custom_key_store_id: self.custom_key_store_id,
cloud_hsm_cluster_id: self.cloud_hsm_cluster_id,
expiration_model: self.expiration_model,
key_manager: self.key_manager,
customer_master_key_spec: self.customer_master_key_spec,
key_spec: self.key_spec,
encryption_algorithms: self.encryption_algorithms,
signing_algorithms: self.signing_algorithms,
multi_region: self.multi_region,
multi_region_configuration: self.multi_region_configuration,
pending_deletion_window_in_days: self.pending_deletion_window_in_days,
mac_algorithms: self.mac_algorithms,
}
}
}
}
impl KeyMetadata {
/// Creates a new builder-style object to manufacture [`KeyMetadata`](crate::model::KeyMetadata).
pub fn builder() -> crate::model::key_metadata::Builder {
crate::model::key_metadata::Builder::default()
}
}
/// <p>Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.</p>
/// <p>For more information about any listed KMS key, use the <code>DescribeKey</code> operation.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct MultiRegionConfiguration {
/// <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p>
#[doc(hidden)]
pub multi_region_key_type: std::option::Option<crate::model::MultiRegionKeyType>,
/// <p>Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.</p>
#[doc(hidden)]
pub primary_key: std::option::Option<crate::model::MultiRegionKey>,
/// <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p>
#[doc(hidden)]
pub replica_keys: std::option::Option<std::vec::Vec<crate::model::MultiRegionKey>>,
}
impl MultiRegionConfiguration {
/// <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p>
pub fn multi_region_key_type(&self) -> std::option::Option<&crate::model::MultiRegionKeyType> {
self.multi_region_key_type.as_ref()
}
/// <p>Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.</p>
pub fn primary_key(&self) -> std::option::Option<&crate::model::MultiRegionKey> {
self.primary_key.as_ref()
}
/// <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p>
pub fn replica_keys(&self) -> std::option::Option<&[crate::model::MultiRegionKey]> {
self.replica_keys.as_deref()
}
}
impl std::fmt::Debug for MultiRegionConfiguration {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("MultiRegionConfiguration");
formatter.field("multi_region_key_type", &self.multi_region_key_type);
formatter.field("primary_key", &self.primary_key);
formatter.field("replica_keys", &self.replica_keys);
formatter.finish()
}
}
/// See [`MultiRegionConfiguration`](crate::model::MultiRegionConfiguration).
pub mod multi_region_configuration {
/// A builder for [`MultiRegionConfiguration`](crate::model::MultiRegionConfiguration).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) multi_region_key_type: std::option::Option<crate::model::MultiRegionKeyType>,
pub(crate) primary_key: std::option::Option<crate::model::MultiRegionKey>,
pub(crate) replica_keys: std::option::Option<std::vec::Vec<crate::model::MultiRegionKey>>,
}
impl Builder {
/// <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p>
pub fn multi_region_key_type(mut self, input: crate::model::MultiRegionKeyType) -> Self {
self.multi_region_key_type = Some(input);
self
}
/// <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p>
pub fn set_multi_region_key_type(
mut self,
input: std::option::Option<crate::model::MultiRegionKeyType>,
) -> Self {
self.multi_region_key_type = input;
self
}
/// <p>Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.</p>
pub fn primary_key(mut self, input: crate::model::MultiRegionKey) -> Self {
self.primary_key = Some(input);
self
}
/// <p>Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.</p>
pub fn set_primary_key(
mut self,
input: std::option::Option<crate::model::MultiRegionKey>,
) -> Self {
self.primary_key = input;
self
}
/// Appends an item to `replica_keys`.
///
/// To override the contents of this collection use [`set_replica_keys`](Self::set_replica_keys).
///
/// <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p>
pub fn replica_keys(mut self, input: crate::model::MultiRegionKey) -> Self {
let mut v = self.replica_keys.unwrap_or_default();
v.push(input);
self.replica_keys = Some(v);
self
}
/// <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.</p>
pub fn set_replica_keys(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::MultiRegionKey>>,
) -> Self {
self.replica_keys = input;
self
}
/// Consumes the builder and constructs a [`MultiRegionConfiguration`](crate::model::MultiRegionConfiguration).
pub fn build(self) -> crate::model::MultiRegionConfiguration {
crate::model::MultiRegionConfiguration {
multi_region_key_type: self.multi_region_key_type,
primary_key: self.primary_key,
replica_keys: self.replica_keys,
}
}
}
}
impl MultiRegionConfiguration {
/// Creates a new builder-style object to manufacture [`MultiRegionConfiguration`](crate::model::MultiRegionConfiguration).
pub fn builder() -> crate::model::multi_region_configuration::Builder {
crate::model::multi_region_configuration::Builder::default()
}
}
/// <p>Describes the primary or replica key in a multi-Region key.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct MultiRegionKey {
/// <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
#[doc(hidden)]
pub arn: std::option::Option<std::string::String>,
/// <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
#[doc(hidden)]
pub region: std::option::Option<std::string::String>,
}
impl MultiRegionKey {
/// <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
pub fn arn(&self) -> std::option::Option<&str> {
self.arn.as_deref()
}
/// <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
pub fn region(&self) -> std::option::Option<&str> {
self.region.as_deref()
}
}
impl std::fmt::Debug for MultiRegionKey {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("MultiRegionKey");
formatter.field("arn", &self.arn);
formatter.field("region", &self.region);
formatter.finish()
}
}
/// See [`MultiRegionKey`](crate::model::MultiRegionKey).
pub mod multi_region_key {
/// A builder for [`MultiRegionKey`](crate::model::MultiRegionKey).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) arn: std::option::Option<std::string::String>,
pub(crate) region: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
pub fn arn(mut self, input: impl Into<std::string::String>) -> Self {
self.arn = Some(input.into());
self
}
/// <p>Displays the key ARN of a primary or replica key of a multi-Region key.</p>
pub fn set_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.arn = input;
self
}
/// <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
pub fn region(mut self, input: impl Into<std::string::String>) -> Self {
self.region = Some(input.into());
self
}
/// <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
pub fn set_region(mut self, input: std::option::Option<std::string::String>) -> Self {
self.region = input;
self
}
/// Consumes the builder and constructs a [`MultiRegionKey`](crate::model::MultiRegionKey).
pub fn build(self) -> crate::model::MultiRegionKey {
crate::model::MultiRegionKey {
arn: self.arn,
region: self.region,
}
}
}
}
impl MultiRegionKey {
/// Creates a new builder-style object to manufacture [`MultiRegionKey`](crate::model::MultiRegionKey).
pub fn builder() -> crate::model::multi_region_key::Builder {
crate::model::multi_region_key::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum MultiRegionKeyType {
#[allow(missing_docs)] // documentation missing in model
Primary,
#[allow(missing_docs)] // documentation missing in model
Replica,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for MultiRegionKeyType {
fn from(s: &str) -> Self {
match s {
"PRIMARY" => MultiRegionKeyType::Primary,
"REPLICA" => MultiRegionKeyType::Replica,
other => MultiRegionKeyType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for MultiRegionKeyType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(MultiRegionKeyType::from(s))
}
}
impl MultiRegionKeyType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
MultiRegionKeyType::Primary => "PRIMARY",
MultiRegionKeyType::Replica => "REPLICA",
MultiRegionKeyType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["PRIMARY", "REPLICA"]
}
}
impl AsRef<str> for MultiRegionKeyType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum EncryptionAlgorithmSpec {
#[allow(missing_docs)] // documentation missing in model
RsaesOaepSha1,
#[allow(missing_docs)] // documentation missing in model
RsaesOaepSha256,
#[allow(missing_docs)] // documentation missing in model
Sm2Pke,
#[allow(missing_docs)] // documentation missing in model
SymmetricDefault,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for EncryptionAlgorithmSpec {
fn from(s: &str) -> Self {
match s {
"RSAES_OAEP_SHA_1" => EncryptionAlgorithmSpec::RsaesOaepSha1,
"RSAES_OAEP_SHA_256" => EncryptionAlgorithmSpec::RsaesOaepSha256,
"SM2PKE" => EncryptionAlgorithmSpec::Sm2Pke,
"SYMMETRIC_DEFAULT" => EncryptionAlgorithmSpec::SymmetricDefault,
other => EncryptionAlgorithmSpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for EncryptionAlgorithmSpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(EncryptionAlgorithmSpec::from(s))
}
}
impl EncryptionAlgorithmSpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
EncryptionAlgorithmSpec::RsaesOaepSha1 => "RSAES_OAEP_SHA_1",
EncryptionAlgorithmSpec::RsaesOaepSha256 => "RSAES_OAEP_SHA_256",
EncryptionAlgorithmSpec::Sm2Pke => "SM2PKE",
EncryptionAlgorithmSpec::SymmetricDefault => "SYMMETRIC_DEFAULT",
EncryptionAlgorithmSpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"RSAES_OAEP_SHA_1",
"RSAES_OAEP_SHA_256",
"SM2PKE",
"SYMMETRIC_DEFAULT",
]
}
}
impl AsRef<str> for EncryptionAlgorithmSpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum KeySpec {
#[allow(missing_docs)] // documentation missing in model
EccNistP256,
#[allow(missing_docs)] // documentation missing in model
EccNistP384,
#[allow(missing_docs)] // documentation missing in model
EccNistP521,
#[allow(missing_docs)] // documentation missing in model
EccSecgP256K1,
#[allow(missing_docs)] // documentation missing in model
Hmac224,
#[allow(missing_docs)] // documentation missing in model
Hmac256,
#[allow(missing_docs)] // documentation missing in model
Hmac384,
#[allow(missing_docs)] // documentation missing in model
Hmac512,
#[allow(missing_docs)] // documentation missing in model
Rsa2048,
#[allow(missing_docs)] // documentation missing in model
Rsa3072,
#[allow(missing_docs)] // documentation missing in model
Rsa4096,
#[allow(missing_docs)] // documentation missing in model
Sm2,
#[allow(missing_docs)] // documentation missing in model
SymmetricDefault,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for KeySpec {
fn from(s: &str) -> Self {
match s {
"ECC_NIST_P256" => KeySpec::EccNistP256,
"ECC_NIST_P384" => KeySpec::EccNistP384,
"ECC_NIST_P521" => KeySpec::EccNistP521,
"ECC_SECG_P256K1" => KeySpec::EccSecgP256K1,
"HMAC_224" => KeySpec::Hmac224,
"HMAC_256" => KeySpec::Hmac256,
"HMAC_384" => KeySpec::Hmac384,
"HMAC_512" => KeySpec::Hmac512,
"RSA_2048" => KeySpec::Rsa2048,
"RSA_3072" => KeySpec::Rsa3072,
"RSA_4096" => KeySpec::Rsa4096,
"SM2" => KeySpec::Sm2,
"SYMMETRIC_DEFAULT" => KeySpec::SymmetricDefault,
other => KeySpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for KeySpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(KeySpec::from(s))
}
}
impl KeySpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
KeySpec::EccNistP256 => "ECC_NIST_P256",
KeySpec::EccNistP384 => "ECC_NIST_P384",
KeySpec::EccNistP521 => "ECC_NIST_P521",
KeySpec::EccSecgP256K1 => "ECC_SECG_P256K1",
KeySpec::Hmac224 => "HMAC_224",
KeySpec::Hmac256 => "HMAC_256",
KeySpec::Hmac384 => "HMAC_384",
KeySpec::Hmac512 => "HMAC_512",
KeySpec::Rsa2048 => "RSA_2048",
KeySpec::Rsa3072 => "RSA_3072",
KeySpec::Rsa4096 => "RSA_4096",
KeySpec::Sm2 => "SM2",
KeySpec::SymmetricDefault => "SYMMETRIC_DEFAULT",
KeySpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"ECC_NIST_P256",
"ECC_NIST_P384",
"ECC_NIST_P521",
"ECC_SECG_P256K1",
"HMAC_224",
"HMAC_256",
"HMAC_384",
"HMAC_512",
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
"SYMMETRIC_DEFAULT",
]
}
}
impl AsRef<str> for KeySpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[deprecated(note = "This enum has been deprecated. Instead, use the KeySpec enum.")]
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum CustomerMasterKeySpec {
#[allow(missing_docs)] // documentation missing in model
EccNistP256,
#[allow(missing_docs)] // documentation missing in model
EccNistP384,
#[allow(missing_docs)] // documentation missing in model
EccNistP521,
#[allow(missing_docs)] // documentation missing in model
EccSecgP256K1,
#[allow(missing_docs)] // documentation missing in model
Hmac224,
#[allow(missing_docs)] // documentation missing in model
Hmac256,
#[allow(missing_docs)] // documentation missing in model
Hmac384,
#[allow(missing_docs)] // documentation missing in model
Hmac512,
#[allow(missing_docs)] // documentation missing in model
Rsa2048,
#[allow(missing_docs)] // documentation missing in model
Rsa3072,
#[allow(missing_docs)] // documentation missing in model
Rsa4096,
#[allow(missing_docs)] // documentation missing in model
Sm2,
#[allow(missing_docs)] // documentation missing in model
SymmetricDefault,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for CustomerMasterKeySpec {
fn from(s: &str) -> Self {
match s {
"ECC_NIST_P256" => CustomerMasterKeySpec::EccNistP256,
"ECC_NIST_P384" => CustomerMasterKeySpec::EccNistP384,
"ECC_NIST_P521" => CustomerMasterKeySpec::EccNistP521,
"ECC_SECG_P256K1" => CustomerMasterKeySpec::EccSecgP256K1,
"HMAC_224" => CustomerMasterKeySpec::Hmac224,
"HMAC_256" => CustomerMasterKeySpec::Hmac256,
"HMAC_384" => CustomerMasterKeySpec::Hmac384,
"HMAC_512" => CustomerMasterKeySpec::Hmac512,
"RSA_2048" => CustomerMasterKeySpec::Rsa2048,
"RSA_3072" => CustomerMasterKeySpec::Rsa3072,
"RSA_4096" => CustomerMasterKeySpec::Rsa4096,
"SM2" => CustomerMasterKeySpec::Sm2,
"SYMMETRIC_DEFAULT" => CustomerMasterKeySpec::SymmetricDefault,
other => CustomerMasterKeySpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for CustomerMasterKeySpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(CustomerMasterKeySpec::from(s))
}
}
impl CustomerMasterKeySpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
CustomerMasterKeySpec::EccNistP256 => "ECC_NIST_P256",
CustomerMasterKeySpec::EccNistP384 => "ECC_NIST_P384",
CustomerMasterKeySpec::EccNistP521 => "ECC_NIST_P521",
CustomerMasterKeySpec::EccSecgP256K1 => "ECC_SECG_P256K1",
CustomerMasterKeySpec::Hmac224 => "HMAC_224",
CustomerMasterKeySpec::Hmac256 => "HMAC_256",
CustomerMasterKeySpec::Hmac384 => "HMAC_384",
CustomerMasterKeySpec::Hmac512 => "HMAC_512",
CustomerMasterKeySpec::Rsa2048 => "RSA_2048",
CustomerMasterKeySpec::Rsa3072 => "RSA_3072",
CustomerMasterKeySpec::Rsa4096 => "RSA_4096",
CustomerMasterKeySpec::Sm2 => "SM2",
CustomerMasterKeySpec::SymmetricDefault => "SYMMETRIC_DEFAULT",
CustomerMasterKeySpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"ECC_NIST_P256",
"ECC_NIST_P384",
"ECC_NIST_P521",
"ECC_SECG_P256K1",
"HMAC_224",
"HMAC_256",
"HMAC_384",
"HMAC_512",
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
"SYMMETRIC_DEFAULT",
]
}
}
impl AsRef<str> for CustomerMasterKeySpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum KeyManagerType {
#[allow(missing_docs)] // documentation missing in model
Aws,
#[allow(missing_docs)] // documentation missing in model
Customer,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for KeyManagerType {
fn from(s: &str) -> Self {
match s {
"AWS" => KeyManagerType::Aws,
"CUSTOMER" => KeyManagerType::Customer,
other => KeyManagerType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for KeyManagerType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(KeyManagerType::from(s))
}
}
impl KeyManagerType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
KeyManagerType::Aws => "AWS",
KeyManagerType::Customer => "CUSTOMER",
KeyManagerType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["AWS", "CUSTOMER"]
}
}
impl AsRef<str> for KeyManagerType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum ExpirationModelType {
#[allow(missing_docs)] // documentation missing in model
KeyMaterialDoesNotExpire,
#[allow(missing_docs)] // documentation missing in model
KeyMaterialExpires,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for ExpirationModelType {
fn from(s: &str) -> Self {
match s {
"KEY_MATERIAL_DOES_NOT_EXPIRE" => ExpirationModelType::KeyMaterialDoesNotExpire,
"KEY_MATERIAL_EXPIRES" => ExpirationModelType::KeyMaterialExpires,
other => ExpirationModelType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for ExpirationModelType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(ExpirationModelType::from(s))
}
}
impl ExpirationModelType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
ExpirationModelType::KeyMaterialDoesNotExpire => "KEY_MATERIAL_DOES_NOT_EXPIRE",
ExpirationModelType::KeyMaterialExpires => "KEY_MATERIAL_EXPIRES",
ExpirationModelType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["KEY_MATERIAL_DOES_NOT_EXPIRE", "KEY_MATERIAL_EXPIRES"]
}
}
impl AsRef<str> for ExpirationModelType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum OriginType {
#[allow(missing_docs)] // documentation missing in model
AwsCloudhsm,
#[allow(missing_docs)] // documentation missing in model
AwsKms,
#[allow(missing_docs)] // documentation missing in model
External,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for OriginType {
fn from(s: &str) -> Self {
match s {
"AWS_CLOUDHSM" => OriginType::AwsCloudhsm,
"AWS_KMS" => OriginType::AwsKms,
"EXTERNAL" => OriginType::External,
other => OriginType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for OriginType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(OriginType::from(s))
}
}
impl OriginType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
OriginType::AwsCloudhsm => "AWS_CLOUDHSM",
OriginType::AwsKms => "AWS_KMS",
OriginType::External => "EXTERNAL",
OriginType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["AWS_CLOUDHSM", "AWS_KMS", "EXTERNAL"]
}
}
impl AsRef<str> for OriginType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum KeyUsageType {
#[allow(missing_docs)] // documentation missing in model
EncryptDecrypt,
#[allow(missing_docs)] // documentation missing in model
GenerateVerifyMac,
#[allow(missing_docs)] // documentation missing in model
SignVerify,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for KeyUsageType {
fn from(s: &str) -> Self {
match s {
"ENCRYPT_DECRYPT" => KeyUsageType::EncryptDecrypt,
"GENERATE_VERIFY_MAC" => KeyUsageType::GenerateVerifyMac,
"SIGN_VERIFY" => KeyUsageType::SignVerify,
other => KeyUsageType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for KeyUsageType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(KeyUsageType::from(s))
}
}
impl KeyUsageType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
KeyUsageType::EncryptDecrypt => "ENCRYPT_DECRYPT",
KeyUsageType::GenerateVerifyMac => "GENERATE_VERIFY_MAC",
KeyUsageType::SignVerify => "SIGN_VERIFY",
KeyUsageType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC", "SIGN_VERIFY"]
}
}
impl AsRef<str> for KeyUsageType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Contains information about a grant.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct GrantListEntry {
/// <p>The unique identifier for the KMS key to which the grant applies.</p>
#[doc(hidden)]
pub key_id: std::option::Option<std::string::String>,
/// <p>The unique identifier for the grant.</p>
#[doc(hidden)]
pub grant_id: std::option::Option<std::string::String>,
/// <p>The friendly name that identifies the grant. If a name was provided in the <code>CreateGrant</code> request, that name is returned. Otherwise this value is null.</p>
#[doc(hidden)]
pub name: std::option::Option<std::string::String>,
/// <p>The date and time when the grant was created.</p>
#[doc(hidden)]
pub creation_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>The identity that gets the permissions in the grant.</p>
/// <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p>
#[doc(hidden)]
pub grantee_principal: std::option::Option<std::string::String>,
/// <p>The principal that can retire the grant.</p>
#[doc(hidden)]
pub retiring_principal: std::option::Option<std::string::String>,
/// <p>The Amazon Web Services account under which the grant was issued.</p>
#[doc(hidden)]
pub issuing_account: std::option::Option<std::string::String>,
/// <p>The list of operations permitted by the grant.</p>
#[doc(hidden)]
pub operations: std::option::Option<std::vec::Vec<crate::model::GrantOperation>>,
/// <p>A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.</p>
#[doc(hidden)]
pub constraints: std::option::Option<crate::model::GrantConstraints>,
}
impl GrantListEntry {
/// <p>The unique identifier for the KMS key to which the grant applies.</p>
pub fn key_id(&self) -> std::option::Option<&str> {
self.key_id.as_deref()
}
/// <p>The unique identifier for the grant.</p>
pub fn grant_id(&self) -> std::option::Option<&str> {
self.grant_id.as_deref()
}
/// <p>The friendly name that identifies the grant. If a name was provided in the <code>CreateGrant</code> request, that name is returned. Otherwise this value is null.</p>
pub fn name(&self) -> std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The date and time when the grant was created.</p>
pub fn creation_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.creation_date.as_ref()
}
/// <p>The identity that gets the permissions in the grant.</p>
/// <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p>
pub fn grantee_principal(&self) -> std::option::Option<&str> {
self.grantee_principal.as_deref()
}
/// <p>The principal that can retire the grant.</p>
pub fn retiring_principal(&self) -> std::option::Option<&str> {
self.retiring_principal.as_deref()
}
/// <p>The Amazon Web Services account under which the grant was issued.</p>
pub fn issuing_account(&self) -> std::option::Option<&str> {
self.issuing_account.as_deref()
}
/// <p>The list of operations permitted by the grant.</p>
pub fn operations(&self) -> std::option::Option<&[crate::model::GrantOperation]> {
self.operations.as_deref()
}
/// <p>A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.</p>
pub fn constraints(&self) -> std::option::Option<&crate::model::GrantConstraints> {
self.constraints.as_ref()
}
}
impl std::fmt::Debug for GrantListEntry {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("GrantListEntry");
formatter.field("key_id", &self.key_id);
formatter.field("grant_id", &self.grant_id);
formatter.field("name", &self.name);
formatter.field("creation_date", &self.creation_date);
formatter.field("grantee_principal", &self.grantee_principal);
formatter.field("retiring_principal", &self.retiring_principal);
formatter.field("issuing_account", &self.issuing_account);
formatter.field("operations", &self.operations);
formatter.field("constraints", &self.constraints);
formatter.finish()
}
}
/// See [`GrantListEntry`](crate::model::GrantListEntry).
pub mod grant_list_entry {
/// A builder for [`GrantListEntry`](crate::model::GrantListEntry).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) key_id: std::option::Option<std::string::String>,
pub(crate) grant_id: std::option::Option<std::string::String>,
pub(crate) name: std::option::Option<std::string::String>,
pub(crate) creation_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) grantee_principal: std::option::Option<std::string::String>,
pub(crate) retiring_principal: std::option::Option<std::string::String>,
pub(crate) issuing_account: std::option::Option<std::string::String>,
pub(crate) operations: std::option::Option<std::vec::Vec<crate::model::GrantOperation>>,
pub(crate) constraints: std::option::Option<crate::model::GrantConstraints>,
}
impl Builder {
/// <p>The unique identifier for the KMS key to which the grant applies.</p>
pub fn key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.key_id = Some(input.into());
self
}
/// <p>The unique identifier for the KMS key to which the grant applies.</p>
pub fn set_key_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.key_id = input;
self
}
/// <p>The unique identifier for the grant.</p>
pub fn grant_id(mut self, input: impl Into<std::string::String>) -> Self {
self.grant_id = Some(input.into());
self
}
/// <p>The unique identifier for the grant.</p>
pub fn set_grant_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.grant_id = input;
self
}
/// <p>The friendly name that identifies the grant. If a name was provided in the <code>CreateGrant</code> request, that name is returned. Otherwise this value is null.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.name = Some(input.into());
self
}
/// <p>The friendly name that identifies the grant. If a name was provided in the <code>CreateGrant</code> request, that name is returned. Otherwise this value is null.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The date and time when the grant was created.</p>
pub fn creation_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.creation_date = Some(input);
self
}
/// <p>The date and time when the grant was created.</p>
pub fn set_creation_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.creation_date = input;
self
}
/// <p>The identity that gets the permissions in the grant.</p>
/// <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p>
pub fn grantee_principal(mut self, input: impl Into<std::string::String>) -> Self {
self.grantee_principal = Some(input.into());
self
}
/// <p>The identity that gets the permissions in the grant.</p>
/// <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service principal</a>, which might represent several different grantee principals.</p>
pub fn set_grantee_principal(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.grantee_principal = input;
self
}
/// <p>The principal that can retire the grant.</p>
pub fn retiring_principal(mut self, input: impl Into<std::string::String>) -> Self {
self.retiring_principal = Some(input.into());
self
}
/// <p>The principal that can retire the grant.</p>
pub fn set_retiring_principal(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.retiring_principal = input;
self
}
/// <p>The Amazon Web Services account under which the grant was issued.</p>
pub fn issuing_account(mut self, input: impl Into<std::string::String>) -> Self {
self.issuing_account = Some(input.into());
self
}
/// <p>The Amazon Web Services account under which the grant was issued.</p>
pub fn set_issuing_account(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.issuing_account = input;
self
}
/// Appends an item to `operations`.
///
/// To override the contents of this collection use [`set_operations`](Self::set_operations).
///
/// <p>The list of operations permitted by the grant.</p>
pub fn operations(mut self, input: crate::model::GrantOperation) -> Self {
let mut v = self.operations.unwrap_or_default();
v.push(input);
self.operations = Some(v);
self
}
/// <p>The list of operations permitted by the grant.</p>
pub fn set_operations(
mut self,
input: std::option::Option<std::vec::Vec<crate::model::GrantOperation>>,
) -> Self {
self.operations = input;
self
}
/// <p>A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.</p>
pub fn constraints(mut self, input: crate::model::GrantConstraints) -> Self {
self.constraints = Some(input);
self
}
/// <p>A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.</p>
pub fn set_constraints(
mut self,
input: std::option::Option<crate::model::GrantConstraints>,
) -> Self {
self.constraints = input;
self
}
/// Consumes the builder and constructs a [`GrantListEntry`](crate::model::GrantListEntry).
pub fn build(self) -> crate::model::GrantListEntry {
crate::model::GrantListEntry {
key_id: self.key_id,
grant_id: self.grant_id,
name: self.name,
creation_date: self.creation_date,
grantee_principal: self.grantee_principal,
retiring_principal: self.retiring_principal,
issuing_account: self.issuing_account,
operations: self.operations,
constraints: self.constraints,
}
}
}
}
impl GrantListEntry {
/// Creates a new builder-style object to manufacture [`GrantListEntry`](crate::model::GrantListEntry).
pub fn builder() -> crate::model::grant_list_entry::Builder {
crate::model::grant_list_entry::Builder::default()
}
}
/// <p>Use this structure to allow <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> in the grant only when the operation request includes the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>. </p>
/// <p>KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks">symmetric encryption KMS key</a>. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with HMAC KMS keys or asymmetric KMS keys, and management operations, such as <code>DescribeKey</code> or <code>RetireGrant</code>.</p> <important>
/// <p>In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.</p>
/// <p>However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.</p>
/// <p>To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the <code>kms:EncryptionContext:</code> and <code>kms:EncryptionContextKeys</code> conditions in an IAM or key policy. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context">kms:EncryptionContext:</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p>
/// </important>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct GrantConstraints {
/// <p>A list of key-value pairs that must be included in the encryption context of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.</p>
#[doc(hidden)]
pub encryption_context_subset:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
/// <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.</p>
#[doc(hidden)]
pub encryption_context_equals:
std::option::Option<std::collections::HashMap<std::string::String, std::string::String>>,
}
impl GrantConstraints {
/// <p>A list of key-value pairs that must be included in the encryption context of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.</p>
pub fn encryption_context_subset(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.encryption_context_subset.as_ref()
}
/// <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.</p>
pub fn encryption_context_equals(
&self,
) -> std::option::Option<&std::collections::HashMap<std::string::String, std::string::String>>
{
self.encryption_context_equals.as_ref()
}
}
impl std::fmt::Debug for GrantConstraints {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("GrantConstraints");
formatter.field("encryption_context_subset", &self.encryption_context_subset);
formatter.field("encryption_context_equals", &self.encryption_context_equals);
formatter.finish()
}
}
/// See [`GrantConstraints`](crate::model::GrantConstraints).
pub mod grant_constraints {
/// A builder for [`GrantConstraints`](crate::model::GrantConstraints).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) encryption_context_subset: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
pub(crate) encryption_context_equals: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
}
impl Builder {
/// Adds a key-value pair to `encryption_context_subset`.
///
/// To override the contents of this collection use [`set_encryption_context_subset`](Self::set_encryption_context_subset).
///
/// <p>A list of key-value pairs that must be included in the encryption context of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.</p>
pub fn encryption_context_subset(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.encryption_context_subset.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.encryption_context_subset = Some(hash_map);
self
}
/// <p>A list of key-value pairs that must be included in the encryption context of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.</p>
pub fn set_encryption_context_subset(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.encryption_context_subset = input;
self
}
/// Adds a key-value pair to `encryption_context_equals`.
///
/// To override the contents of this collection use [`set_encryption_context_equals`](Self::set_encryption_context_equals).
///
/// <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.</p>
pub fn encryption_context_equals(
mut self,
k: impl Into<std::string::String>,
v: impl Into<std::string::String>,
) -> Self {
let mut hash_map = self.encryption_context_equals.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.encryption_context_equals = Some(hash_map);
self
}
/// <p>A list of key-value pairs that must match the encryption context in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operation</a> request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.</p>
pub fn set_encryption_context_equals(
mut self,
input: std::option::Option<
std::collections::HashMap<std::string::String, std::string::String>,
>,
) -> Self {
self.encryption_context_equals = input;
self
}
/// Consumes the builder and constructs a [`GrantConstraints`](crate::model::GrantConstraints).
pub fn build(self) -> crate::model::GrantConstraints {
crate::model::GrantConstraints {
encryption_context_subset: self.encryption_context_subset,
encryption_context_equals: self.encryption_context_equals,
}
}
}
}
impl GrantConstraints {
/// Creates a new builder-style object to manufacture [`GrantConstraints`](crate::model::GrantConstraints).
pub fn builder() -> crate::model::grant_constraints::Builder {
crate::model::grant_constraints::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum GrantOperation {
#[allow(missing_docs)] // documentation missing in model
CreateGrant,
#[allow(missing_docs)] // documentation missing in model
Decrypt,
#[allow(missing_docs)] // documentation missing in model
DescribeKey,
#[allow(missing_docs)] // documentation missing in model
Encrypt,
#[allow(missing_docs)] // documentation missing in model
GenerateDataKey,
#[allow(missing_docs)] // documentation missing in model
GenerateDataKeyPair,
#[allow(missing_docs)] // documentation missing in model
GenerateDataKeyPairWithoutPlaintext,
#[allow(missing_docs)] // documentation missing in model
GenerateDataKeyWithoutPlaintext,
#[allow(missing_docs)] // documentation missing in model
GenerateMac,
#[allow(missing_docs)] // documentation missing in model
GetPublicKey,
#[allow(missing_docs)] // documentation missing in model
ReEncryptFrom,
#[allow(missing_docs)] // documentation missing in model
ReEncryptTo,
#[allow(missing_docs)] // documentation missing in model
RetireGrant,
#[allow(missing_docs)] // documentation missing in model
Sign,
#[allow(missing_docs)] // documentation missing in model
Verify,
#[allow(missing_docs)] // documentation missing in model
VerifyMac,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for GrantOperation {
fn from(s: &str) -> Self {
match s {
"CreateGrant" => GrantOperation::CreateGrant,
"Decrypt" => GrantOperation::Decrypt,
"DescribeKey" => GrantOperation::DescribeKey,
"Encrypt" => GrantOperation::Encrypt,
"GenerateDataKey" => GrantOperation::GenerateDataKey,
"GenerateDataKeyPair" => GrantOperation::GenerateDataKeyPair,
"GenerateDataKeyPairWithoutPlaintext" => {
GrantOperation::GenerateDataKeyPairWithoutPlaintext
}
"GenerateDataKeyWithoutPlaintext" => GrantOperation::GenerateDataKeyWithoutPlaintext,
"GenerateMac" => GrantOperation::GenerateMac,
"GetPublicKey" => GrantOperation::GetPublicKey,
"ReEncryptFrom" => GrantOperation::ReEncryptFrom,
"ReEncryptTo" => GrantOperation::ReEncryptTo,
"RetireGrant" => GrantOperation::RetireGrant,
"Sign" => GrantOperation::Sign,
"Verify" => GrantOperation::Verify,
"VerifyMac" => GrantOperation::VerifyMac,
other => GrantOperation::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for GrantOperation {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(GrantOperation::from(s))
}
}
impl GrantOperation {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
GrantOperation::CreateGrant => "CreateGrant",
GrantOperation::Decrypt => "Decrypt",
GrantOperation::DescribeKey => "DescribeKey",
GrantOperation::Encrypt => "Encrypt",
GrantOperation::GenerateDataKey => "GenerateDataKey",
GrantOperation::GenerateDataKeyPair => "GenerateDataKeyPair",
GrantOperation::GenerateDataKeyPairWithoutPlaintext => {
"GenerateDataKeyPairWithoutPlaintext"
}
GrantOperation::GenerateDataKeyWithoutPlaintext => "GenerateDataKeyWithoutPlaintext",
GrantOperation::GenerateMac => "GenerateMac",
GrantOperation::GetPublicKey => "GetPublicKey",
GrantOperation::ReEncryptFrom => "ReEncryptFrom",
GrantOperation::ReEncryptTo => "ReEncryptTo",
GrantOperation::RetireGrant => "RetireGrant",
GrantOperation::Sign => "Sign",
GrantOperation::Verify => "Verify",
GrantOperation::VerifyMac => "VerifyMac",
GrantOperation::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"CreateGrant",
"Decrypt",
"DescribeKey",
"Encrypt",
"GenerateDataKey",
"GenerateDataKeyPair",
"GenerateDataKeyPairWithoutPlaintext",
"GenerateDataKeyWithoutPlaintext",
"GenerateMac",
"GetPublicKey",
"ReEncryptFrom",
"ReEncryptTo",
"RetireGrant",
"Sign",
"Verify",
"VerifyMac",
]
}
}
impl AsRef<str> for GrantOperation {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Contains information about each entry in the key list.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct KeyListEntry {
/// <p>Unique identifier of the key.</p>
#[doc(hidden)]
pub key_id: std::option::Option<std::string::String>,
/// <p>ARN of the key.</p>
#[doc(hidden)]
pub key_arn: std::option::Option<std::string::String>,
}
impl KeyListEntry {
/// <p>Unique identifier of the key.</p>
pub fn key_id(&self) -> std::option::Option<&str> {
self.key_id.as_deref()
}
/// <p>ARN of the key.</p>
pub fn key_arn(&self) -> std::option::Option<&str> {
self.key_arn.as_deref()
}
}
impl std::fmt::Debug for KeyListEntry {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("KeyListEntry");
formatter.field("key_id", &self.key_id);
formatter.field("key_arn", &self.key_arn);
formatter.finish()
}
}
/// See [`KeyListEntry`](crate::model::KeyListEntry).
pub mod key_list_entry {
/// A builder for [`KeyListEntry`](crate::model::KeyListEntry).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) key_id: std::option::Option<std::string::String>,
pub(crate) key_arn: std::option::Option<std::string::String>,
}
impl Builder {
/// <p>Unique identifier of the key.</p>
pub fn key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.key_id = Some(input.into());
self
}
/// <p>Unique identifier of the key.</p>
pub fn set_key_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.key_id = input;
self
}
/// <p>ARN of the key.</p>
pub fn key_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.key_arn = Some(input.into());
self
}
/// <p>ARN of the key.</p>
pub fn set_key_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.key_arn = input;
self
}
/// Consumes the builder and constructs a [`KeyListEntry`](crate::model::KeyListEntry).
pub fn build(self) -> crate::model::KeyListEntry {
crate::model::KeyListEntry {
key_id: self.key_id,
key_arn: self.key_arn,
}
}
}
}
impl KeyListEntry {
/// Creates a new builder-style object to manufacture [`KeyListEntry`](crate::model::KeyListEntry).
pub fn builder() -> crate::model::key_list_entry::Builder {
crate::model::key_list_entry::Builder::default()
}
}
/// <p>Contains information about an alias.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct AliasListEntry {
/// <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
#[doc(hidden)]
pub alias_name: std::option::Option<std::string::String>,
/// <p>String that contains the key ARN.</p>
#[doc(hidden)]
pub alias_arn: std::option::Option<std::string::String>,
/// <p>String that contains the key identifier of the KMS key associated with the alias.</p>
#[doc(hidden)]
pub target_key_id: std::option::Option<std::string::String>,
/// <p>Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.</p>
#[doc(hidden)]
pub creation_date: std::option::Option<aws_smithy_types::DateTime>,
/// <p>Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.</p>
#[doc(hidden)]
pub last_updated_date: std::option::Option<aws_smithy_types::DateTime>,
}
impl AliasListEntry {
/// <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
pub fn alias_name(&self) -> std::option::Option<&str> {
self.alias_name.as_deref()
}
/// <p>String that contains the key ARN.</p>
pub fn alias_arn(&self) -> std::option::Option<&str> {
self.alias_arn.as_deref()
}
/// <p>String that contains the key identifier of the KMS key associated with the alias.</p>
pub fn target_key_id(&self) -> std::option::Option<&str> {
self.target_key_id.as_deref()
}
/// <p>Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.</p>
pub fn creation_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.creation_date.as_ref()
}
/// <p>Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.</p>
pub fn last_updated_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.last_updated_date.as_ref()
}
}
impl std::fmt::Debug for AliasListEntry {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("AliasListEntry");
formatter.field("alias_name", &self.alias_name);
formatter.field("alias_arn", &self.alias_arn);
formatter.field("target_key_id", &self.target_key_id);
formatter.field("creation_date", &self.creation_date);
formatter.field("last_updated_date", &self.last_updated_date);
formatter.finish()
}
}
/// See [`AliasListEntry`](crate::model::AliasListEntry).
pub mod alias_list_entry {
/// A builder for [`AliasListEntry`](crate::model::AliasListEntry).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) alias_name: std::option::Option<std::string::String>,
pub(crate) alias_arn: std::option::Option<std::string::String>,
pub(crate) target_key_id: std::option::Option<std::string::String>,
pub(crate) creation_date: std::option::Option<aws_smithy_types::DateTime>,
pub(crate) last_updated_date: std::option::Option<aws_smithy_types::DateTime>,
}
impl Builder {
/// <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
pub fn alias_name(mut self, input: impl Into<std::string::String>) -> Self {
self.alias_name = Some(input.into());
self
}
/// <p>String that contains the alias. This value begins with <code>alias/</code>.</p>
pub fn set_alias_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.alias_name = input;
self
}
/// <p>String that contains the key ARN.</p>
pub fn alias_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.alias_arn = Some(input.into());
self
}
/// <p>String that contains the key ARN.</p>
pub fn set_alias_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.alias_arn = input;
self
}
/// <p>String that contains the key identifier of the KMS key associated with the alias.</p>
pub fn target_key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.target_key_id = Some(input.into());
self
}
/// <p>String that contains the key identifier of the KMS key associated with the alias.</p>
pub fn set_target_key_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.target_key_id = input;
self
}
/// <p>Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.</p>
pub fn creation_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.creation_date = Some(input);
self
}
/// <p>Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.</p>
pub fn set_creation_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.creation_date = input;
self
}
/// <p>Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.</p>
pub fn last_updated_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.last_updated_date = Some(input);
self
}
/// <p>Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.</p>
pub fn set_last_updated_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.last_updated_date = input;
self
}
/// Consumes the builder and constructs a [`AliasListEntry`](crate::model::AliasListEntry).
pub fn build(self) -> crate::model::AliasListEntry {
crate::model::AliasListEntry {
alias_name: self.alias_name,
alias_arn: self.alias_arn,
target_key_id: self.target_key_id,
creation_date: self.creation_date,
last_updated_date: self.last_updated_date,
}
}
}
}
impl AliasListEntry {
/// Creates a new builder-style object to manufacture [`AliasListEntry`](crate::model::AliasListEntry).
pub fn builder() -> crate::model::alias_list_entry::Builder {
crate::model::alias_list_entry::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum WrappingKeySpec {
#[allow(missing_docs)] // documentation missing in model
Rsa2048,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for WrappingKeySpec {
fn from(s: &str) -> Self {
match s {
"RSA_2048" => WrappingKeySpec::Rsa2048,
other => WrappingKeySpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for WrappingKeySpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(WrappingKeySpec::from(s))
}
}
impl WrappingKeySpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
WrappingKeySpec::Rsa2048 => "RSA_2048",
WrappingKeySpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["RSA_2048"]
}
}
impl AsRef<str> for WrappingKeySpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum AlgorithmSpec {
#[allow(missing_docs)] // documentation missing in model
RsaesOaepSha1,
#[allow(missing_docs)] // documentation missing in model
RsaesOaepSha256,
#[allow(missing_docs)] // documentation missing in model
RsaesPkcs1V15,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for AlgorithmSpec {
fn from(s: &str) -> Self {
match s {
"RSAES_OAEP_SHA_1" => AlgorithmSpec::RsaesOaepSha1,
"RSAES_OAEP_SHA_256" => AlgorithmSpec::RsaesOaepSha256,
"RSAES_PKCS1_V1_5" => AlgorithmSpec::RsaesPkcs1V15,
other => AlgorithmSpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for AlgorithmSpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(AlgorithmSpec::from(s))
}
}
impl AlgorithmSpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
AlgorithmSpec::RsaesOaepSha1 => "RSAES_OAEP_SHA_1",
AlgorithmSpec::RsaesOaepSha256 => "RSAES_OAEP_SHA_256",
AlgorithmSpec::RsaesPkcs1V15 => "RSAES_PKCS1_V1_5",
AlgorithmSpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "RSAES_PKCS1_V1_5"]
}
}
impl AsRef<str> for AlgorithmSpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum DataKeySpec {
#[allow(missing_docs)] // documentation missing in model
Aes128,
#[allow(missing_docs)] // documentation missing in model
Aes256,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for DataKeySpec {
fn from(s: &str) -> Self {
match s {
"AES_128" => DataKeySpec::Aes128,
"AES_256" => DataKeySpec::Aes256,
other => DataKeySpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for DataKeySpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(DataKeySpec::from(s))
}
}
impl DataKeySpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
DataKeySpec::Aes128 => "AES_128",
DataKeySpec::Aes256 => "AES_256",
DataKeySpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&["AES_128", "AES_256"]
}
}
impl AsRef<str> for DataKeySpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum DataKeyPairSpec {
#[allow(missing_docs)] // documentation missing in model
EccNistP256,
#[allow(missing_docs)] // documentation missing in model
EccNistP384,
#[allow(missing_docs)] // documentation missing in model
EccNistP521,
#[allow(missing_docs)] // documentation missing in model
EccSecgP256K1,
#[allow(missing_docs)] // documentation missing in model
Rsa2048,
#[allow(missing_docs)] // documentation missing in model
Rsa3072,
#[allow(missing_docs)] // documentation missing in model
Rsa4096,
#[allow(missing_docs)] // documentation missing in model
Sm2,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for DataKeyPairSpec {
fn from(s: &str) -> Self {
match s {
"ECC_NIST_P256" => DataKeyPairSpec::EccNistP256,
"ECC_NIST_P384" => DataKeyPairSpec::EccNistP384,
"ECC_NIST_P521" => DataKeyPairSpec::EccNistP521,
"ECC_SECG_P256K1" => DataKeyPairSpec::EccSecgP256K1,
"RSA_2048" => DataKeyPairSpec::Rsa2048,
"RSA_3072" => DataKeyPairSpec::Rsa3072,
"RSA_4096" => DataKeyPairSpec::Rsa4096,
"SM2" => DataKeyPairSpec::Sm2,
other => DataKeyPairSpec::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for DataKeyPairSpec {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(DataKeyPairSpec::from(s))
}
}
impl DataKeyPairSpec {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
DataKeyPairSpec::EccNistP256 => "ECC_NIST_P256",
DataKeyPairSpec::EccNistP384 => "ECC_NIST_P384",
DataKeyPairSpec::EccNistP521 => "ECC_NIST_P521",
DataKeyPairSpec::EccSecgP256K1 => "ECC_SECG_P256K1",
DataKeyPairSpec::Rsa2048 => "RSA_2048",
DataKeyPairSpec::Rsa3072 => "RSA_3072",
DataKeyPairSpec::Rsa4096 => "RSA_4096",
DataKeyPairSpec::Sm2 => "SM2",
DataKeyPairSpec::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"ECC_NIST_P256",
"ECC_NIST_P384",
"ECC_NIST_P521",
"ECC_SECG_P256K1",
"RSA_2048",
"RSA_3072",
"RSA_4096",
"SM2",
]
}
}
impl AsRef<str> for DataKeyPairSpec {
fn as_ref(&self) -> &str {
self.as_str()
}
}
/// <p>Contains information about each custom key store in the custom key store list.</p>
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq)]
pub struct CustomKeyStoresListEntry {
/// <p>A unique identifier for the custom key store.</p>
#[doc(hidden)]
pub custom_key_store_id: std::option::Option<std::string::String>,
/// <p>The user-specified friendly name for the custom key store.</p>
#[doc(hidden)]
pub custom_key_store_name: std::option::Option<std::string::String>,
/// <p>A unique identifier for the CloudHSM cluster that is associated with the custom key store.</p>
#[doc(hidden)]
pub cloud_hsm_cluster_id: std::option::Option<std::string::String>,
/// <p>The trust anchor certificate of the associated CloudHSM cluster. When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code> file.</p>
#[doc(hidden)]
pub trust_anchor_certificate: std::option::Option<std::string::String>,
/// <p>Indicates whether the custom key store is connected to its CloudHSM cluster.</p>
/// <p>You can create and use KMS keys in your custom key stores only when its connection state is <code>CONNECTED</code>.</p>
/// <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <code>DisconnectCustomKeyStore</code> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.</p>
/// <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure. For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
#[doc(hidden)]
pub connection_state: std::option::Option<crate::model::ConnectionStateType>,
/// <p>Describes the connection error. This field appears in the response only when the <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in <i>Key Management Service Developer Guide</i>.</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li> <p> <code>CLUSTER_NOT_FOUND</code> - KMS cannot find the CloudHSM cluster with the specified cluster ID.</p> </li>
/// <li> <p> <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li>
/// <li> <p> <code>INTERNAL_ERROR</code> - KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li>
/// <li> <p> <code>INVALID_CREDENTIALS</code> - KMS does not have the correct password for the <code>kmsuser</code> crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>NETWORK_ERRORS</code> - Network errors are preventing KMS from connecting to the custom key store.</p> </li>
/// <li> <p> <code>SUBNET_NOT_FOUND</code> - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the <code>kmsuser</code> account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster. If you changed the <code>kmsuser</code> password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2">How to Log Out and Reconnect</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_NOT_FOUND</code> - KMS cannot find a <code>kmsuser</code> CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update the key store password value for the custom key store.</p> </li>
/// </ul>
#[doc(hidden)]
pub connection_error_code: std::option::Option<crate::model::ConnectionErrorCodeType>,
/// <p>The date and time when the custom key store was created.</p>
#[doc(hidden)]
pub creation_date: std::option::Option<aws_smithy_types::DateTime>,
}
impl CustomKeyStoresListEntry {
/// <p>A unique identifier for the custom key store.</p>
pub fn custom_key_store_id(&self) -> std::option::Option<&str> {
self.custom_key_store_id.as_deref()
}
/// <p>The user-specified friendly name for the custom key store.</p>
pub fn custom_key_store_name(&self) -> std::option::Option<&str> {
self.custom_key_store_name.as_deref()
}
/// <p>A unique identifier for the CloudHSM cluster that is associated with the custom key store.</p>
pub fn cloud_hsm_cluster_id(&self) -> std::option::Option<&str> {
self.cloud_hsm_cluster_id.as_deref()
}
/// <p>The trust anchor certificate of the associated CloudHSM cluster. When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code> file.</p>
pub fn trust_anchor_certificate(&self) -> std::option::Option<&str> {
self.trust_anchor_certificate.as_deref()
}
/// <p>Indicates whether the custom key store is connected to its CloudHSM cluster.</p>
/// <p>You can create and use KMS keys in your custom key stores only when its connection state is <code>CONNECTED</code>.</p>
/// <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <code>DisconnectCustomKeyStore</code> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.</p>
/// <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure. For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn connection_state(&self) -> std::option::Option<&crate::model::ConnectionStateType> {
self.connection_state.as_ref()
}
/// <p>Describes the connection error. This field appears in the response only when the <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in <i>Key Management Service Developer Guide</i>.</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li> <p> <code>CLUSTER_NOT_FOUND</code> - KMS cannot find the CloudHSM cluster with the specified cluster ID.</p> </li>
/// <li> <p> <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li>
/// <li> <p> <code>INTERNAL_ERROR</code> - KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li>
/// <li> <p> <code>INVALID_CREDENTIALS</code> - KMS does not have the correct password for the <code>kmsuser</code> crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>NETWORK_ERRORS</code> - Network errors are preventing KMS from connecting to the custom key store.</p> </li>
/// <li> <p> <code>SUBNET_NOT_FOUND</code> - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the <code>kmsuser</code> account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster. If you changed the <code>kmsuser</code> password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2">How to Log Out and Reconnect</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_NOT_FOUND</code> - KMS cannot find a <code>kmsuser</code> CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update the key store password value for the custom key store.</p> </li>
/// </ul>
pub fn connection_error_code(
&self,
) -> std::option::Option<&crate::model::ConnectionErrorCodeType> {
self.connection_error_code.as_ref()
}
/// <p>The date and time when the custom key store was created.</p>
pub fn creation_date(&self) -> std::option::Option<&aws_smithy_types::DateTime> {
self.creation_date.as_ref()
}
}
impl std::fmt::Debug for CustomKeyStoresListEntry {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut formatter = f.debug_struct("CustomKeyStoresListEntry");
formatter.field("custom_key_store_id", &self.custom_key_store_id);
formatter.field("custom_key_store_name", &self.custom_key_store_name);
formatter.field("cloud_hsm_cluster_id", &self.cloud_hsm_cluster_id);
formatter.field("trust_anchor_certificate", &self.trust_anchor_certificate);
formatter.field("connection_state", &self.connection_state);
formatter.field("connection_error_code", &self.connection_error_code);
formatter.field("creation_date", &self.creation_date);
formatter.finish()
}
}
/// See [`CustomKeyStoresListEntry`](crate::model::CustomKeyStoresListEntry).
pub mod custom_key_stores_list_entry {
/// A builder for [`CustomKeyStoresListEntry`](crate::model::CustomKeyStoresListEntry).
#[derive(std::default::Default, std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct Builder {
pub(crate) custom_key_store_id: std::option::Option<std::string::String>,
pub(crate) custom_key_store_name: std::option::Option<std::string::String>,
pub(crate) cloud_hsm_cluster_id: std::option::Option<std::string::String>,
pub(crate) trust_anchor_certificate: std::option::Option<std::string::String>,
pub(crate) connection_state: std::option::Option<crate::model::ConnectionStateType>,
pub(crate) connection_error_code:
std::option::Option<crate::model::ConnectionErrorCodeType>,
pub(crate) creation_date: std::option::Option<aws_smithy_types::DateTime>,
}
impl Builder {
/// <p>A unique identifier for the custom key store.</p>
pub fn custom_key_store_id(mut self, input: impl Into<std::string::String>) -> Self {
self.custom_key_store_id = Some(input.into());
self
}
/// <p>A unique identifier for the custom key store.</p>
pub fn set_custom_key_store_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.custom_key_store_id = input;
self
}
/// <p>The user-specified friendly name for the custom key store.</p>
pub fn custom_key_store_name(mut self, input: impl Into<std::string::String>) -> Self {
self.custom_key_store_name = Some(input.into());
self
}
/// <p>The user-specified friendly name for the custom key store.</p>
pub fn set_custom_key_store_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.custom_key_store_name = input;
self
}
/// <p>A unique identifier for the CloudHSM cluster that is associated with the custom key store.</p>
pub fn cloud_hsm_cluster_id(mut self, input: impl Into<std::string::String>) -> Self {
self.cloud_hsm_cluster_id = Some(input.into());
self
}
/// <p>A unique identifier for the CloudHSM cluster that is associated with the custom key store.</p>
pub fn set_cloud_hsm_cluster_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.cloud_hsm_cluster_id = input;
self
}
/// <p>The trust anchor certificate of the associated CloudHSM cluster. When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code> file.</p>
pub fn trust_anchor_certificate(mut self, input: impl Into<std::string::String>) -> Self {
self.trust_anchor_certificate = Some(input.into());
self
}
/// <p>The trust anchor certificate of the associated CloudHSM cluster. When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code> file.</p>
pub fn set_trust_anchor_certificate(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.trust_anchor_certificate = input;
self
}
/// <p>Indicates whether the custom key store is connected to its CloudHSM cluster.</p>
/// <p>You can create and use KMS keys in your custom key stores only when its connection state is <code>CONNECTED</code>.</p>
/// <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <code>DisconnectCustomKeyStore</code> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.</p>
/// <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure. For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn connection_state(mut self, input: crate::model::ConnectionStateType) -> Self {
self.connection_state = Some(input);
self
}
/// <p>Indicates whether the custom key store is connected to its CloudHSM cluster.</p>
/// <p>You can create and use KMS keys in your custom key stores only when its connection state is <code>CONNECTED</code>.</p>
/// <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <code>DisconnectCustomKeyStore</code> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains at least one active HSM.</p>
/// <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure. For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn set_connection_state(
mut self,
input: std::option::Option<crate::model::ConnectionStateType>,
) -> Self {
self.connection_state = input;
self
}
/// <p>Describes the connection error. This field appears in the response only when the <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in <i>Key Management Service Developer Guide</i>.</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li> <p> <code>CLUSTER_NOT_FOUND</code> - KMS cannot find the CloudHSM cluster with the specified cluster ID.</p> </li>
/// <li> <p> <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li>
/// <li> <p> <code>INTERNAL_ERROR</code> - KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li>
/// <li> <p> <code>INVALID_CREDENTIALS</code> - KMS does not have the correct password for the <code>kmsuser</code> crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>NETWORK_ERRORS</code> - Network errors are preventing KMS from connecting to the custom key store.</p> </li>
/// <li> <p> <code>SUBNET_NOT_FOUND</code> - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the <code>kmsuser</code> account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster. If you changed the <code>kmsuser</code> password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2">How to Log Out and Reconnect</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_NOT_FOUND</code> - KMS cannot find a <code>kmsuser</code> CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update the key store password value for the custom key store.</p> </li>
/// </ul>
pub fn connection_error_code(
mut self,
input: crate::model::ConnectionErrorCodeType,
) -> Self {
self.connection_error_code = Some(input);
self
}
/// <p>Describes the connection error. This field appears in the response only when the <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in <i>Key Management Service Developer Guide</i>.</p>
/// <p>Valid values are:</p>
/// <ul>
/// <li> <p> <code>CLUSTER_NOT_FOUND</code> - KMS cannot find the CloudHSM cluster with the specified cluster ID.</p> </li>
/// <li> <p> <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li>
/// <li> <p> <code>INTERNAL_ERROR</code> - KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li>
/// <li> <p> <code>INVALID_CREDENTIALS</code> - KMS does not have the correct password for the <code>kmsuser</code> crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>NETWORK_ERRORS</code> - Network errors are preventing KMS from connecting to the custom key store.</p> </li>
/// <li> <p> <code>SUBNET_NOT_FOUND</code> - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to Fix a Connection Failure</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li>
/// <li> <p> <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the the associated CloudHSM cluster. This prevents KMS from rotating the <code>kmsuser</code> account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster. If you changed the <code>kmsuser</code> password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2">How to Log Out and Reconnect</a> in the <i>Key Management Service Developer Guide</i>.</p> </li>
/// <li> <p> <code>USER_NOT_FOUND</code> - KMS cannot find a <code>kmsuser</code> CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update the key store password value for the custom key store.</p> </li>
/// </ul>
pub fn set_connection_error_code(
mut self,
input: std::option::Option<crate::model::ConnectionErrorCodeType>,
) -> Self {
self.connection_error_code = input;
self
}
/// <p>The date and time when the custom key store was created.</p>
pub fn creation_date(mut self, input: aws_smithy_types::DateTime) -> Self {
self.creation_date = Some(input);
self
}
/// <p>The date and time when the custom key store was created.</p>
pub fn set_creation_date(
mut self,
input: std::option::Option<aws_smithy_types::DateTime>,
) -> Self {
self.creation_date = input;
self
}
/// Consumes the builder and constructs a [`CustomKeyStoresListEntry`](crate::model::CustomKeyStoresListEntry).
pub fn build(self) -> crate::model::CustomKeyStoresListEntry {
crate::model::CustomKeyStoresListEntry {
custom_key_store_id: self.custom_key_store_id,
custom_key_store_name: self.custom_key_store_name,
cloud_hsm_cluster_id: self.cloud_hsm_cluster_id,
trust_anchor_certificate: self.trust_anchor_certificate,
connection_state: self.connection_state,
connection_error_code: self.connection_error_code,
creation_date: self.creation_date,
}
}
}
}
impl CustomKeyStoresListEntry {
/// Creates a new builder-style object to manufacture [`CustomKeyStoresListEntry`](crate::model::CustomKeyStoresListEntry).
pub fn builder() -> crate::model::custom_key_stores_list_entry::Builder {
crate::model::custom_key_stores_list_entry::Builder::default()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum ConnectionErrorCodeType {
#[allow(missing_docs)] // documentation missing in model
ClusterNotFound,
#[allow(missing_docs)] // documentation missing in model
InsufficientCloudhsmHsms,
#[allow(missing_docs)] // documentation missing in model
InsufficientFreeAddressesInSubnet,
#[allow(missing_docs)] // documentation missing in model
InternalError,
#[allow(missing_docs)] // documentation missing in model
InvalidCredentials,
#[allow(missing_docs)] // documentation missing in model
NetworkErrors,
#[allow(missing_docs)] // documentation missing in model
SubnetNotFound,
#[allow(missing_docs)] // documentation missing in model
UserLockedOut,
#[allow(missing_docs)] // documentation missing in model
UserLoggedIn,
#[allow(missing_docs)] // documentation missing in model
UserNotFound,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for ConnectionErrorCodeType {
fn from(s: &str) -> Self {
match s {
"CLUSTER_NOT_FOUND" => ConnectionErrorCodeType::ClusterNotFound,
"INSUFFICIENT_CLOUDHSM_HSMS" => ConnectionErrorCodeType::InsufficientCloudhsmHsms,
"INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET" => {
ConnectionErrorCodeType::InsufficientFreeAddressesInSubnet
}
"INTERNAL_ERROR" => ConnectionErrorCodeType::InternalError,
"INVALID_CREDENTIALS" => ConnectionErrorCodeType::InvalidCredentials,
"NETWORK_ERRORS" => ConnectionErrorCodeType::NetworkErrors,
"SUBNET_NOT_FOUND" => ConnectionErrorCodeType::SubnetNotFound,
"USER_LOCKED_OUT" => ConnectionErrorCodeType::UserLockedOut,
"USER_LOGGED_IN" => ConnectionErrorCodeType::UserLoggedIn,
"USER_NOT_FOUND" => ConnectionErrorCodeType::UserNotFound,
other => ConnectionErrorCodeType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for ConnectionErrorCodeType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(ConnectionErrorCodeType::from(s))
}
}
impl ConnectionErrorCodeType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
ConnectionErrorCodeType::ClusterNotFound => "CLUSTER_NOT_FOUND",
ConnectionErrorCodeType::InsufficientCloudhsmHsms => "INSUFFICIENT_CLOUDHSM_HSMS",
ConnectionErrorCodeType::InsufficientFreeAddressesInSubnet => {
"INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET"
}
ConnectionErrorCodeType::InternalError => "INTERNAL_ERROR",
ConnectionErrorCodeType::InvalidCredentials => "INVALID_CREDENTIALS",
ConnectionErrorCodeType::NetworkErrors => "NETWORK_ERRORS",
ConnectionErrorCodeType::SubnetNotFound => "SUBNET_NOT_FOUND",
ConnectionErrorCodeType::UserLockedOut => "USER_LOCKED_OUT",
ConnectionErrorCodeType::UserLoggedIn => "USER_LOGGED_IN",
ConnectionErrorCodeType::UserNotFound => "USER_NOT_FOUND",
ConnectionErrorCodeType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"CLUSTER_NOT_FOUND",
"INSUFFICIENT_CLOUDHSM_HSMS",
"INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET",
"INTERNAL_ERROR",
"INVALID_CREDENTIALS",
"NETWORK_ERRORS",
"SUBNET_NOT_FOUND",
"USER_LOCKED_OUT",
"USER_LOGGED_IN",
"USER_NOT_FOUND",
]
}
}
impl AsRef<str> for ConnectionErrorCodeType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(
std::clone::Clone,
std::cmp::Eq,
std::cmp::Ord,
std::cmp::PartialEq,
std::cmp::PartialOrd,
std::fmt::Debug,
std::hash::Hash,
)]
pub enum ConnectionStateType {
#[allow(missing_docs)] // documentation missing in model
Connected,
#[allow(missing_docs)] // documentation missing in model
Connecting,
#[allow(missing_docs)] // documentation missing in model
Disconnected,
#[allow(missing_docs)] // documentation missing in model
Disconnecting,
#[allow(missing_docs)] // documentation missing in model
Failed,
/// Unknown contains new variants that have been added since this code was generated.
Unknown(String),
}
impl std::convert::From<&str> for ConnectionStateType {
fn from(s: &str) -> Self {
match s {
"CONNECTED" => ConnectionStateType::Connected,
"CONNECTING" => ConnectionStateType::Connecting,
"DISCONNECTED" => ConnectionStateType::Disconnected,
"DISCONNECTING" => ConnectionStateType::Disconnecting,
"FAILED" => ConnectionStateType::Failed,
other => ConnectionStateType::Unknown(other.to_owned()),
}
}
}
impl std::str::FromStr for ConnectionStateType {
type Err = std::convert::Infallible;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
Ok(ConnectionStateType::from(s))
}
}
impl ConnectionStateType {
/// Returns the `&str` value of the enum member.
pub fn as_str(&self) -> &str {
match self {
ConnectionStateType::Connected => "CONNECTED",
ConnectionStateType::Connecting => "CONNECTING",
ConnectionStateType::Disconnected => "DISCONNECTED",
ConnectionStateType::Disconnecting => "DISCONNECTING",
ConnectionStateType::Failed => "FAILED",
ConnectionStateType::Unknown(s) => s.as_ref(),
}
}
/// Returns all the `&str` values of the enum members.
pub fn values() -> &'static [&'static str] {
&[
"CONNECTED",
"CONNECTING",
"DISCONNECTED",
"DISCONNECTING",
"FAILED",
]
}
}
impl AsRef<str> for ConnectionStateType {
fn as_ref(&self) -> &str {
self.as_str()
}
}