rds.d.ts
523 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
import {Signer as signer} from '../lib/rds/signer';
interface Blob {}
declare class RDS extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: RDS.Types.ClientConfiguration)
config: Config & RDS.Types.ClientConfiguration;
/**
* Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
addRoleToDBCluster(params: RDS.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates an AWS Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available.
*/
addRoleToDBInstance(params: RDS.Types.AddRoleToDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates an AWS Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available.
*/
addRoleToDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds a source identifier to an existing RDS event notification subscription.
*/
addSourceIdentifierToSubscription(params: RDS.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<RDS.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
/**
* Adds a source identifier to an existing RDS event notification subscription.
*/
addSourceIdentifierToSubscription(callback?: (err: AWSError, data: RDS.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<RDS.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
/**
* Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
*/
addTagsToResource(params: RDS.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS. For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.
*/
addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*/
applyPendingMaintenanceAction(params: RDS.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*/
applyPendingMaintenanceAction(callback?: (err: AWSError, data: RDS.Types.ApplyPendingMaintenanceActionResult) => void): Request<RDS.Types.ApplyPendingMaintenanceActionResult, AWSError>;
/**
* Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
*/
authorizeDBSecurityGroupIngress(params: RDS.Types.AuthorizeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
/**
* Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
*/
authorizeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
/**
* Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters.
*/
backtrackDBCluster(params: RDS.Types.BacktrackDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request<RDS.Types.DBClusterBacktrack, AWSError>;
/**
* Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters.
*/
backtrackDBCluster(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request<RDS.Types.DBClusterBacktrack, AWSError>;
/**
* Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
*/
cancelExportTask(params: RDS.Types.CancelExportTaskMessage, callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
/**
* Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
*/
cancelExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
/**
* Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.
*/
copyDBClusterParameterGroup(params: RDS.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
/**
* Copies the specified DB cluster parameter group. This action only applies to Aurora DB clusters.
*/
copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
/**
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
/**
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
/**
* Copies the specified DB parameter group.
*/
copyDBParameterGroup(params: RDS.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
/**
* Copies the specified DB parameter group.
*/
copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
/**
* Copies the specified DB snapshot. The source DB snapshot must be in the available or storage-optimization state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
*/
copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
/**
* Copies the specified DB snapshot. The source DB snapshot must be in the available or storage-optimization state. You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
*/
copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
/**
* Copies the specified option group.
*/
copyOptionGroup(params: RDS.Types.CopyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
/**
* Copies the specified option group.
*/
copyOptionGroup(callback?: (err: AWSError, data: RDS.Types.CopyOptionGroupResult) => void): Request<RDS.Types.CopyOptionGroupResult, AWSError>;
/**
* Creates a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
createCustomAvailabilityZone(params: RDS.Types.CreateCustomAvailabilityZoneMessage, callback?: (err: AWSError, data: RDS.Types.CreateCustomAvailabilityZoneResult) => void): Request<RDS.Types.CreateCustomAvailabilityZoneResult, AWSError>;
/**
* Creates a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
createCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.CreateCustomAvailabilityZoneResult) => void): Request<RDS.Types.CreateCustomAvailabilityZoneResult, AWSError>;
/**
* Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
/**
* Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
/**
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
createDBClusterEndpoint(params: RDS.Types.CreateDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
/**
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
createDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
/**
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
/**
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
/**
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
createDBClusterSnapshot(params: RDS.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
/**
* Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
/**
* Creates a new DB instance.
*/
createDBInstance(params: RDS.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
/**
* Creates a new DB instance.
*/
createDBInstance(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
/**
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance for an Aurora DB cluster. All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified. Your source DB instance must have backup retention enabled.
*/
createDBInstanceReadReplica(params: RDS.Types.CreateDBInstanceReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
/**
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance for an Aurora DB cluster. All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified. Your source DB instance must have backup retention enabled.
*/
createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
/**
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
/**
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
/**
* Creates a new DB proxy.
*/
createDBProxy(params: RDS.Types.CreateDBProxyRequest, callback?: (err: AWSError, data: RDS.Types.CreateDBProxyResponse) => void): Request<RDS.Types.CreateDBProxyResponse, AWSError>;
/**
* Creates a new DB proxy.
*/
createDBProxy(callback?: (err: AWSError, data: RDS.Types.CreateDBProxyResponse) => void): Request<RDS.Types.CreateDBProxyResponse, AWSError>;
/**
* Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
*/
createDBSecurityGroup(params: RDS.Types.CreateDBSecurityGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
/**
* Creates a new DB security group. DB security groups control access to a DB instance. A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
*/
createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
/**
* Creates a DBSnapshot. The source DBInstance must be in "available" state.
*/
createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
/**
* Creates a DBSnapshot. The source DBInstance must be in "available" state.
*/
createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
/**
* Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
*/
createDBSubnetGroup(params: RDS.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
/**
* Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
*/
createDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
/**
* Creates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account. RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
*/
createEventSubscription(params: RDS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
/**
* Creates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account. RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
*/
createEventSubscription(callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
/**
* Creates an Aurora global database spread across multiple AWS Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only applies to Aurora DB clusters.
*/
createGlobalCluster(params: RDS.Types.CreateGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
/**
* Creates an Aurora global database spread across multiple AWS Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only applies to Aurora DB clusters.
*/
createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
/**
* Creates a new option group. You can create up to 20 option groups.
*/
createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
/**
* Creates a new option group. You can create up to 20 option groups.
*/
createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
/**
* Deletes a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
deleteCustomAvailabilityZone(params: RDS.Types.DeleteCustomAvailabilityZoneMessage, callback?: (err: AWSError, data: RDS.Types.DeleteCustomAvailabilityZoneResult) => void): Request<RDS.Types.DeleteCustomAvailabilityZoneResult, AWSError>;
/**
* Deletes a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
deleteCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.DeleteCustomAvailabilityZoneResult) => void): Request<RDS.Types.DeleteCustomAvailabilityZoneResult, AWSError>;
/**
* The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
deleteDBCluster(params: RDS.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
/**
* The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
deleteDBCluster(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterResult) => void): Request<RDS.Types.DeleteDBClusterResult, AWSError>;
/**
* Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
deleteDBClusterEndpoint(params: RDS.Types.DeleteDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
/**
* Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
deleteDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
/**
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
deleteDBClusterParameterGroup(params: RDS.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
deleteDBClusterSnapshot(params: RDS.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
/**
* Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
deleteDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBClusterSnapshotResult) => void): Request<RDS.Types.DeleteDBClusterSnapshotResult, AWSError>;
/**
* The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter. If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB cluster is a read replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
*/
deleteDBInstance(params: RDS.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
/**
* The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted. If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter. If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true: The DB cluster is a read replica of another Amazon Aurora DB cluster. The DB instance is the only instance in the DB cluster. To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
*/
deleteDBInstance(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
/**
* Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
*/
deleteDBInstanceAutomatedBackup(params: RDS.Types.DeleteDBInstanceAutomatedBackupMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
/**
* Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
*/
deleteDBInstanceAutomatedBackup(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
/**
* Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
*/
deleteDBParameterGroup(params: RDS.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
*/
deleteDBParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing proxy.
*/
deleteDBProxy(params: RDS.Types.DeleteDBProxyRequest, callback?: (err: AWSError, data: RDS.Types.DeleteDBProxyResponse) => void): Request<RDS.Types.DeleteDBProxyResponse, AWSError>;
/**
* Deletes an existing proxy.
*/
deleteDBProxy(callback?: (err: AWSError, data: RDS.Types.DeleteDBProxyResponse) => void): Request<RDS.Types.DeleteDBProxyResponse, AWSError>;
/**
* Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
*/
deleteDBSecurityGroup(params: RDS.Types.DeleteDBSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a DB security group. The specified DB security group must not be associated with any DB instances.
*/
deleteDBSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted.
*/
deleteDBSnapshot(params: RDS.Types.DeleteDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
/**
* Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. The DB snapshot must be in the available state to be deleted.
*/
deleteDBSnapshot(callback?: (err: AWSError, data: RDS.Types.DeleteDBSnapshotResult) => void): Request<RDS.Types.DeleteDBSnapshotResult, AWSError>;
/**
* Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
*/
deleteDBSubnetGroup(params: RDS.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.
*/
deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an RDS event notification subscription.
*/
deleteEventSubscription(params: RDS.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
/**
* Deletes an RDS event notification subscription.
*/
deleteEventSubscription(callback?: (err: AWSError, data: RDS.Types.DeleteEventSubscriptionResult) => void): Request<RDS.Types.DeleteEventSubscriptionResult, AWSError>;
/**
* Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters.
*/
deleteGlobalCluster(params: RDS.Types.DeleteGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request<RDS.Types.DeleteGlobalClusterResult, AWSError>;
/**
* Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters.
*/
deleteGlobalCluster(callback?: (err: AWSError, data: RDS.Types.DeleteGlobalClusterResult) => void): Request<RDS.Types.DeleteGlobalClusterResult, AWSError>;
/**
* Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
*/
deleteInstallationMedia(params: RDS.Types.DeleteInstallationMediaMessage, callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
/**
* Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
*/
deleteInstallationMedia(callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
/**
* Deletes an existing option group.
*/
deleteOptionGroup(params: RDS.Types.DeleteOptionGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing option group.
*/
deleteOptionGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
*/
deregisterDBProxyTargets(params: RDS.Types.DeregisterDBProxyTargetsRequest, callback?: (err: AWSError, data: RDS.Types.DeregisterDBProxyTargetsResponse) => void): Request<RDS.Types.DeregisterDBProxyTargetsResponse, AWSError>;
/**
* Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.
*/
deregisterDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.DeregisterDBProxyTargetsResponse) => void): Request<RDS.Types.DeregisterDBProxyTargetsResponse, AWSError>;
/**
* Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any parameters.
*/
describeAccountAttributes(params: RDS.Types.DescribeAccountAttributesMessage, callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
/**
* Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any parameters.
*/
describeAccountAttributes(callback?: (err: AWSError, data: RDS.Types.AccountAttributesMessage) => void): Request<RDS.Types.AccountAttributesMessage, AWSError>;
/**
* Lists the set of CA certificates provided by Amazon RDS for this AWS account.
*/
describeCertificates(params: RDS.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
/**
* Lists the set of CA certificates provided by Amazon RDS for this AWS account.
*/
describeCertificates(callback?: (err: AWSError, data: RDS.Types.CertificateMessage) => void): Request<RDS.Types.CertificateMessage, AWSError>;
/**
* Returns information about custom Availability Zones (AZs). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
describeCustomAvailabilityZones(params: RDS.Types.DescribeCustomAvailabilityZonesMessage, callback?: (err: AWSError, data: RDS.Types.CustomAvailabilityZoneMessage) => void): Request<RDS.Types.CustomAvailabilityZoneMessage, AWSError>;
/**
* Returns information about custom Availability Zones (AZs). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
describeCustomAvailabilityZones(callback?: (err: AWSError, data: RDS.Types.CustomAvailabilityZoneMessage) => void): Request<RDS.Types.CustomAvailabilityZoneMessage, AWSError>;
/**
* Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters.
*/
describeDBClusterBacktracks(params: RDS.Types.DescribeDBClusterBacktracksMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
/**
* Returns information about backtracks for a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora MySQL DB clusters.
*/
describeDBClusterBacktracks(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrackMessage) => void): Request<RDS.Types.DBClusterBacktrackMessage, AWSError>;
/**
* Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
describeDBClusterEndpoints(params: RDS.Types.DescribeDBClusterEndpointsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
/**
* Returns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
describeDBClusterEndpoints(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpointMessage) => void): Request<RDS.Types.DBClusterEndpointMessage, AWSError>;
/**
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeDBClusterParameterGroups(params: RDS.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
/**
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeDBClusterParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupsMessage) => void): Request<RDS.Types.DBClusterParameterGroupsMessage, AWSError>;
/**
* Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeDBClusterParameters(params: RDS.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
/**
* Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeDBClusterParameters(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupDetails) => void): Request<RDS.Types.DBClusterParameterGroupDetails, AWSError>;
/**
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. This action only applies to Aurora DB clusters.
*/
describeDBClusterSnapshotAttributes(params: RDS.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
/**
* Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action. This action only applies to Aurora DB clusters.
*/
describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
/**
* Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeDBClusterSnapshots(params: RDS.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeDBClusterSnapshots(callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*/
describeDBClusters(params: RDS.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
/**
* Returns information about provisioned Aurora DB clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*/
describeDBClusters(callback?: (err: AWSError, data: RDS.Types.DBClusterMessage) => void): Request<RDS.Types.DBClusterMessage, AWSError>;
/**
* Returns a list of the available DB engines.
*/
describeDBEngineVersions(params: RDS.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
/**
* Returns a list of the available DB engines.
*/
describeDBEngineVersions(callback?: (err: AWSError, data: RDS.Types.DBEngineVersionMessage) => void): Request<RDS.Types.DBEngineVersionMessage, AWSError>;
/**
* Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional.
*/
describeDBInstanceAutomatedBackups(params: RDS.Types.DescribeDBInstanceAutomatedBackupsMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
/**
* Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations. All parameters are optional.
*/
describeDBInstanceAutomatedBackups(callback?: (err: AWSError, data: RDS.Types.DBInstanceAutomatedBackupMessage) => void): Request<RDS.Types.DBInstanceAutomatedBackupMessage, AWSError>;
/**
* Returns information about provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*/
describeDBInstances(params: RDS.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
/**
* Returns information about provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
*/
describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
/**
* Returns a list of DB log files for the DB instance.
*/
describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
/**
* Returns a list of DB log files for the DB instance.
*/
describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
/**
* Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
*/
describeDBParameterGroups(params: RDS.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
/**
* Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
*/
describeDBParameterGroups(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupsMessage) => void): Request<RDS.Types.DBParameterGroupsMessage, AWSError>;
/**
* Returns the detailed parameter list for a particular DB parameter group.
*/
describeDBParameters(params: RDS.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
/**
* Returns the detailed parameter list for a particular DB parameter group.
*/
describeDBParameters(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupDetails) => void): Request<RDS.Types.DBParameterGroupDetails, AWSError>;
/**
* Returns information about DB proxies.
*/
describeDBProxies(params: RDS.Types.DescribeDBProxiesRequest, callback?: (err: AWSError, data: RDS.Types.DescribeDBProxiesResponse) => void): Request<RDS.Types.DescribeDBProxiesResponse, AWSError>;
/**
* Returns information about DB proxies.
*/
describeDBProxies(callback?: (err: AWSError, data: RDS.Types.DescribeDBProxiesResponse) => void): Request<RDS.Types.DescribeDBProxiesResponse, AWSError>;
/**
* Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
*/
describeDBProxyTargetGroups(params: RDS.Types.DescribeDBProxyTargetGroupsRequest, callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetGroupsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetGroupsResponse, AWSError>;
/**
* Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
*/
describeDBProxyTargetGroups(callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetGroupsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetGroupsResponse, AWSError>;
/**
* Returns information about DBProxyTarget objects. This API supports pagination.
*/
describeDBProxyTargets(params: RDS.Types.DescribeDBProxyTargetsRequest, callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetsResponse, AWSError>;
/**
* Returns information about DBProxyTarget objects. This API supports pagination.
*/
describeDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.DescribeDBProxyTargetsResponse) => void): Request<RDS.Types.DescribeDBProxyTargetsResponse, AWSError>;
/**
* Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
*/
describeDBSecurityGroups(params: RDS.Types.DescribeDBSecurityGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
/**
* Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
*/
describeDBSecurityGroups(callback?: (err: AWSError, data: RDS.Types.DBSecurityGroupMessage) => void): Request<RDS.Types.DBSecurityGroupMessage, AWSError>;
/**
* Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
*/
describeDBSnapshotAttributes(params: RDS.Types.DescribeDBSnapshotAttributesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
/**
* Returns a list of DB snapshot attribute names and values for a manual DB snapshot. When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts. To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
*/
describeDBSnapshotAttributes(callback?: (err: AWSError, data: RDS.Types.DescribeDBSnapshotAttributesResult) => void): Request<RDS.Types.DescribeDBSnapshotAttributesResult, AWSError>;
/**
* Returns information about DB snapshots. This API action supports pagination.
*/
describeDBSnapshots(params: RDS.Types.DescribeDBSnapshotsMessage, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
/**
* Returns information about DB snapshots. This API action supports pagination.
*/
describeDBSnapshots(callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
/**
* Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
*/
describeDBSubnetGroups(params: RDS.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
/**
* Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial.
*/
describeDBSubnetGroups(callback?: (err: AWSError, data: RDS.Types.DBSubnetGroupMessage) => void): Request<RDS.Types.DBSubnetGroupMessage, AWSError>;
/**
* Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
*/
describeEngineDefaultClusterParameters(params: RDS.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
*/
describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the specified database engine.
*/
describeEngineDefaultParameters(params: RDS.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the specified database engine.
*/
describeEngineDefaultParameters(callback?: (err: AWSError, data: RDS.Types.DescribeEngineDefaultParametersResult) => void): Request<RDS.Types.DescribeEngineDefaultParametersResult, AWSError>;
/**
* Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Events in the Amazon RDS User Guide.
*/
describeEventCategories(params: RDS.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
/**
* Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Events in the Amazon RDS User Guide.
*/
describeEventCategories(callback?: (err: AWSError, data: RDS.Types.EventCategoriesMessage) => void): Request<RDS.Types.EventCategoriesMessage, AWSError>;
/**
* Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription.
*/
describeEventSubscriptions(params: RDS.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
/**
* Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription.
*/
describeEventSubscriptions(callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
/**
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
*/
describeEvents(params: RDS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
/**
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots for the past 14 days. Events specific to a particular DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, and DB cluster snapshots group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
*/
describeEvents(callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
/**
* Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
*/
describeExportTasks(params: RDS.Types.DescribeExportTasksMessage, callback?: (err: AWSError, data: RDS.Types.ExportTasksMessage) => void): Request<RDS.Types.ExportTasksMessage, AWSError>;
/**
* Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
*/
describeExportTasks(callback?: (err: AWSError, data: RDS.Types.ExportTasksMessage) => void): Request<RDS.Types.ExportTasksMessage, AWSError>;
/**
* Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeGlobalClusters(params: RDS.Types.DescribeGlobalClustersMessage, callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
/**
* Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
describeGlobalClusters(callback?: (err: AWSError, data: RDS.Types.GlobalClustersMessage) => void): Request<RDS.Types.GlobalClustersMessage, AWSError>;
/**
* Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
*/
describeInstallationMedia(params: RDS.Types.DescribeInstallationMediaMessage, callback?: (err: AWSError, data: RDS.Types.InstallationMediaMessage) => void): Request<RDS.Types.InstallationMediaMessage, AWSError>;
/**
* Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
*/
describeInstallationMedia(callback?: (err: AWSError, data: RDS.Types.InstallationMediaMessage) => void): Request<RDS.Types.InstallationMediaMessage, AWSError>;
/**
* Describes all available options.
*/
describeOptionGroupOptions(params: RDS.Types.DescribeOptionGroupOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
/**
* Describes all available options.
*/
describeOptionGroupOptions(callback?: (err: AWSError, data: RDS.Types.OptionGroupOptionsMessage) => void): Request<RDS.Types.OptionGroupOptionsMessage, AWSError>;
/**
* Describes the available option groups.
*/
describeOptionGroups(params: RDS.Types.DescribeOptionGroupsMessage, callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
/**
* Describes the available option groups.
*/
describeOptionGroups(callback?: (err: AWSError, data: RDS.Types.OptionGroups) => void): Request<RDS.Types.OptionGroups, AWSError>;
/**
* Returns a list of orderable DB instance options for the specified engine.
*/
describeOrderableDBInstanceOptions(params: RDS.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
/**
* Returns a list of orderable DB instance options for the specified engine.
*/
describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: RDS.Types.OrderableDBInstanceOptionsMessage) => void): Request<RDS.Types.OrderableDBInstanceOptionsMessage, AWSError>;
/**
* Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
*/
describePendingMaintenanceActions(params: RDS.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
/**
* Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
*/
describePendingMaintenanceActions(callback?: (err: AWSError, data: RDS.Types.PendingMaintenanceActionsMessage) => void): Request<RDS.Types.PendingMaintenanceActionsMessage, AWSError>;
/**
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*/
describeReservedDBInstances(params: RDS.Types.DescribeReservedDBInstancesMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
/**
* Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
*/
describeReservedDBInstances(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstanceMessage) => void): Request<RDS.Types.ReservedDBInstanceMessage, AWSError>;
/**
* Lists available reserved DB instance offerings.
*/
describeReservedDBInstancesOfferings(params: RDS.Types.DescribeReservedDBInstancesOfferingsMessage, callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
/**
* Lists available reserved DB instance offerings.
*/
describeReservedDBInstancesOfferings(callback?: (err: AWSError, data: RDS.Types.ReservedDBInstancesOfferingMessage) => void): Request<RDS.Types.ReservedDBInstancesOfferingMessage, AWSError>;
/**
* Returns a list of the source AWS Regions where the current AWS Region can create a read replica or copy a DB snapshot from. This API action supports pagination.
*/
describeSourceRegions(params: RDS.Types.DescribeSourceRegionsMessage, callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
/**
* Returns a list of the source AWS Regions where the current AWS Region can create a read replica or copy a DB snapshot from. This API action supports pagination.
*/
describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
/**
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
*/
describeValidDBInstanceModifications(params: RDS.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
/**
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
*/
describeValidDBInstanceModifications(callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
/**
* Downloads all or a portion of the specified log file, up to 1 MB in size.
*/
downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
/**
* Downloads all or a portion of the specified log file, up to 1 MB in size.
*/
downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
/**
* Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
/**
* Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
/**
* Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
*/
importInstallationMedia(params: RDS.Types.ImportInstallationMediaMessage, callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
/**
* Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
*/
importInstallationMedia(callback?: (err: AWSError, data: RDS.Types.InstallationMedia) => void): Request<RDS.Types.InstallationMedia, AWSError>;
/**
* Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
*/
listTagsForResource(params: RDS.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
/**
* Lists all tags on an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
*/
listTagsForResource(callback?: (err: AWSError, data: RDS.Types.TagListMessage) => void): Request<RDS.Types.TagListMessage, AWSError>;
/**
* Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, or remove the override. By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS. You might need to override the default certificate in the following situations: You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region. RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes. For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*/
modifyCertificates(params: RDS.Types.ModifyCertificatesMessage, callback?: (err: AWSError, data: RDS.Types.ModifyCertificatesResult) => void): Request<RDS.Types.ModifyCertificatesResult, AWSError>;
/**
* Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, or remove the override. By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS. You might need to override the default certificate in the following situations: You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region. RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes. For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*/
modifyCertificates(callback?: (err: AWSError, data: RDS.Types.ModifyCertificatesResult) => void): Request<RDS.Types.ModifyCertificatesResult, AWSError>;
/**
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
modifyCurrentDBClusterCapacity(params: RDS.Types.ModifyCurrentDBClusterCapacityMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
/**
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
modifyCurrentDBClusterCapacity(callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
/**
* Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
modifyDBCluster(params: RDS.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
/**
* Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
modifyDBCluster(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterResult) => void): Request<RDS.Types.ModifyDBClusterResult, AWSError>;
/**
* Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
modifyDBClusterEndpoint(params: RDS.Types.ModifyDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
/**
* Modifies the properties of an endpoint in an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.
*/
modifyDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
/**
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. This action only applies to Aurora DB clusters.
*/
modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. This action only applies to Aurora DB clusters.
*/
modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute. This action only applies to Aurora DB clusters.
*/
modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
/**
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API action. The accounts are returned as values for the restore attribute. This action only applies to Aurora DB clusters.
*/
modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
/**
* Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
*/
modifyDBInstance(params: RDS.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
/**
* Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
*/
modifyDBInstance(callback?: (err: AWSError, data: RDS.Types.ModifyDBInstanceResult) => void): Request<RDS.Types.ModifyDBInstanceResult, AWSError>;
/**
* Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
modifyDBParameterGroup(params: RDS.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
modifyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
/**
* Changes the settings for an existing DB proxy.
*/
modifyDBProxy(params: RDS.Types.ModifyDBProxyRequest, callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyResponse) => void): Request<RDS.Types.ModifyDBProxyResponse, AWSError>;
/**
* Changes the settings for an existing DB proxy.
*/
modifyDBProxy(callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyResponse) => void): Request<RDS.Types.ModifyDBProxyResponse, AWSError>;
/**
* Modifies the properties of a DBProxyTargetGroup.
*/
modifyDBProxyTargetGroup(params: RDS.Types.ModifyDBProxyTargetGroupRequest, callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyTargetGroupResponse) => void): Request<RDS.Types.ModifyDBProxyTargetGroupResponse, AWSError>;
/**
* Modifies the properties of a DBProxyTargetGroup.
*/
modifyDBProxyTargetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyTargetGroupResponse) => void): Request<RDS.Types.ModifyDBProxyTargetGroupResponse, AWSError>;
/**
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.
*/
modifyDBSnapshot(params: RDS.Types.ModifyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
/**
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.
*/
modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
/**
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore attribute.
*/
modifyDBSnapshotAttribute(params: RDS.Types.ModifyDBSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
/**
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore attribute.
*/
modifyDBSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
/**
* Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
*/
modifyDBSubnetGroup(params: RDS.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
/**
* Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
*/
modifyDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBSubnetGroupResult) => void): Request<RDS.Types.ModifyDBSubnetGroupResult, AWSError>;
/**
* Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
*/
modifyEventSubscription(params: RDS.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
/**
* Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls. You can see a list of the event categories for a given source type (SourceType) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
*/
modifyEventSubscription(callback?: (err: AWSError, data: RDS.Types.ModifyEventSubscriptionResult) => void): Request<RDS.Types.ModifyEventSubscriptionResult, AWSError>;
/**
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
modifyGlobalCluster(params: RDS.Types.ModifyGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
/**
* Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
modifyGlobalCluster(callback?: (err: AWSError, data: RDS.Types.ModifyGlobalClusterResult) => void): Request<RDS.Types.ModifyGlobalClusterResult, AWSError>;
/**
* Modifies an existing option group.
*/
modifyOptionGroup(params: RDS.Types.ModifyOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
/**
* Modifies an existing option group.
*/
modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
/**
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
*/
promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
/**
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
*/
promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
/**
* Promotes a read replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.
*/
promoteReadReplicaDBCluster(params: RDS.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
/**
* Promotes a read replica DB cluster to a standalone DB cluster. This action only applies to Aurora DB clusters.
*/
promoteReadReplicaDBCluster(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaDBClusterResult) => void): Request<RDS.Types.PromoteReadReplicaDBClusterResult, AWSError>;
/**
* Purchases a reserved DB instance offering.
*/
purchaseReservedDBInstancesOffering(params: RDS.Types.PurchaseReservedDBInstancesOfferingMessage, callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
/**
* Purchases a reserved DB instance offering.
*/
purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
/**
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
*/
rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
/**
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
*/
rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
/**
* Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
*/
registerDBProxyTargets(params: RDS.Types.RegisterDBProxyTargetsRequest, callback?: (err: AWSError, data: RDS.Types.RegisterDBProxyTargetsResponse) => void): Request<RDS.Types.RegisterDBProxyTargetsResponse, AWSError>;
/**
* Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.
*/
registerDBProxyTargets(callback?: (err: AWSError, data: RDS.Types.RegisterDBProxyTargetsResponse) => void): Request<RDS.Types.RegisterDBProxyTargetsResponse, AWSError>;
/**
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region. This action only applies to Aurora DB clusters.
*/
removeFromGlobalCluster(params: RDS.Types.RemoveFromGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
/**
* Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region. This action only applies to Aurora DB clusters.
*/
removeFromGlobalCluster(callback?: (err: AWSError, data: RDS.Types.RemoveFromGlobalClusterResult) => void): Request<RDS.Types.RemoveFromGlobalClusterResult, AWSError>;
/**
* Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
removeRoleFromDBCluster(params: RDS.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
*/
removeRoleFromDBInstance(params: RDS.Types.RemoveRoleFromDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
*/
removeRoleFromDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a source identifier from an existing RDS event notification subscription.
*/
removeSourceIdentifierFromSubscription(params: RDS.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
/**
* Removes a source identifier from an existing RDS event notification subscription.
*/
removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: RDS.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<RDS.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
/**
* Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
*/
removeTagsFromResource(params: RDS.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes metadata tags from an Amazon RDS resource. For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
*/
removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
resetDBClusterParameterGroup(params: RDS.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
resetDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
*/
resetDBParameterGroup(params: RDS.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
*/
resetDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBParameterGroupNameMessage) => void): Request<RDS.Types.DBParameterGroupNameMessage, AWSError>;
/**
* Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
*/
restoreDBClusterFromS3(params: RDS.Types.RestoreDBClusterFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
/**
* Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
*/
restoreDBClusterFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromS3Result) => void): Request<RDS.Types.RestoreDBClusterFromS3Result, AWSError>;
/**
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
restoreDBClusterFromSnapshot(params: RDS.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
/**
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterFromSnapshotResult) => void): Request<RDS.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
/**
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
restoreDBClusterToPointInTime(params: RDS.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
/**
* Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
/**
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
*/
restoreDBInstanceFromDBSnapshot(params: RDS.Types.RestoreDBInstanceFromDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
/**
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment. If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
*/
restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
/**
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
*/
restoreDBInstanceFromS3(params: RDS.Types.RestoreDBInstanceFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
/**
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
*/
restoreDBInstanceFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
/**
* Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
*/
restoreDBInstanceToPointInTime(params: RDS.Types.RestoreDBInstanceToPointInTimeMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
/**
* Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property. The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
*/
restoreDBInstanceToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceToPointInTimeResult) => void): Request<RDS.Types.RestoreDBInstanceToPointInTimeResult, AWSError>;
/**
* Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
*/
revokeDBSecurityGroupIngress(params: RDS.Types.RevokeDBSecurityGroupIngressMessage, callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
/**
* Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
*/
revokeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.RevokeDBSecurityGroupIngressResult) => void): Request<RDS.Types.RevokeDBSecurityGroupIngressResult, AWSError>;
/**
* Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
*/
startActivityStream(params: RDS.Types.StartActivityStreamRequest, callback?: (err: AWSError, data: RDS.Types.StartActivityStreamResponse) => void): Request<RDS.Types.StartActivityStreamResponse, AWSError>;
/**
* Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
*/
startActivityStream(callback?: (err: AWSError, data: RDS.Types.StartActivityStreamResponse) => void): Request<RDS.Types.StartActivityStreamResponse, AWSError>;
/**
* Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
startDBCluster(params: RDS.Types.StartDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
/**
* Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
startDBCluster(callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
/**
* Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
*/
startDBInstance(params: RDS.Types.StartDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
/**
* Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
*/
startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
/**
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
*/
startExportTask(params: RDS.Types.StartExportTaskMessage, callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
/**
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
*/
startExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
/**
* Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
*/
stopActivityStream(params: RDS.Types.StopActivityStreamRequest, callback?: (err: AWSError, data: RDS.Types.StopActivityStreamResponse) => void): Request<RDS.Types.StopActivityStreamResponse, AWSError>;
/**
* Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action. For more information, see Database Activity Streams in the Amazon Aurora User Guide.
*/
stopActivityStream(callback?: (err: AWSError, data: RDS.Types.StopActivityStreamResponse) => void): Request<RDS.Types.StopActivityStreamResponse, AWSError>;
/**
* Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
stopDBCluster(params: RDS.Types.StopDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
/**
* Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
*/
stopDBCluster(callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
/**
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
*/
stopDBInstance(params: RDS.Types.StopDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
/**
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
*/
stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
/**
* Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceAvailable", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceDeleted", params: RDS.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceDeleted state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBSnapshotAvailable", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
/**
* Waits for the dBSnapshotAvailable state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBSnapshotAvailable", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
/**
* Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBSnapshotDeleted", params: RDS.Types.DescribeDBSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
/**
* Waits for the dBSnapshotDeleted state by periodically calling the underlying RDS.describeDBSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBSnapshotDeleted", callback?: (err: AWSError, data: RDS.Types.DBSnapshotMessage) => void): Request<RDS.Types.DBSnapshotMessage, AWSError>;
/**
* Waits for the dBClusterSnapshotAvailable state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBClusterSnapshotAvailable", params: RDS.Types.DescribeDBClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Waits for the dBClusterSnapshotAvailable state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBClusterSnapshotAvailable", callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Waits for the dBClusterSnapshotDeleted state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBClusterSnapshotDeleted", params: RDS.Types.DescribeDBClusterSnapshotsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Waits for the dBClusterSnapshotDeleted state by periodically calling the underlying RDS.describeDBClusterSnapshotsoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBClusterSnapshotDeleted", callback?: (err: AWSError, data: RDS.Types.DBClusterSnapshotMessage) => void): Request<RDS.Types.DBClusterSnapshotMessage, AWSError>;
}
declare namespace RDS {
export import Signer = signer;
}
declare namespace RDS {
export interface AccountAttributesMessage {
/**
* A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
*/
AccountQuotas?: AccountQuotaList;
}
export interface AccountQuota {
/**
* The name of the Amazon RDS quota for this AWS account.
*/
AccountQuotaName?: String;
/**
* The amount currently used toward the quota maximum.
*/
Used?: Long;
/**
* The maximum allowed value for the quota.
*/
Max?: Long;
}
export type AccountQuotaList = AccountQuota[];
export type ActivityStreamMode = "sync"|"async"|string;
export type ActivityStreamStatus = "stopped"|"starting"|"started"|"stopping"|string;
export interface AddRoleToDBClusterMessage {
/**
* The name of the DB cluster to associate the IAM role with.
*/
DBClusterIdentifier: String;
/**
* The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
*/
RoleArn: String;
/**
* The name of the feature for the DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.
*/
FeatureName?: String;
}
export interface AddRoleToDBInstanceMessage {
/**
* The name of the DB instance to associate the IAM role with.
*/
DBInstanceIdentifier: String;
/**
* The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
*/
RoleArn: String;
/**
* The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.
*/
FeatureName: String;
}
export interface AddSourceIdentifierToSubscriptionMessage {
/**
* The name of the RDS event notification subscription you want to add a source identifier to.
*/
SubscriptionName: String;
/**
* The identifier of the event source to be added. Constraints: If the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGroupName value must be supplied. If the source type is a DB security group, a DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
*/
SourceIdentifier: String;
}
export interface AddSourceIdentifierToSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface AddTagsToResourceMessage {
/**
* The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
*/
ResourceName: String;
/**
* The tags to be assigned to the Amazon RDS resource.
*/
Tags: TagList;
}
export type ApplyMethod = "immediate"|"pending-reboot"|string;
export interface ApplyPendingMaintenanceActionMessage {
/**
* The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
*/
ResourceIdentifier: String;
/**
* The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade, hardware-maintenance, ca-certificate-rotation
*/
ApplyAction: String;
/**
* A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone. Valid values: immediate - Apply the maintenance action immediately. next-maintenance - Apply the maintenance action during the next maintenance window for the resource. undo-opt-in - Cancel any existing next-maintenance opt-in requests.
*/
OptInType: String;
}
export interface ApplyPendingMaintenanceActionResult {
ResourcePendingMaintenanceActions?: ResourcePendingMaintenanceActions;
}
export type AttributeValueList = String[];
export type AuthScheme = "SECRETS"|string;
export interface AuthorizeDBSecurityGroupIngressMessage {
/**
* The name of the DB security group to add authorization to.
*/
DBSecurityGroupName: String;
/**
* The IP range to authorize.
*/
CIDRIP?: String;
/**
* Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
*/
EC2SecurityGroupName?: String;
/**
* Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
*/
EC2SecurityGroupId?: String;
/**
* AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
*/
EC2SecurityGroupOwnerId?: String;
}
export interface AuthorizeDBSecurityGroupIngressResult {
DBSecurityGroup?: DBSecurityGroup;
}
export interface AvailabilityZone {
/**
* The name of the Availability Zone.
*/
Name?: String;
}
export type AvailabilityZoneList = AvailabilityZone[];
export type AvailabilityZones = String[];
export interface AvailableProcessorFeature {
/**
* The name of the processor feature. Valid names are coreCount and threadsPerCore.
*/
Name?: String;
/**
* The default value for the processor feature of the DB instance class.
*/
DefaultValue?: String;
/**
* The allowed values for the processor feature of the DB instance class.
*/
AllowedValues?: String;
}
export type AvailableProcessorFeatureList = AvailableProcessorFeature[];
export interface BacktrackDBClusterMessage {
/**
* The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
*/
DBClusterIdentifier: String;
/**
* The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page. If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster. Constraints: Must contain a valid ISO 8601 timestamp. Can't contain a timestamp set in the future. Example: 2017-07-08T18:00Z
*/
BacktrackTo: TStamp;
/**
* A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
*/
Force?: BooleanOptional;
/**
* A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.
*/
UseEarliestTimeOnPointInTimeUnavailable?: BooleanOptional;
}
export type Boolean = boolean;
export type BooleanOptional = boolean;
export interface CancelExportTaskMessage {
/**
* The identifier of the snapshot export task to cancel.
*/
ExportTaskIdentifier: String;
}
export interface Certificate {
/**
* The unique key that identifies a certificate.
*/
CertificateIdentifier?: String;
/**
* The type of the certificate.
*/
CertificateType?: String;
/**
* The thumbprint of the certificate.
*/
Thumbprint?: String;
/**
* The starting date from which the certificate is valid.
*/
ValidFrom?: TStamp;
/**
* The final date that the certificate continues to be valid.
*/
ValidTill?: TStamp;
/**
* The Amazon Resource Name (ARN) for the certificate.
*/
CertificateArn?: String;
/**
* Whether there is an override for the default certificate identifier.
*/
CustomerOverride?: BooleanOptional;
/**
* If there is an override for the default certificate identifier, when the override expires.
*/
CustomerOverrideValidTill?: TStamp;
}
export type CertificateList = Certificate[];
export interface CertificateMessage {
/**
* The list of Certificate objects for the AWS account.
*/
Certificates?: CertificateList;
/**
* An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
}
export interface CharacterSet {
/**
* The name of the character set.
*/
CharacterSetName?: String;
/**
* The description of the character set.
*/
CharacterSetDescription?: String;
}
export interface CloudwatchLogsExportConfiguration {
/**
* The list of log types to enable.
*/
EnableLogTypes?: LogTypeList;
/**
* The list of log types to disable.
*/
DisableLogTypes?: LogTypeList;
}
export interface ConnectionPoolConfiguration {
/**
* The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. Default: 100 Constraints: between 1 and 100
*/
MaxConnectionsPercent?: IntegerOptional;
/**
* Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. Default: 50 Constraints: between 0 and MaxConnectionsPercent
*/
MaxIdleConnectionsPercent?: IntegerOptional;
/**
* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. Default: 120 Constraints: between 1 and 3600, or 0 representing unlimited
*/
ConnectionBorrowTimeout?: IntegerOptional;
/**
* Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Default: no session pinning filters
*/
SessionPinningFilters?: StringList;
/**
* One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2. Default: no initialization query
*/
InitQuery?: String;
}
export interface ConnectionPoolConfigurationInfo {
/**
* The maximum size of the connection pool for each target in a target group. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
*/
MaxConnectionsPercent?: Integer;
/**
* Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
*/
MaxIdleConnectionsPercent?: Integer;
/**
* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
*/
ConnectionBorrowTimeout?: Integer;
/**
* Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
*/
SessionPinningFilters?: StringList;
/**
* One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
*/
InitQuery?: String;
}
export interface CopyDBClusterParameterGroupMessage {
/**
* The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide. Constraints: Must specify a valid DB cluster parameter group. If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN. If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
*/
SourceDBClusterParameterGroupIdentifier: String;
/**
* The identifier for the copied DB cluster parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1
*/
TargetDBClusterParameterGroupIdentifier: String;
/**
* A description for the copied DB cluster parameter group.
*/
TargetDBClusterParameterGroupDescription: String;
Tags?: TagList;
}
export interface CopyDBClusterParameterGroupResult {
DBClusterParameterGroup?: DBClusterParameterGroup;
}
export interface CopyDBClusterSnapshotMessage {
/**
* The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive. You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another. Constraints: Must specify a valid system snapshot in the "available" state. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide. Example: my-cluster-snapshot1
*/
SourceDBClusterSnapshotIdentifier: String;
/**
* The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2
*/
TargetDBClusterSnapshotIdentifier: String;
/**
* The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
*/
KmsKeyId?: String;
/**
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
*/
PreSignedUrl?: String;
/**
* A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.
*/
CopyTags?: BooleanOptional;
Tags?: TagList;
/**
* The ID of the region that contains the snapshot to be copied.
*/
SourceRegion?: String;
}
export interface CopyDBClusterSnapshotResult {
DBClusterSnapshot?: DBClusterSnapshot;
}
export interface CopyDBParameterGroupMessage {
/**
* The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. Constraints: Must specify a valid DB parameter group. Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
*/
SourceDBParameterGroupIdentifier: String;
/**
* The identifier for the copied DB parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-db-parameter-group
*/
TargetDBParameterGroupIdentifier: String;
/**
* A description for the copied DB parameter group.
*/
TargetDBParameterGroupDescription: String;
Tags?: TagList;
}
export interface CopyDBParameterGroupResult {
DBParameterGroup?: DBParameterGroup;
}
export interface CopyDBSnapshotMessage {
/**
* The identifier for the source DB snapshot. If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805. If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter. Constraints: Must specify a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
*/
SourceDBSnapshotIdentifier: String;
/**
* The identifier for the copy of the snapshot. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-db-snapshot
*/
TargetDBSnapshotIdentifier: String;
/**
* The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
*/
KmsKeyId?: String;
Tags?: TagList;
/**
* A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.
*/
CopyTags?: BooleanOptional;
/**
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
*/
PreSignedUrl?: String;
/**
* The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.
*/
OptionGroupName?: String;
/**
* The ID of the region that contains the snapshot to be copied.
*/
SourceRegion?: String;
}
export interface CopyDBSnapshotResult {
DBSnapshot?: DBSnapshot;
}
export interface CopyOptionGroupMessage {
/**
* The identifier for the source option group. Constraints: Must specify a valid option group.
*/
SourceOptionGroupIdentifier: String;
/**
* The identifier for the copied option group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-option-group
*/
TargetOptionGroupIdentifier: String;
/**
* The description for the copied option group.
*/
TargetOptionGroupDescription: String;
Tags?: TagList;
}
export interface CopyOptionGroupResult {
OptionGroup?: OptionGroup;
}
export interface CreateCustomAvailabilityZoneMessage {
/**
* The name of the custom Availability Zone (AZ).
*/
CustomAvailabilityZoneName: String;
/**
* The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.
*/
ExistingVpnId?: String;
/**
* The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster. Specify this parameter only if ExistingVpnId isn't specified.
*/
NewVpnTunnelName?: String;
/**
* The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic. Specify this parameter only if ExistingVpnId isn't specified.
*/
VpnTunnelOriginatorIP?: String;
}
export interface CreateCustomAvailabilityZoneResult {
CustomAvailabilityZone?: CustomAvailabilityZone;
}
export interface CreateDBClusterEndpointMessage {
/**
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
*/
DBClusterIdentifier: String;
/**
* The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
*/
DBClusterEndpointIdentifier: String;
/**
* The type of the endpoint. One of: READER, WRITER, ANY.
*/
EndpointType: String;
/**
* List of DB instance identifiers that are part of the custom endpoint group.
*/
StaticMembers?: StringList;
/**
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
*/
ExcludedMembers?: StringList;
/**
* The tags to be assigned to the Amazon RDS resource.
*/
Tags?: TagList;
}
export interface CreateDBClusterMessage {
/**
* A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The number of days for which automated backups are retained. Default: 1 Constraints: Must be a value from 1 to 35
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* A value that indicates that the DB cluster should be associated with the specified CharacterSet.
*/
CharacterSetName?: String;
/**
* The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
*/
DatabaseName?: String;
/**
* The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
*/
DBClusterIdentifier: String;
/**
* The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group.
*/
DBClusterParameterGroupName?: String;
/**
* A list of EC2 VPC security groups to associate with this DB cluster.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
*/
Engine: String;
/**
* The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7
*/
EngineVersion?: String;
/**
* The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
*/
Port?: IntegerOptional;
/**
* The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
*/
MasterUsername?: String;
/**
* The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
*/
MasterUserPassword?: String;
/**
* A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
*/
OptionGroupName?: String;
/**
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
PreferredBackupWindow?: String;
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
*/
ReplicationSourceIdentifier?: String;
/**
* Tags to assign to the DB cluster.
*/
Tags?: TagList;
/**
* A value that indicates whether the DB cluster is encrypted.
*/
StorageEncrypted?: BooleanOptional;
/**
* The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key isn't specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key. If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the read replica in that AWS Region.
*/
KmsKeyId?: String;
/**
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that Aurora read replica will be created in. ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
*/
PreSignedUrl?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*/
BacktrackWindow?: LongOptional;
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Aurora MySQL Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible values are postgresql and upgrade.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless Limitations of Parallel Query Requirements for Aurora Global Databases Limitations of Multi-Master Clusters
*/
EngineMode?: String;
/**
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
*/
ScalingConfiguration?: ScalingConfiguration;
/**
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
DeletionProtection?: BooleanOptional;
/**
* The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
*/
GlobalClusterIdentifier?: String;
/**
* A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
*/
EnableHttpEndpoint?: BooleanOptional;
/**
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* The Active Directory directory ID to create the DB cluster in. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.
*/
EnableGlobalWriteForwarding?: BooleanOptional;
/**
* The ID of the region that contains the source for the read replica.
*/
SourceRegion?: String;
}
export interface CreateDBClusterParameterGroupMessage {
/**
* The name of the DB cluster parameter group. Constraints: Must match the name of an existing DB cluster parameter group. This value is stored as a lowercase string.
*/
DBClusterParameterGroupName: String;
/**
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora5.6, aurora-mysql5.7 Aurora PostgreSQL Example: aurora-postgresql9.6
*/
DBParameterGroupFamily: String;
/**
* The description for the DB cluster parameter group.
*/
Description: String;
/**
* Tags to assign to the DB cluster parameter group.
*/
Tags?: TagList;
}
export interface CreateDBClusterParameterGroupResult {
DBClusterParameterGroup?: DBClusterParameterGroup;
}
export interface CreateDBClusterResult {
DBCluster?: DBCluster;
}
export interface CreateDBClusterSnapshotMessage {
/**
* The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1-snapshot1
*/
DBClusterSnapshotIdentifier: String;
/**
* The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1
*/
DBClusterIdentifier: String;
/**
* The tags to be assigned to the DB cluster snapshot.
*/
Tags?: TagList;
}
export interface CreateDBClusterSnapshotResult {
DBClusterSnapshot?: DBClusterSnapshot;
}
export interface CreateDBInstanceMessage {
/**
* The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't be longer than 8 characters SQL Server Not applicable. Must be null. Amazon Aurora The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Can't be a word reserved by the specified database engine
*/
DBName?: String;
/**
* The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
*/
DBInstanceIdentifier: String;
/**
* The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
*/
AllocatedStorage?: IntegerOptional;
/**
* The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
*/
DBInstanceClass: String;
/**
* The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
*/
Engine: String;
/**
* The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. MariaDB Constraints: Required for MariaDB. Must be 1 to 16 letters or numbers. Can't be a reserved word for the chosen database engine. Microsoft SQL Server Constraints: Required for SQL Server. Must be 1 to 128 letters or numbers. The first character must be a letter. Can't be a reserved word for the chosen database engine. MySQL Constraints: Required for MySQL. Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. Oracle Constraints: Required for Oracle. Must be 1 to 30 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine. PostgreSQL Constraints: Required for PostgreSQL. Must be 1 to 63 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
*/
MasterUsername?: String;
/**
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters.
*/
MasterUserPassword?: String;
/**
* A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
*/
DBSecurityGroups?: DBSecurityGroupNameList;
/**
* A list of Amazon EC2 VPC security groups to associate with this DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint. If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in. For more information about RDS on VMware, see the RDS on VMware User Guide.
*/
AvailabilityZone?: String;
/**
* A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance.
*/
DBSubnetGroupName?: String;
/**
* The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window. Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
*/
DBParameterGroupName?: String;
/**
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to read replicas
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
PreferredBackupWindow?: String;
/**
* The port number on which the database accepts connections. MySQL Default: 3306 Valid values: 1150-65535 Type: Integer MariaDB Default: 3306 Valid values: 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535 Type: Integer
*/
Port?: IntegerOptional;
/**
* A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
*/
MultiAZ?: BooleanOptional;
/**
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
*/
EngineVersion?: String;
/**
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
*/
LicenseModel?: String;
/**
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
*/
Iops?: IntegerOptional;
/**
* Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance
*/
OptionGroupName?: String;
/**
* For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
*/
CharacterSetName?: String;
/**
* The name of the NCHAR character set for the Oracle DB instance.
*/
NcharCharacterSetName?: String;
/**
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private. If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private. If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
*/
PubliclyAccessible?: BooleanOptional;
/**
* Tags to assign to the DB instance.
*/
Tags?: TagList;
/**
* The identifier of the DB cluster that the instance will belong to.
*/
DBClusterIdentifier?: String;
/**
* Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2
*/
StorageType?: String;
/**
* The ARN from the key store with which to associate the instance for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* The password for the given ARN from the key store in order to access the device.
*/
TdeCredentialPassword?: String;
/**
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.
*/
StorageEncrypted?: BooleanOptional;
/**
* The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
*/
Domain?: String;
/**
* A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
*/
MonitoringInterval?: IntegerOptional;
/**
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
*/
MonitoringRoleArn?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
*/
PromotionTier?: IntegerOptional;
/**
* The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
*/
Timezone?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. You can enable IAM database authentication for the following database engines: Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. MySQL For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher For MySQL 8.0, minor version 8.0.16 or higher PostgreSQL For PostgreSQL 9.5, minor version 9.5.15 or higher For PostgreSQL 9.6, minor version 9.6.11 or higher PostgreSQL 10.6, 10.7, and 10.9 For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
*/
EnablePerformanceInsights?: BooleanOptional;
/**
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
*/
PerformanceInsightsRetentionPeriod?: IntegerOptional;
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. MariaDB Possible values are audit, error, general, and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, listener, and trace. PostgreSQL Possible values are postgresql and upgrade.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
*/
DeletionProtection?: BooleanOptional;
/**
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
*/
MaxAllocatedStorage?: IntegerOptional;
}
export interface CreateDBInstanceReadReplicaMessage {
/**
* The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
*/
DBInstanceIdentifier: String;
/**
* The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance. Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide. Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. If the source DB instance is in the same AWS Region as the read replica, specify a valid DB instance identifier. If the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
*/
SourceDBInstanceIdentifier: String;
/**
* The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: Inherits from the source DB instance.
*/
DBInstanceClass?: String;
/**
* The Availability Zone (AZ) where the read replica will be created. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d
*/
AvailabilityZone?: String;
/**
* The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
*/
Port?: IntegerOptional;
/**
* A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
*/
MultiAZ?: BooleanOptional;
/**
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window. Default: Inherits from the source DB instance
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
*/
Iops?: IntegerOptional;
/**
* The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. For SQL Server, you must use the option group associated with the source instance.
*/
OptionGroupName?: String;
/**
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica. Currently, specifying a parameter group for this operation is only supported for Oracle DB instances. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
*/
DBParameterGroupName?: String;
/**
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
*/
PubliclyAccessible?: BooleanOptional;
Tags?: TagList;
/**
* Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC. Constraints: Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. If supplied, must match the name of an existing DBSubnetGroup. The specified DB subnet group must be in the same AWS Region in which the operation is running. All read replicas in one AWS Region that are created from the same source DB instance must either:> Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC. Not specify a DB subnet group. All these read replicas are created outside of any VPC. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* A list of EC2 VPC security groups to associate with the read replica. Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* Specifies the storage type to be associated with the read replica. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2
*/
StorageType?: String;
/**
* A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
*/
MonitoringInterval?: IntegerOptional;
/**
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
*/
MonitoringRoleArn?: String;
/**
* The AWS KMS key ID for an encrypted read replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you create an encrypted read replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The read replica is encrypted with the same KMS key as the source DB instance. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. You can't create an encrypted read replica from an unencrypted DB instance.
*/
KmsKeyId?: String;
/**
* The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted read replica from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same AWS Region. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted read replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the read replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source AWS Region. SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
*/
PreSignedUrl?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* A value that indicates whether to enable Performance Insights for the read replica. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
*/
EnablePerformanceInsights?: BooleanOptional;
/**
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
*/
PerformanceInsightsRetentionPeriod?: IntegerOptional;
/**
* The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
*/
UseDefaultProcessorFeatures?: BooleanOptional;
/**
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
*/
DeletionProtection?: BooleanOptional;
/**
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*/
ReplicaMode?: ReplicaMode;
/**
* The ID of the region that contains the source for the read replica.
*/
SourceRegion?: String;
}
export interface CreateDBInstanceReadReplicaResult {
DBInstance?: DBInstance;
}
export interface CreateDBInstanceResult {
DBInstance?: DBInstance;
}
export interface CreateDBParameterGroupMessage {
/**
* The name of the DB parameter group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
*/
DBParameterGroupName: String;
/**
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates.
*/
DBParameterGroupFamily: String;
/**
* The description for the DB parameter group.
*/
Description: String;
/**
* Tags to assign to the DB parameter group.
*/
Tags?: TagList;
}
export interface CreateDBParameterGroupResult {
DBParameterGroup?: DBParameterGroup;
}
export interface CreateDBProxyRequest {
/**
* The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*/
DBProxyName: String;
/**
* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
*/
EngineFamily: EngineFamily;
/**
* The authorization mechanism that the proxy uses.
*/
Auth: UserAuthConfigList;
/**
* The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*/
RoleArn: String;
/**
* One or more VPC subnet IDs to associate with the new proxy.
*/
VpcSubnetIds: StringList;
/**
* One or more VPC security group IDs to associate with the new proxy.
*/
VpcSecurityGroupIds?: StringList;
/**
* A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.
*/
RequireTLS?: Boolean;
/**
* The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
*/
IdleClientTimeout?: IntegerOptional;
/**
* Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*/
DebugLogging?: Boolean;
/**
* An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
*/
Tags?: TagList;
}
export interface CreateDBProxyResponse {
/**
* The DBProxy structure corresponding to the new proxy.
*/
DBProxy?: DBProxy;
}
export interface CreateDBSecurityGroupMessage {
/**
* The name for the DB security group. This value is stored as a lowercase string. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Must not be "Default" Example: mysecuritygroup
*/
DBSecurityGroupName: String;
/**
* The description for the DB security group.
*/
DBSecurityGroupDescription: String;
/**
* Tags to assign to the DB security group.
*/
Tags?: TagList;
}
export interface CreateDBSecurityGroupResult {
DBSecurityGroup?: DBSecurityGroup;
}
export interface CreateDBSnapshotMessage {
/**
* The identifier for the DB snapshot. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
*/
DBSnapshotIdentifier: String;
/**
* The identifier of the DB instance that you want to create the snapshot of. Constraints: Must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier: String;
Tags?: TagList;
}
export interface CreateDBSnapshotResult {
DBSnapshot?: DBSnapshot;
}
export interface CreateDBSubnetGroupMessage {
/**
* The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: mySubnetgroup
*/
DBSubnetGroupName: String;
/**
* The description for the DB subnet group.
*/
DBSubnetGroupDescription: String;
/**
* The EC2 Subnet IDs for the DB subnet group.
*/
SubnetIds: SubnetIdentifierList;
/**
* Tags to assign to the DB subnet group.
*/
Tags?: TagList;
}
export interface CreateDBSubnetGroupResult {
DBSubnetGroup?: DBSubnetGroup;
}
export interface CreateEventSubscriptionMessage {
/**
* The name of the subscription. Constraints: The name must be less than 255 characters.
*/
SubscriptionName: String;
/**
* The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
*/
SnsTopicArn: String;
/**
* The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance. If this value isn't specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
*/
SourceType?: String;
/**
* A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
*/
EventCategories?: EventCategoriesList;
/**
* The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens. Constraints: If a SourceIds value is supplied, SourceType must also be provided. If the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGroupName value must be supplied. If the source type is a DB security group, a DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
*/
SourceIds?: SourceIdsList;
/**
* A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
*/
Enabled?: BooleanOptional;
Tags?: TagList;
}
export interface CreateEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface CreateGlobalClusterMessage {
/**
* The cluster identifier of the new global database cluster.
*/
GlobalClusterIdentifier?: String;
/**
* The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.
*/
SourceDBClusterIdentifier?: String;
/**
* The name of the database engine to be used for this DB cluster.
*/
Engine?: String;
/**
* The engine version of the Aurora global database.
*/
EngineVersion?: String;
/**
* The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
*/
DeletionProtection?: BooleanOptional;
/**
* The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
*/
DatabaseName?: String;
/**
* The storage encryption setting for the new global database cluster.
*/
StorageEncrypted?: BooleanOptional;
}
export interface CreateGlobalClusterResult {
GlobalCluster?: GlobalCluster;
}
export interface CreateOptionGroupMessage {
/**
* Specifies the name of the option group to be created. Constraints: Must be 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: myoptiongroup
*/
OptionGroupName: String;
/**
* Specifies the name of the engine that this option group should be associated with.
*/
EngineName: String;
/**
* Specifies the major version of the engine that this option group should be associated with.
*/
MajorEngineVersion: String;
/**
* The description of the option group.
*/
OptionGroupDescription: String;
/**
* Tags to assign to the option group.
*/
Tags?: TagList;
}
export interface CreateOptionGroupResult {
OptionGroup?: OptionGroup;
}
export interface CustomAvailabilityZone {
/**
* The identifier of the custom AZ. Amazon RDS generates a unique identifier when a custom AZ is created.
*/
CustomAvailabilityZoneId?: String;
/**
* The name of the custom AZ.
*/
CustomAvailabilityZoneName?: String;
/**
* The status of the custom AZ.
*/
CustomAvailabilityZoneStatus?: String;
/**
* Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
*/
VpnDetails?: VpnDetails;
}
export type CustomAvailabilityZoneList = CustomAvailabilityZone[];
export interface CustomAvailabilityZoneMessage {
/**
* An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The list of CustomAvailabilityZone objects for the AWS account.
*/
CustomAvailabilityZones?: CustomAvailabilityZoneList;
}
export interface DBCluster {
/**
* For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
*/
AllocatedStorage?: IntegerOptional;
/**
* Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
*/
AvailabilityZones?: AvailabilityZones;
/**
* Specifies the number of days for which automatic DB snapshots are retained.
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* If present, specifies the name of the character set that this cluster is associated with.
*/
CharacterSetName?: String;
/**
* Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
*/
DatabaseName?: String;
/**
* Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
*/
DBClusterIdentifier?: String;
/**
* Specifies the name of the DB cluster parameter group for the DB cluster.
*/
DBClusterParameterGroup?: String;
/**
* Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
*/
DBSubnetGroup?: String;
/**
* Specifies the current state of this DB cluster.
*/
Status?: String;
/**
* Specifies the progress of the operation as a percentage.
*/
PercentProgress?: String;
/**
* The earliest time to which a database can be restored with point-in-time restore.
*/
EarliestRestorableTime?: TStamp;
/**
* Specifies the connection endpoint for the primary instance of the DB cluster.
*/
Endpoint?: String;
/**
* The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
*/
ReaderEndpoint?: String;
/**
* Identifies all custom endpoints associated with the cluster.
*/
CustomEndpoints?: StringList;
/**
* Specifies whether the DB cluster has instances in multiple Availability Zones.
*/
MultiAZ?: BooleanOptional;
/**
* The name of the database engine to be used for this DB cluster.
*/
Engine?: String;
/**
* Indicates the database engine version.
*/
EngineVersion?: String;
/**
* Specifies the latest time to which a database can be restored with point-in-time restore.
*/
LatestRestorableTime?: TStamp;
/**
* Specifies the port that the database engine is listening on.
*/
Port?: IntegerOptional;
/**
* Contains the master username for the DB cluster.
*/
MasterUsername?: String;
/**
* Provides the list of option group memberships for this DB cluster.
*/
DBClusterOptionGroupMemberships?: DBClusterOptionGroupMemberships;
/**
* Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
*/
PreferredBackupWindow?: String;
/**
* Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*/
PreferredMaintenanceWindow?: String;
/**
* Contains the identifier of the source DB cluster if this DB cluster is a read replica.
*/
ReplicationSourceIdentifier?: String;
/**
* Contains one or more identifiers of the read replicas associated with this DB cluster.
*/
ReadReplicaIdentifiers?: ReadReplicaIdentifierList;
/**
* Provides the list of instances that make up the DB cluster.
*/
DBClusterMembers?: DBClusterMemberList;
/**
* Provides a list of VPC security groups that the DB cluster belongs to.
*/
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
/**
* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
*/
HostedZoneId?: String;
/**
* Specifies whether the DB cluster is encrypted.
*/
StorageEncrypted?: Boolean;
/**
* If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
*/
KmsKeyId?: String;
/**
* The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
*/
DbClusterResourceId?: String;
/**
* The Amazon Resource Name (ARN) for the DB cluster.
*/
DBClusterArn?: String;
/**
* Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
*/
AssociatedRoles?: DBClusterRoles;
/**
* A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
*/
IAMDatabaseAuthenticationEnabled?: BooleanOptional;
/**
* Identifies the clone group to which the DB cluster is associated.
*/
CloneGroupId?: String;
/**
* Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
*/
ClusterCreateTime?: TStamp;
/**
* The earliest time to which a DB cluster can be backtracked.
*/
EarliestBacktrackTime?: TStamp;
/**
* The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
*/
BacktrackWindow?: LongOptional;
/**
* The number of change records stored for Backtrack.
*/
BacktrackConsumedChangeRecords?: LongOptional;
/**
* A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
*/
EnabledCloudwatchLogsExports?: LogTypeList;
/**
* The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
*/
Capacity?: IntegerOptional;
/**
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode. To check if a DB cluster is part of a global database, use DescribeGlobalClusters instead of checking the EngineMode return value from DescribeDBClusters.
*/
EngineMode?: String;
ScalingConfigurationInfo?: ScalingConfigurationInfo;
/**
* Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
*/
DeletionProtection?: BooleanOptional;
/**
* A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
*/
HttpEndpointEnabled?: BooleanOptional;
/**
* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
*/
ActivityStreamMode?: ActivityStreamMode;
/**
* The status of the database activity stream.
*/
ActivityStreamStatus?: ActivityStreamStatus;
/**
* The AWS KMS key identifier used for encrypting messages in the database activity stream.
*/
ActivityStreamKmsKeyId?: String;
/**
* The name of the Amazon Kinesis data stream used for the database activity stream.
*/
ActivityStreamKinesisStreamName?: String;
/**
* Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
*/
CrossAccountClone?: BooleanOptional;
/**
* The Active Directory Domain membership records associated with the DB cluster.
*/
DomainMemberships?: DomainMembershipList;
/**
* Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
*/
GlobalWriteForwardingStatus?: WriteForwardingStatus;
/**
* Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
*/
GlobalWriteForwardingRequested?: BooleanOptional;
}
export interface DBClusterBacktrack {
/**
* Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
*/
DBClusterIdentifier?: String;
/**
* Contains the backtrack identifier.
*/
BacktrackIdentifier?: String;
/**
* The timestamp of the time to which the DB cluster was backtracked.
*/
BacktrackTo?: TStamp;
/**
* The timestamp of the time from which the DB cluster was backtracked.
*/
BacktrackedFrom?: TStamp;
/**
* The timestamp of the time at which the backtrack was requested.
*/
BacktrackRequestCreationTime?: TStamp;
/**
* The status of the backtrack. This property returns one of the following values: applying - The backtrack is currently being applied to or rolled back from the DB cluster. completed - The backtrack has successfully been applied to or rolled back from the DB cluster. failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster. pending - The backtrack is currently pending application to or rollback from the DB cluster.
*/
Status?: String;
}
export type DBClusterBacktrackList = DBClusterBacktrack[];
export interface DBClusterBacktrackMessage {
/**
* A pagination token that can be used in a later DescribeDBClusterBacktracks request.
*/
Marker?: String;
/**
* Contains a list of backtracks for the user.
*/
DBClusterBacktracks?: DBClusterBacktrackList;
}
export interface DBClusterCapacityInfo {
/**
* A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
*/
DBClusterIdentifier?: String;
/**
* A value that specifies the capacity that the DB cluster scales to next.
*/
PendingCapacity?: IntegerOptional;
/**
* The current capacity of the DB cluster.
*/
CurrentCapacity?: IntegerOptional;
/**
* The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
*/
SecondsBeforeTimeout?: IntegerOptional;
/**
* The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
*/
TimeoutAction?: String;
}
export interface DBClusterEndpoint {
/**
* The identifier associated with the endpoint. This parameter is stored as a lowercase string.
*/
DBClusterEndpointIdentifier?: String;
/**
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
*/
DBClusterIdentifier?: String;
/**
* A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
*/
DBClusterEndpointResourceIdentifier?: String;
/**
* The DNS address of the endpoint.
*/
Endpoint?: String;
/**
* The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
*/
Status?: String;
/**
* The type of the endpoint. One of: READER, WRITER, CUSTOM.
*/
EndpointType?: String;
/**
* The type associated with a custom endpoint. One of: READER, WRITER, ANY.
*/
CustomEndpointType?: String;
/**
* List of DB instance identifiers that are part of the custom endpoint group.
*/
StaticMembers?: StringList;
/**
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
*/
ExcludedMembers?: StringList;
/**
* The Amazon Resource Name (ARN) for the endpoint.
*/
DBClusterEndpointArn?: String;
}
export type DBClusterEndpointList = DBClusterEndpoint[];
export interface DBClusterEndpointMessage {
/**
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Contains the details of the endpoints associated with the cluster and matching any filter conditions.
*/
DBClusterEndpoints?: DBClusterEndpointList;
}
export type DBClusterList = DBCluster[];
export interface DBClusterMember {
/**
* Specifies the instance identifier for this member of the DB cluster.
*/
DBInstanceIdentifier?: String;
/**
* Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
*/
IsClusterWriter?: Boolean;
/**
* Specifies the status of the DB cluster parameter group for this member of the DB cluster.
*/
DBClusterParameterGroupStatus?: String;
/**
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
*/
PromotionTier?: IntegerOptional;
}
export type DBClusterMemberList = DBClusterMember[];
export interface DBClusterMessage {
/**
* A pagination token that can be used in a later DescribeDBClusters request.
*/
Marker?: String;
/**
* Contains a list of DB clusters for the user.
*/
DBClusters?: DBClusterList;
}
export type DBClusterOptionGroupMemberships = DBClusterOptionGroupStatus[];
export interface DBClusterOptionGroupStatus {
/**
* Specifies the name of the DB cluster option group.
*/
DBClusterOptionGroupName?: String;
/**
* Specifies the status of the DB cluster option group.
*/
Status?: String;
}
export interface DBClusterParameterGroup {
/**
* The name of the DB cluster parameter group.
*/
DBClusterParameterGroupName?: String;
/**
* The name of the DB parameter group family that this DB cluster parameter group is compatible with.
*/
DBParameterGroupFamily?: String;
/**
* Provides the customer-specified description for this DB cluster parameter group.
*/
Description?: String;
/**
* The Amazon Resource Name (ARN) for the DB cluster parameter group.
*/
DBClusterParameterGroupArn?: String;
}
export interface DBClusterParameterGroupDetails {
/**
* Provides a list of parameters for the DB cluster parameter group.
*/
Parameters?: ParametersList;
/**
* An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
}
export type DBClusterParameterGroupList = DBClusterParameterGroup[];
export interface DBClusterParameterGroupNameMessage {
/**
* The name of the DB cluster parameter group. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string.
*/
DBClusterParameterGroupName?: String;
}
export interface DBClusterParameterGroupsMessage {
/**
* An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of DB cluster parameter groups.
*/
DBClusterParameterGroups?: DBClusterParameterGroupList;
}
export interface DBClusterRole {
/**
* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
*/
RoleArn?: String;
/**
* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB cluster. INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.
*/
Status?: String;
/**
* The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
*/
FeatureName?: String;
}
export type DBClusterRoles = DBClusterRole[];
export interface DBClusterSnapshot {
/**
* Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
*/
AvailabilityZones?: AvailabilityZones;
/**
* Specifies the identifier for the DB cluster snapshot.
*/
DBClusterSnapshotIdentifier?: String;
/**
* Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
*/
DBClusterIdentifier?: String;
/**
* Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
*/
SnapshotCreateTime?: TStamp;
/**
* Specifies the name of the database engine.
*/
Engine?: String;
/**
* Specifies the allocated storage size in gibibytes (GiB).
*/
AllocatedStorage?: Integer;
/**
* Specifies the status of this DB cluster snapshot.
*/
Status?: String;
/**
* Specifies the port that the DB cluster was listening on at the time of the snapshot.
*/
Port?: Integer;
/**
* Provides the VPC ID associated with the DB cluster snapshot.
*/
VpcId?: String;
/**
* Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
*/
ClusterCreateTime?: TStamp;
/**
* Provides the master username for the DB cluster snapshot.
*/
MasterUsername?: String;
/**
* Provides the version of the database engine for this DB cluster snapshot.
*/
EngineVersion?: String;
/**
* Provides the license model information for this DB cluster snapshot.
*/
LicenseModel?: String;
/**
* Provides the type of the DB cluster snapshot.
*/
SnapshotType?: String;
/**
* Specifies the percentage of the estimated data that has been transferred.
*/
PercentProgress?: Integer;
/**
* Specifies whether the DB cluster snapshot is encrypted.
*/
StorageEncrypted?: Boolean;
/**
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
*/
KmsKeyId?: String;
/**
* The Amazon Resource Name (ARN) for the DB cluster snapshot.
*/
DBClusterSnapshotArn?: String;
/**
* If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
*/
SourceDBClusterSnapshotArn?: String;
/**
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
*/
IAMDatabaseAuthenticationEnabled?: Boolean;
}
export interface DBClusterSnapshotAttribute {
/**
* The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
*/
AttributeName?: String;
/**
* The value(s) for the manual DB cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.
*/
AttributeValues?: AttributeValueList;
}
export type DBClusterSnapshotAttributeList = DBClusterSnapshotAttribute[];
export interface DBClusterSnapshotAttributesResult {
/**
* The identifier of the manual DB cluster snapshot that the attributes apply to.
*/
DBClusterSnapshotIdentifier?: String;
/**
* The list of attributes and values for the manual DB cluster snapshot.
*/
DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList;
}
export type DBClusterSnapshotList = DBClusterSnapshot[];
export interface DBClusterSnapshotMessage {
/**
* An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Provides a list of DB cluster snapshots for the user.
*/
DBClusterSnapshots?: DBClusterSnapshotList;
}
export interface DBEngineVersion {
/**
* The name of the database engine.
*/
Engine?: String;
/**
* The version number of the database engine.
*/
EngineVersion?: String;
/**
* The name of the DB parameter group family for the database engine.
*/
DBParameterGroupFamily?: String;
/**
* The description of the database engine.
*/
DBEngineDescription?: String;
/**
* The description of the database engine version.
*/
DBEngineVersionDescription?: String;
/**
* The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
*/
DefaultCharacterSet?: CharacterSet;
/**
* A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
*/
SupportedCharacterSets?: SupportedCharacterSetsList;
/**
* A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
*/
SupportedNcharCharacterSets?: SupportedCharacterSetsList;
/**
* A list of engine versions that this database engine version can be upgraded to.
*/
ValidUpgradeTarget?: ValidUpgradeTargetList;
/**
* A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
*/
SupportedTimezones?: SupportedTimezonesList;
/**
* The types of logs that the database engine has available for export to CloudWatch Logs.
*/
ExportableLogTypes?: LogTypeList;
/**
* A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
*/
SupportsLogExportsToCloudwatchLogs?: Boolean;
/**
* Indicates whether the database engine version supports read replicas.
*/
SupportsReadReplica?: Boolean;
/**
* A list of the supported DB engine modes. global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode.
*/
SupportedEngineModes?: EngineModeList;
/**
* A list of features supported by the DB engine. Supported feature names include the following. s3Import
*/
SupportedFeatureNames?: FeatureNameList;
/**
* The status of the DB engine version, either available or deprecated.
*/
Status?: String;
/**
* A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
*/
SupportsParallelQuery?: Boolean;
/**
* A value that indicates whether you can use Aurora global databases with a specific DB engine version.
*/
SupportsGlobalDatabases?: Boolean;
}
export type DBEngineVersionList = DBEngineVersion[];
export interface DBEngineVersionMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of DBEngineVersion elements.
*/
DBEngineVersions?: DBEngineVersionList;
}
export interface DBInstance {
/**
* Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
*/
DBInstanceIdentifier?: String;
/**
* Contains the name of the compute and memory capacity class of the DB instance.
*/
DBInstanceClass?: String;
/**
* The name of the database engine to be used for this DB instance.
*/
Engine?: String;
/**
* Specifies the current state of this database. For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.
*/
DBInstanceStatus?: String;
/**
* Contains the master username for the DB instance.
*/
MasterUsername?: String;
/**
* The meaning of this parameter differs according to the database engine you use. MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
*/
DBName?: String;
/**
* Specifies the connection endpoint.
*/
Endpoint?: Endpoint;
/**
* Specifies the allocated storage size specified in gibibytes.
*/
AllocatedStorage?: Integer;
/**
* Provides the date and time the DB instance was created.
*/
InstanceCreateTime?: TStamp;
/**
* Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
*/
PreferredBackupWindow?: String;
/**
* Specifies the number of days for which automatic DB snapshots are retained.
*/
BackupRetentionPeriod?: Integer;
/**
* A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
*/
DBSecurityGroups?: DBSecurityGroupMembershipList;
/**
* Provides a list of VPC security group elements that the DB instance belongs to.
*/
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
/**
* Provides the list of DB parameter groups applied to this DB instance.
*/
DBParameterGroups?: DBParameterGroupStatusList;
/**
* Specifies the name of the Availability Zone the DB instance is located in.
*/
AvailabilityZone?: String;
/**
* Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
*/
DBSubnetGroup?: DBSubnetGroup;
/**
* Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*/
PreferredMaintenanceWindow?: String;
/**
* Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
*/
PendingModifiedValues?: PendingModifiedValues;
/**
* Specifies the latest time to which a database can be restored with point-in-time restore.
*/
LatestRestorableTime?: TStamp;
/**
* Specifies if the DB instance is a Multi-AZ deployment.
*/
MultiAZ?: Boolean;
/**
* Indicates the database engine version.
*/
EngineVersion?: String;
/**
* Indicates that minor version patches are applied automatically.
*/
AutoMinorVersionUpgrade?: Boolean;
/**
* Contains the identifier of the source DB instance if this DB instance is a read replica.
*/
ReadReplicaSourceDBInstanceIdentifier?: String;
/**
* Contains one or more identifiers of the read replicas associated with this DB instance.
*/
ReadReplicaDBInstanceIdentifiers?: ReadReplicaDBInstanceIdentifierList;
/**
* Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.
*/
ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList;
/**
* The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.
*/
ReplicaMode?: ReplicaMode;
/**
* License model information for this DB instance.
*/
LicenseModel?: String;
/**
* Specifies the Provisioned IOPS (I/O operations per second) value.
*/
Iops?: IntegerOptional;
/**
* Provides the list of option group memberships for this DB instance.
*/
OptionGroupMemberships?: OptionGroupMembershipList;
/**
* If present, specifies the name of the character set that this instance is associated with.
*/
CharacterSetName?: String;
/**
* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
*/
NcharCharacterSetName?: String;
/**
* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
*/
SecondaryAvailabilityZone?: String;
/**
* Specifies the accessibility options for the DB instance. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
*/
PubliclyAccessible?: Boolean;
/**
* The status of a read replica. If the instance isn't a read replica, this is blank.
*/
StatusInfos?: DBInstanceStatusInfoList;
/**
* Specifies the storage type associated with DB instance.
*/
StorageType?: String;
/**
* The ARN from the key store with which the instance is associated for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
*/
DbInstancePort?: Integer;
/**
* If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
*/
DBClusterIdentifier?: String;
/**
* Specifies whether the DB instance is encrypted.
*/
StorageEncrypted?: Boolean;
/**
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
*/
KmsKeyId?: String;
/**
* The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
*/
DbiResourceId?: String;
/**
* The identifier of the CA certificate for this DB instance.
*/
CACertificateIdentifier?: String;
/**
* The Active Directory Domain membership records associated with the DB instance.
*/
DomainMemberships?: DomainMembershipList;
/**
* Specifies whether tags are copied from the DB instance to snapshots of the DB instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
*/
CopyTagsToSnapshot?: Boolean;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
*/
MonitoringInterval?: IntegerOptional;
/**
* The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
*/
EnhancedMonitoringResourceArn?: String;
/**
* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
*/
MonitoringRoleArn?: String;
/**
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
*/
PromotionTier?: IntegerOptional;
/**
* The Amazon Resource Name (ARN) for the DB instance.
*/
DBInstanceArn?: String;
/**
* The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
*/
Timezone?: String;
/**
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. IAM database authentication can be enabled for the following database engines For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
*/
IAMDatabaseAuthenticationEnabled?: Boolean;
/**
* True if Performance Insights is enabled for the DB instance, and otherwise false.
*/
PerformanceInsightsEnabled?: BooleanOptional;
/**
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
*/
PerformanceInsightsRetentionPeriod?: IntegerOptional;
/**
* A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
*/
EnabledCloudwatchLogsExports?: LogTypeList;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
*/
DeletionProtection?: Boolean;
/**
* The AWS Identity and Access Management (IAM) roles associated with the DB instance.
*/
AssociatedRoles?: DBInstanceRoles;
/**
* Specifies the listener connection endpoint for SQL Server Always On.
*/
ListenerEndpoint?: Endpoint;
/**
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
*/
MaxAllocatedStorage?: IntegerOptional;
}
export interface DBInstanceAutomatedBackup {
/**
* The Amazon Resource Name (ARN) for the automated backup.
*/
DBInstanceArn?: String;
/**
* The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
*/
DbiResourceId?: String;
/**
* The AWS Region associated with the automated backup.
*/
Region?: String;
/**
* The customer id of the instance that is/was associated with the automated backup.
*/
DBInstanceIdentifier?: String;
/**
* Earliest and latest time an instance can be restored to.
*/
RestoreWindow?: RestoreWindow;
/**
* Specifies the allocated storage size in gibibytes (GiB).
*/
AllocatedStorage?: Integer;
/**
* Provides a list of status information for an automated backup: active - automated backups for current instances retained - automated backups for deleted instances creating - automated backups that are waiting for the first automated snapshot to be available.
*/
Status?: String;
/**
* The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535
*/
Port?: Integer;
/**
* The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
*/
AvailabilityZone?: String;
/**
* Provides the VPC ID associated with the DB instance
*/
VpcId?: String;
/**
* Provides the date and time that the DB instance was created.
*/
InstanceCreateTime?: TStamp;
/**
* The license model of an automated backup.
*/
MasterUsername?: String;
/**
* The name of the database engine for this automated backup.
*/
Engine?: String;
/**
* The version of the database engine for the automated backup.
*/
EngineVersion?: String;
/**
* License model information for the automated backup.
*/
LicenseModel?: String;
/**
* The IOPS (I/O operations per second) value for the automated backup.
*/
Iops?: IntegerOptional;
/**
* The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
*/
OptionGroupName?: String;
/**
* The ARN from the key store with which the automated backup is associated for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* Specifies whether the automated backup is encrypted.
*/
Encrypted?: Boolean;
/**
* Specifies the storage type associated with the automated backup.
*/
StorageType?: String;
/**
* The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
*/
KmsKeyId?: String;
/**
* The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
*/
Timezone?: String;
/**
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
*/
IAMDatabaseAuthenticationEnabled?: Boolean;
}
export type DBInstanceAutomatedBackupList = DBInstanceAutomatedBackup[];
export interface DBInstanceAutomatedBackupMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
/**
* A list of DBInstanceAutomatedBackup instances.
*/
DBInstanceAutomatedBackups?: DBInstanceAutomatedBackupList;
}
export type DBInstanceList = DBInstance[];
export interface DBInstanceMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
/**
* A list of DBInstance instances.
*/
DBInstances?: DBInstanceList;
}
export interface DBInstanceRole {
/**
* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
*/
RoleArn?: String;
/**
* The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.
*/
FeatureName?: String;
/**
* Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values: ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf. PENDING - the IAM role ARN is being associated with the DB instance. INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.
*/
Status?: String;
}
export type DBInstanceRoles = DBInstanceRole[];
export interface DBInstanceStatusInfo {
/**
* This value is currently "read replication."
*/
StatusType?: String;
/**
* Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
*/
Normal?: Boolean;
/**
* Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
*/
Status?: String;
/**
* Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
*/
Message?: String;
}
export type DBInstanceStatusInfoList = DBInstanceStatusInfo[];
export interface DBParameterGroup {
/**
* The name of the DB parameter group.
*/
DBParameterGroupName?: String;
/**
* The name of the DB parameter group family that this DB parameter group is compatible with.
*/
DBParameterGroupFamily?: String;
/**
* Provides the customer-specified description for this DB parameter group.
*/
Description?: String;
/**
* The Amazon Resource Name (ARN) for the DB parameter group.
*/
DBParameterGroupArn?: String;
}
export interface DBParameterGroupDetails {
/**
* A list of Parameter values.
*/
Parameters?: ParametersList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export type DBParameterGroupList = DBParameterGroup[];
export interface DBParameterGroupNameMessage {
/**
* The name of the DB parameter group.
*/
DBParameterGroupName?: String;
}
export interface DBParameterGroupStatus {
/**
* The name of the DB parameter group.
*/
DBParameterGroupName?: String;
/**
* The status of parameter updates.
*/
ParameterApplyStatus?: String;
}
export type DBParameterGroupStatusList = DBParameterGroupStatus[];
export interface DBParameterGroupsMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of DBParameterGroup instances.
*/
DBParameterGroups?: DBParameterGroupList;
}
export interface DBProxy {
/**
* The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
*/
DBProxyName?: String;
/**
* The Amazon Resource Name (ARN) for the proxy.
*/
DBProxyArn?: String;
/**
* The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
*/
Status?: DBProxyStatus;
/**
* The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
*/
EngineFamily?: String;
/**
* Provides a list of VPC security groups that the proxy belongs to.
*/
VpcSecurityGroupIds?: StringList;
/**
* The EC2 subnet IDs for the proxy.
*/
VpcSubnetIds?: StringList;
/**
* One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
*/
Auth?: UserAuthConfigInfoList;
/**
* The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
*/
RoleArn?: String;
/**
* The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
*/
Endpoint?: String;
/**
* Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
*/
RequireTLS?: Boolean;
/**
* The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800
*/
IdleClientTimeout?: Integer;
/**
* Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*/
DebugLogging?: Boolean;
/**
* The date and time when the proxy was first created.
*/
CreatedDate?: TStamp;
/**
* The date and time when the proxy was last updated.
*/
UpdatedDate?: TStamp;
}
export type DBProxyList = DBProxy[];
export type DBProxyStatus = "available"|"modifying"|"incompatible-network"|"insufficient-resource-limits"|"creating"|"deleting"|"suspended"|"suspending"|"reactivating"|string;
export interface DBProxyTarget {
/**
* The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
*/
TargetArn?: String;
/**
* The writer endpoint for the RDS DB instance or Aurora DB cluster.
*/
Endpoint?: String;
/**
* The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
*/
TrackedClusterId?: String;
/**
* The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
*/
RdsResourceId?: String;
/**
* The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
*/
Port?: Integer;
/**
* Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
*/
Type?: TargetType;
/**
* Information about the connection health of the RDS Proxy target.
*/
TargetHealth?: TargetHealth;
}
export interface DBProxyTargetGroup {
/**
* The identifier for the RDS proxy associated with this target group.
*/
DBProxyName?: String;
/**
* The identifier for the target group. This name must be unique for all target groups owned by your AWS account in the specified AWS Region.
*/
TargetGroupName?: String;
/**
* The Amazon Resource Name (ARN) representing the target group.
*/
TargetGroupArn?: String;
/**
* Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.
*/
IsDefault?: Boolean;
/**
* The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
*/
Status?: String;
/**
* The settings that determine the size and behavior of the connection pool for the target group.
*/
ConnectionPoolConfig?: ConnectionPoolConfigurationInfo;
/**
* The date and time when the target group was first created.
*/
CreatedDate?: TStamp;
/**
* The date and time when the target group was last updated.
*/
UpdatedDate?: TStamp;
}
export interface DBSecurityGroup {
/**
* Provides the AWS ID of the owner of a specific DB security group.
*/
OwnerId?: String;
/**
* Specifies the name of the DB security group.
*/
DBSecurityGroupName?: String;
/**
* Provides the description of the DB security group.
*/
DBSecurityGroupDescription?: String;
/**
* Provides the VpcId of the DB security group.
*/
VpcId?: String;
/**
* Contains a list of EC2SecurityGroup elements.
*/
EC2SecurityGroups?: EC2SecurityGroupList;
/**
* Contains a list of IPRange elements.
*/
IPRanges?: IPRangeList;
/**
* The Amazon Resource Name (ARN) for the DB security group.
*/
DBSecurityGroupArn?: String;
}
export interface DBSecurityGroupMembership {
/**
* The name of the DB security group.
*/
DBSecurityGroupName?: String;
/**
* The status of the DB security group.
*/
Status?: String;
}
export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[];
export interface DBSecurityGroupMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of DBSecurityGroup instances.
*/
DBSecurityGroups?: DBSecurityGroups;
}
export type DBSecurityGroupNameList = String[];
export type DBSecurityGroups = DBSecurityGroup[];
export interface DBSnapshot {
/**
* Specifies the identifier for the DB snapshot.
*/
DBSnapshotIdentifier?: String;
/**
* Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
*/
DBInstanceIdentifier?: String;
/**
* Specifies when the snapshot was taken in Coodinated Universal Time (UTC).
*/
SnapshotCreateTime?: TStamp;
/**
* Specifies the name of the database engine.
*/
Engine?: String;
/**
* Specifies the allocated storage size in gibibytes (GiB).
*/
AllocatedStorage?: Integer;
/**
* Specifies the status of this DB snapshot.
*/
Status?: String;
/**
* Specifies the port that the database engine was listening on at the time of the snapshot.
*/
Port?: Integer;
/**
* Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
*/
AvailabilityZone?: String;
/**
* Provides the VPC ID associated with the DB snapshot.
*/
VpcId?: String;
/**
* Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
*/
InstanceCreateTime?: TStamp;
/**
* Provides the master username for the DB snapshot.
*/
MasterUsername?: String;
/**
* Specifies the version of the database engine.
*/
EngineVersion?: String;
/**
* License model information for the restored DB instance.
*/
LicenseModel?: String;
/**
* Provides the type of the DB snapshot.
*/
SnapshotType?: String;
/**
* Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
*/
Iops?: IntegerOptional;
/**
* Provides the option group name for the DB snapshot.
*/
OptionGroupName?: String;
/**
* The percentage of the estimated data that has been transferred.
*/
PercentProgress?: Integer;
/**
* The AWS Region that the DB snapshot was created in or copied from.
*/
SourceRegion?: String;
/**
* The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.
*/
SourceDBSnapshotIdentifier?: String;
/**
* Specifies the storage type associated with DB snapshot.
*/
StorageType?: String;
/**
* The ARN from the key store with which to associate the instance for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* Specifies whether the DB snapshot is encrypted.
*/
Encrypted?: Boolean;
/**
* If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
*/
KmsKeyId?: String;
/**
* The Amazon Resource Name (ARN) for the DB snapshot.
*/
DBSnapshotArn?: String;
/**
* The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
*/
Timezone?: String;
/**
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
*/
IAMDatabaseAuthenticationEnabled?: Boolean;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
*/
DbiResourceId?: String;
}
export interface DBSnapshotAttribute {
/**
* The name of the manual DB snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
*/
AttributeName?: String;
/**
* The value or values for the manual DB snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.
*/
AttributeValues?: AttributeValueList;
}
export type DBSnapshotAttributeList = DBSnapshotAttribute[];
export interface DBSnapshotAttributesResult {
/**
* The identifier of the manual DB snapshot that the attributes apply to.
*/
DBSnapshotIdentifier?: String;
/**
* The list of attributes and values for the manual DB snapshot.
*/
DBSnapshotAttributes?: DBSnapshotAttributeList;
}
export type DBSnapshotList = DBSnapshot[];
export interface DBSnapshotMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of DBSnapshot instances.
*/
DBSnapshots?: DBSnapshotList;
}
export interface DBSubnetGroup {
/**
* The name of the DB subnet group.
*/
DBSubnetGroupName?: String;
/**
* Provides the description of the DB subnet group.
*/
DBSubnetGroupDescription?: String;
/**
* Provides the VpcId of the DB subnet group.
*/
VpcId?: String;
/**
* Provides the status of the DB subnet group.
*/
SubnetGroupStatus?: String;
/**
* Contains a list of Subnet elements.
*/
Subnets?: SubnetList;
/**
* The Amazon Resource Name (ARN) for the DB subnet group.
*/
DBSubnetGroupArn?: String;
}
export interface DBSubnetGroupMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of DBSubnetGroup instances.
*/
DBSubnetGroups?: DBSubnetGroups;
}
export type DBSubnetGroups = DBSubnetGroup[];
export interface DeleteCustomAvailabilityZoneMessage {
/**
* The custom AZ identifier.
*/
CustomAvailabilityZoneId: String;
}
export interface DeleteCustomAvailabilityZoneResult {
CustomAvailabilityZone?: CustomAvailabilityZone;
}
export interface DeleteDBClusterEndpointMessage {
/**
* The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
*/
DBClusterEndpointIdentifier: String;
}
export interface DeleteDBClusterMessage {
/**
* The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: Must match an existing DBClusterIdentifier.
*/
DBClusterIdentifier: String;
/**
* A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
*/
SkipFinalSnapshot?: Boolean;
/**
* The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled. Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
*/
FinalDBSnapshotIdentifier?: String;
}
export interface DeleteDBClusterParameterGroupMessage {
/**
* The name of the DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can't delete a default DB cluster parameter group. Can't be associated with any DB clusters.
*/
DBClusterParameterGroupName: String;
}
export interface DeleteDBClusterResult {
DBCluster?: DBCluster;
}
export interface DeleteDBClusterSnapshotMessage {
/**
* The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state.
*/
DBClusterSnapshotIdentifier: String;
}
export interface DeleteDBClusterSnapshotResult {
DBClusterSnapshot?: DBClusterSnapshot;
}
export interface DeleteDBInstanceAutomatedBackupMessage {
/**
* The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
*/
DbiResourceId: String;
}
export interface DeleteDBInstanceAutomatedBackupResult {
DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
}
export interface DeleteDBInstanceMessage {
/**
* The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: Must match the name of an existing DB instance.
*/
DBInstanceIdentifier: String;
/**
* A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created. When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified. Specify skip when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
*/
SkipFinalSnapshot?: Boolean;
/**
* The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Can't be specified when deleting a read replica.
*/
FinalDBSnapshotIdentifier?: String;
/**
* A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.
*/
DeleteAutomatedBackups?: BooleanOptional;
}
export interface DeleteDBInstanceResult {
DBInstance?: DBInstance;
}
export interface DeleteDBParameterGroupMessage {
/**
* The name of the DB parameter group. Constraints: Must be the name of an existing DB parameter group You can't delete a default DB parameter group Can't be associated with any DB instances
*/
DBParameterGroupName: String;
}
export interface DeleteDBProxyRequest {
/**
* The name of the DB proxy to delete.
*/
DBProxyName: String;
}
export interface DeleteDBProxyResponse {
/**
* The data structure representing the details of the DB proxy that you delete.
*/
DBProxy?: DBProxy;
}
export interface DeleteDBSecurityGroupMessage {
/**
* The name of the DB security group to delete. You can't delete the default DB security group. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Must not be "Default"
*/
DBSecurityGroupName: String;
}
export interface DeleteDBSnapshotMessage {
/**
* The DB snapshot identifier. Constraints: Must be the name of an existing DB snapshot in the available state.
*/
DBSnapshotIdentifier: String;
}
export interface DeleteDBSnapshotResult {
DBSnapshot?: DBSnapshot;
}
export interface DeleteDBSubnetGroupMessage {
/**
* The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
*/
DBSubnetGroupName: String;
}
export interface DeleteEventSubscriptionMessage {
/**
* The name of the RDS event notification subscription you want to delete.
*/
SubscriptionName: String;
}
export interface DeleteEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface DeleteGlobalClusterMessage {
/**
* The cluster identifier of the global database cluster being deleted.
*/
GlobalClusterIdentifier: String;
}
export interface DeleteGlobalClusterResult {
GlobalCluster?: GlobalCluster;
}
export interface DeleteInstallationMediaMessage {
/**
* The installation medium ID.
*/
InstallationMediaId: String;
}
export interface DeleteOptionGroupMessage {
/**
* The name of the option group to be deleted. You can't delete default option groups.
*/
OptionGroupName: String;
}
export interface DeregisterDBProxyTargetsRequest {
/**
* The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
*/
DBProxyName: String;
/**
* The identifier of the DBProxyTargetGroup.
*/
TargetGroupName?: String;
/**
* One or more DB instance identifiers.
*/
DBInstanceIdentifiers?: StringList;
/**
* One or more DB cluster identifiers.
*/
DBClusterIdentifiers?: StringList;
}
export interface DeregisterDBProxyTargetsResponse {
}
export interface DescribeAccountAttributesMessage {
}
export interface DescribeCertificatesMessage {
/**
* The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive. Constraints: Must match an existing CertificateIdentifier.
*/
CertificateIdentifier?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeCustomAvailabilityZonesMessage {
/**
* The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.
*/
CustomAvailabilityZoneId?: String;
/**
* A filter that specifies one or more custom AZs to describe.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBClusterBacktracksMessage {
/**
* The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
*/
DBClusterIdentifier: String;
/**
* If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace. Example: 123e4567-e89b-12d3-a456-426655440000
*/
BacktrackIdentifier?: String;
/**
* A filter that specifies one or more DB clusters to describe. Supported filters include the following: db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. db-cluster-backtrack-status - Accepts any of the following backtrack status values: applying completed failed pending The results list includes information about only the backtracks identified by these values.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBClusterEndpointsMessage {
/**
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
*/
DBClusterIdentifier?: String;
/**
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*/
DBClusterEndpointIdentifier?: String;
/**
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBClusterParameterGroupsMessage {
/**
* The name of a specific DB cluster parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
*/
DBClusterParameterGroupName?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBClusterParametersMessage {
/**
* The name of a specific DB cluster parameter group to return parameter details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
*/
DBClusterParameterGroupName: String;
/**
* A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
*/
Source?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBClusterSnapshotAttributesMessage {
/**
* The identifier for the DB cluster snapshot to describe the attributes for.
*/
DBClusterSnapshotIdentifier: String;
}
export interface DescribeDBClusterSnapshotAttributesResult {
DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
}
export interface DescribeDBClusterSnapshotsMessage {
/**
* The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster.
*/
DBClusterIdentifier?: String;
/**
* A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
*/
DBClusterSnapshotIdentifier?: String;
/**
* The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB cluster snapshots that have been taken by my AWS account. shared - Return all manual DB cluster snapshots that have been shared to my AWS account. public - Return all DB cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
*/
SnapshotType?: String;
/**
* A filter that specifies one or more DB cluster snapshots to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers. snapshot-type - Accepts types of DB cluster snapshots. engine - Accepts names of database engines.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included. You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
*/
IncludeShared?: Boolean;
/**
* A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
*/
IncludePublic?: Boolean;
}
export interface DescribeDBClustersMessage {
/**
* The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier.
*/
DBClusterIdentifier?: String;
/**
* A filter that specifies one or more DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.
*/
IncludeShared?: Boolean;
}
export interface DescribeDBEngineVersionsMessage {
/**
* The database engine to return.
*/
Engine?: String;
/**
* The database engine version to return. Example: 5.1.49
*/
EngineVersion?: String;
/**
* The name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DBParameterGroupFamily.
*/
DBParameterGroupFamily?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
*/
DefaultOnly?: Boolean;
/**
* A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
*/
ListSupportedCharacterSets?: BooleanOptional;
/**
* A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
*/
ListSupportedTimezones?: BooleanOptional;
/**
* A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
*/
IncludeAll?: BooleanOptional;
}
export interface DescribeDBInstanceAutomatedBackupsMessage {
/**
* The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.
*/
DbiResourceId?: String;
/**
* (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.
*/
DBInstanceIdentifier?: String;
/**
* A filter that specifies which resources to return based on status. Supported filters are the following: status active - automated backups for current instances retained - automated backups for deleted instances creating - automated backups that are waiting for the first automated snapshot to be available db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs. dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs. Returns all resources by default. The status for each resource is specified in the response.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
*/
MaxRecords?: IntegerOptional;
/**
* The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBInstancesMessage {
/**
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier?: String;
/**
* A filter that specifies one or more DB instances to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs. dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers. domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains. engine - Accepts engine names. The results list will only include information about the DB instances for these engines.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBLogFilesDetails {
/**
* The name of the log file for the specified DB instance.
*/
LogFileName?: String;
/**
* A POSIX timestamp when the last log entry was written.
*/
LastWritten?: Long;
/**
* The size, in bytes, of the log file for the specified DB instance.
*/
Size?: Long;
}
export type DescribeDBLogFilesList = DescribeDBLogFilesDetails[];
export interface DescribeDBLogFilesMessage {
/**
* The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier: String;
/**
* Filters the available log files for log file names that contain the specified string.
*/
FilenameContains?: String;
/**
* Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
*/
FileLastWritten?: Long;
/**
* Filters the available log files for files larger than the specified size.
*/
FileSize?: Long;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
*/
MaxRecords?: IntegerOptional;
/**
* The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBLogFilesResponse {
/**
* The DB log files returned.
*/
DescribeDBLogFiles?: DescribeDBLogFilesList;
/**
* A pagination token that can be used in a later DescribeDBLogFiles request.
*/
Marker?: String;
}
export interface DescribeDBParameterGroupsMessage {
/**
* The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
*/
DBParameterGroupName?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBParametersMessage {
/**
* The name of a specific DB parameter group to return details for. Constraints: If supplied, must match the name of an existing DBParameterGroup.
*/
DBParameterGroupName: String;
/**
* The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default
*/
Source?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBProxiesRequest {
/**
* The name of the DB proxy.
*/
DBProxyName?: String;
/**
* This parameter is not currently supported.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeDBProxiesResponse {
/**
* A return value representing an arbitrary number of DBProxy data structures.
*/
DBProxies?: DBProxyList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBProxyTargetGroupsRequest {
/**
* The identifier of the DBProxy associated with the target group.
*/
DBProxyName: String;
/**
* The identifier of the DBProxyTargetGroup to describe.
*/
TargetGroupName?: String;
/**
* This parameter is not currently supported.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeDBProxyTargetGroupsResponse {
/**
* An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
*/
TargetGroups?: TargetGroupList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBProxyTargetsRequest {
/**
* The identifier of the DBProxyTarget to describe.
*/
DBProxyName: String;
/**
* The identifier of the DBProxyTargetGroup to describe.
*/
TargetGroupName?: String;
/**
* This parameter is not currently supported.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeDBProxyTargetsResponse {
/**
* An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
*/
Targets?: TargetList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBSecurityGroupsMessage {
/**
* The name of the DB security group to return details for.
*/
DBSecurityGroupName?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBSnapshotAttributesMessage {
/**
* The identifier for the DB snapshot to describe the attributes for.
*/
DBSnapshotIdentifier: String;
}
export interface DescribeDBSnapshotAttributesResult {
DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
}
export interface DescribeDBSnapshotsMessage {
/**
* The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier?: String;
/**
* A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
*/
DBSnapshotIdentifier?: String;
/**
* The type of snapshots to be returned. You can specify one of the following values: automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account. manual - Return all DB snapshots that have been taken by my AWS account. shared - Return all manual DB snapshots that have been shared to my AWS account. public - Return all DB snapshots that have been marked as public. awsbackup - Return the DB snapshots managed by the AWS Backup service. For information about AWS Backup, see the AWS Backup Developer Guide. The awsbackup type does not apply to Aurora. If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
*/
SnapshotType?: String;
/**
* A filter that specifies one or more DB snapshots to describe. Supported filters: db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). db-snapshot-id - Accepts DB snapshot identifiers. dbi-resource-id - Accepts identifiers of source DB instances. snapshot-type - Accepts types of DB snapshots. engine - Accepts names of database engines.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included. You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
*/
IncludeShared?: Boolean;
/**
* A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
*/
IncludePublic?: Boolean;
/**
* A specific DB resource ID to describe.
*/
DbiResourceId?: String;
}
export interface DescribeDBSubnetGroupsMessage {
/**
* The name of the DB subnet group to return details for.
*/
DBSubnetGroupName?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEngineDefaultClusterParametersMessage {
/**
* The name of the DB cluster parameter group family to return engine parameter information for.
*/
DBParameterGroupFamily: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEngineDefaultClusterParametersResult {
EngineDefaults?: EngineDefaults;
}
export interface DescribeEngineDefaultParametersMessage {
/**
* The name of the DB parameter group family.
*/
DBParameterGroupFamily: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEngineDefaultParametersResult {
EngineDefaults?: EngineDefaults;
}
export interface DescribeEventCategoriesMessage {
/**
* The type of source that is generating the events. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
*/
SourceType?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
}
export interface DescribeEventSubscriptionsMessage {
/**
* The name of the RDS event notification subscription you want to describe.
*/
SubscriptionName?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
}
export interface DescribeEventsMessage {
/**
* The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: If SourceIdentifier is supplied, SourceType must also be provided. If the source type is a DB instance, a DBInstanceIdentifier value must be supplied. If the source type is a DB cluster, a DBClusterIdentifier value must be supplied. If the source type is a DB parameter group, a DBParameterGroupName value must be supplied. If the source type is a DB security group, a DBSecurityGroupName value must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied. If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied. Can't end with a hyphen or contain two consecutive hyphens.
*/
SourceIdentifier?: String;
/**
* The event source to retrieve events for. If no value is specified, all events are returned.
*/
SourceType?: SourceType;
/**
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
*/
StartTime?: TStamp;
/**
* The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
*/
EndTime?: TStamp;
/**
* The number of minutes to retrieve events for. Default: 60
*/
Duration?: IntegerOptional;
/**
* A list of event categories that trigger notifications for a event notification subscription.
*/
EventCategories?: EventCategoriesList;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeExportTasksMessage {
/**
* The identifier of the snapshot export task to be described.
*/
ExportTaskIdentifier?: String;
/**
* The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
*/
SourceArn?: String;
/**
* Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task. Must be lowercase, for example, complete.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeGlobalClustersMessage {
/**
* The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DBClusterIdentifier.
*/
GlobalClusterIdentifier?: String;
/**
* A filter that specifies one or more global DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeInstallationMediaMessage {
/**
* The installation medium ID.
*/
InstallationMediaId?: String;
/**
* A filter that specifies one or more installation media to describe. Supported filters include the following: custom-availability-zone-id - Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers. engine - Accepts database engines. The results list includes information about only the database engines identified by these identifiers. For more information about the valid engines for installation media, see ImportInstallationMedia.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeOptionGroupOptionsMessage {
/**
* A required parameter. Options available for the given engine name are described.
*/
EngineName: String;
/**
* If specified, filters the results to include only options for the specified major engine version.
*/
MajorEngineVersion?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeOptionGroupsMessage {
/**
* The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
*/
OptionGroupName?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* Filters the list of option groups to only include groups associated with a specific database engine.
*/
EngineName?: String;
/**
* Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.
*/
MajorEngineVersion?: String;
}
export interface DescribeOrderableDBInstanceOptionsMessage {
/**
* The name of the engine to retrieve DB instance options for.
*/
Engine: String;
/**
* The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
*/
EngineVersion?: String;
/**
* The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
*/
DBInstanceClass?: String;
/**
* The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
*/
LicenseModel?: String;
/**
* The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group. Omit this parameter to show the available offerings in the specified AWS Region.
*/
AvailabilityZoneGroup?: String;
/**
* A value that indicates whether to show only VPC or non-VPC offerings.
*/
Vpc?: BooleanOptional;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
}
export interface DescribePendingMaintenanceActionsMessage {
/**
* The ARN of a resource to return pending maintenance actions for.
*/
ResourceIdentifier?: String;
/**
* A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
}
export interface DescribeReservedDBInstancesMessage {
/**
* The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
*/
ReservedDBInstanceId?: String;
/**
* The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
*/
ReservedDBInstancesOfferingId?: String;
/**
* The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
*/
DBInstanceClass?: String;
/**
* The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
*/
Duration?: String;
/**
* The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
*/
ProductDescription?: String;
/**
* The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*/
OfferingType?: String;
/**
* A value that indicates whether to show only those reservations that support Multi-AZ.
*/
MultiAZ?: BooleanOptional;
/**
* The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. AWS Support might request the lease ID for an issue related to a reserved DB instance.
*/
LeaseId?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReservedDBInstancesOfferingsMessage {
/**
* The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
ReservedDBInstancesOfferingId?: String;
/**
* The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
*/
DBInstanceClass?: String;
/**
* Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
*/
Duration?: String;
/**
* Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description. The results show offerings that partially match the filter value.
*/
ProductDescription?: String;
/**
* The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
*/
OfferingType?: String;
/**
* A value that indicates whether to show only those reservations that support Multi-AZ.
*/
MultiAZ?: BooleanOptional;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
/**
* The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeSourceRegionsMessage {
/**
* The source AWS Region name. For example, us-east-1. Constraints: Must specify a valid AWS Region name.
*/
RegionName?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
/**
* An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
}
export interface DescribeValidDBInstanceModificationsMessage {
/**
* The customer identifier or the ARN of your DB instance.
*/
DBInstanceIdentifier: String;
}
export interface DescribeValidDBInstanceModificationsResult {
ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage;
}
export interface DomainMembership {
/**
* The identifier of the Active Directory Domain.
*/
Domain?: String;
/**
* The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
*/
Status?: String;
/**
* The fully qualified domain name of the Active Directory Domain.
*/
FQDN?: String;
/**
* The name of the IAM role to be used when making API calls to the Directory Service.
*/
IAMRoleName?: String;
}
export type DomainMembershipList = DomainMembership[];
export type Double = number;
export type DoubleOptional = number;
export interface DoubleRange {
/**
* The minimum value in the range.
*/
From?: Double;
/**
* The maximum value in the range.
*/
To?: Double;
}
export type DoubleRangeList = DoubleRange[];
export interface DownloadDBLogFilePortionDetails {
/**
* Entries from the specified log file.
*/
LogFileData?: String;
/**
* A pagination token that can be used in a later DownloadDBLogFilePortion request.
*/
Marker?: String;
/**
* Boolean value that if true, indicates there is more data to be downloaded.
*/
AdditionalDataPending?: Boolean;
}
export interface DownloadDBLogFilePortionMessage {
/**
* The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: Must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier: String;
/**
* The name of the log file to be downloaded.
*/
LogFileName: String;
/**
* The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.
*/
Marker?: String;
/**
* The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size. If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter. If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first. If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned. If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned. You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
*/
NumberOfLines?: Integer;
}
export interface EC2SecurityGroup {
/**
* Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
*/
Status?: String;
/**
* Specifies the name of the EC2 security group.
*/
EC2SecurityGroupName?: String;
/**
* Specifies the id of the EC2 security group.
*/
EC2SecurityGroupId?: String;
/**
* Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
*/
EC2SecurityGroupOwnerId?: String;
}
export type EC2SecurityGroupList = EC2SecurityGroup[];
export interface Endpoint {
/**
* Specifies the DNS address of the DB instance.
*/
Address?: String;
/**
* Specifies the port that the database engine is listening on.
*/
Port?: Integer;
/**
* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
*/
HostedZoneId?: String;
}
export interface EngineDefaults {
/**
* Specifies the name of the DB parameter group family that the engine default parameters apply to.
*/
DBParameterGroupFamily?: String;
/**
* An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
/**
* Contains a list of engine default parameters.
*/
Parameters?: ParametersList;
}
export type EngineFamily = "MYSQL"|"POSTGRESQL"|string;
export type EngineModeList = String[];
export interface Event {
/**
* Provides the identifier for the source of the event.
*/
SourceIdentifier?: String;
/**
* Specifies the source type for this event.
*/
SourceType?: SourceType;
/**
* Provides the text of this event.
*/
Message?: String;
/**
* Specifies the category for the event.
*/
EventCategories?: EventCategoriesList;
/**
* Specifies the date and time of the event.
*/
Date?: TStamp;
/**
* The Amazon Resource Name (ARN) for the event.
*/
SourceArn?: String;
}
export type EventCategoriesList = String[];
export interface EventCategoriesMap {
/**
* The source type that the returned categories belong to
*/
SourceType?: String;
/**
* The event categories for the specified source type
*/
EventCategories?: EventCategoriesList;
}
export type EventCategoriesMapList = EventCategoriesMap[];
export interface EventCategoriesMessage {
/**
* A list of EventCategoriesMap data types.
*/
EventCategoriesMapList?: EventCategoriesMapList;
}
export type EventList = Event[];
export interface EventSubscription {
/**
* The AWS customer account associated with the RDS event notification subscription.
*/
CustomerAwsId?: String;
/**
* The RDS event notification subscription Id.
*/
CustSubscriptionId?: String;
/**
* The topic ARN of the RDS event notification subscription.
*/
SnsTopicArn?: String;
/**
* The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
*/
Status?: String;
/**
* The time the RDS event notification subscription was created.
*/
SubscriptionCreationTime?: String;
/**
* The source type for the RDS event notification subscription.
*/
SourceType?: String;
/**
* A list of source IDs for the RDS event notification subscription.
*/
SourceIdsList?: SourceIdsList;
/**
* A list of event categories for the RDS event notification subscription.
*/
EventCategoriesList?: EventCategoriesList;
/**
* A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
*/
Enabled?: Boolean;
/**
* The Amazon Resource Name (ARN) for the event subscription.
*/
EventSubscriptionArn?: String;
}
export type EventSubscriptionsList = EventSubscription[];
export interface EventSubscriptionsMessage {
/**
* An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of EventSubscriptions data types.
*/
EventSubscriptionsList?: EventSubscriptionsList;
}
export interface EventsMessage {
/**
* An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
/**
* A list of Event instances.
*/
Events?: EventList;
}
export interface ExportTask {
/**
* A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
*/
ExportTaskIdentifier?: String;
/**
* The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
*/
SourceArn?: String;
/**
* The data exported from the snapshot. Valid values are the following: database - Export all the data from a specified database. database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
*/
ExportOnly?: StringList;
/**
* The time that the snapshot was created.
*/
SnapshotTime?: TStamp;
/**
* The time that the snapshot export task started.
*/
TaskStartTime?: TStamp;
/**
* The time that the snapshot export task completed.
*/
TaskEndTime?: TStamp;
/**
* The Amazon S3 bucket that the snapshot is exported to.
*/
S3Bucket?: String;
/**
* The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
*/
S3Prefix?: String;
/**
* The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
*/
IamRoleArn?: String;
/**
* The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
*/
KmsKeyId?: String;
/**
* The progress status of the export task.
*/
Status?: String;
/**
* The progress of the snapshot export task as a percentage.
*/
PercentProgress?: Integer;
/**
* The total amount of data exported, in gigabytes.
*/
TotalExtractedDataInGB?: Integer;
/**
* The reason the export failed, if it failed.
*/
FailureCause?: String;
/**
* A warning about the snapshot export task.
*/
WarningMessage?: String;
}
export type ExportTasksList = ExportTask[];
export interface ExportTasksMessage {
/**
* A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.
*/
Marker?: String;
/**
* Information about an export of a snapshot to Amazon S3.
*/
ExportTasks?: ExportTasksList;
}
export interface FailoverDBClusterMessage {
/**
* A DB cluster identifier to force a failover for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
*/
DBClusterIdentifier: String;
/**
* The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.
*/
TargetDBInstanceIdentifier?: String;
}
export interface FailoverDBClusterResult {
DBCluster?: DBCluster;
}
export type FeatureNameList = String[];
export interface Filter {
/**
* The name of the filter. Filter names are case-sensitive.
*/
Name: String;
/**
* One or more filter values. Filter values are case-sensitive.
*/
Values: FilterValueList;
}
export type FilterList = Filter[];
export type FilterValueList = String[];
export interface GlobalCluster {
/**
* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
*/
GlobalClusterIdentifier?: String;
/**
* The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
*/
GlobalClusterResourceId?: String;
/**
* The Amazon Resource Name (ARN) for the global database cluster.
*/
GlobalClusterArn?: String;
/**
* Specifies the current state of this global database cluster.
*/
Status?: String;
/**
* The Aurora database engine used by the global database cluster.
*/
Engine?: String;
/**
* Indicates the database engine version.
*/
EngineVersion?: String;
/**
* The default database name within the new global database cluster.
*/
DatabaseName?: String;
/**
* The storage encryption setting for the global database cluster.
*/
StorageEncrypted?: BooleanOptional;
/**
* The deletion protection setting for the new global database cluster.
*/
DeletionProtection?: BooleanOptional;
/**
* The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
*/
GlobalClusterMembers?: GlobalClusterMemberList;
}
export type GlobalClusterList = GlobalCluster[];
export interface GlobalClusterMember {
/**
* The Amazon Resource Name (ARN) for each Aurora cluster.
*/
DBClusterArn?: String;
/**
* The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
*/
Readers?: ReadersArnList;
/**
* Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
*/
IsWriter?: Boolean;
/**
* Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
*/
GlobalWriteForwardingStatus?: WriteForwardingStatus;
}
export type GlobalClusterMemberList = GlobalClusterMember[];
export interface GlobalClustersMessage {
/**
* An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The list of global clusters returned by this request.
*/
GlobalClusters?: GlobalClusterList;
}
export type IAMAuthMode = "DISABLED"|"REQUIRED"|string;
export interface IPRange {
/**
* Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
*/
Status?: String;
/**
* Specifies the IP range.
*/
CIDRIP?: String;
}
export type IPRangeList = IPRange[];
export interface ImportInstallationMediaMessage {
/**
* The identifier of the custom Availability Zone (AZ) to import the installation media to.
*/
CustomAvailabilityZoneId: String;
/**
* The name of the database engine to be used for this instance. The list only includes supported DB engines that require an on-premises customer provided license. Valid Values: sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
*/
Engine: String;
/**
* The version number of the database engine to use. For a list of valid engine versions, call DescribeDBEngineVersions. The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
*/
EngineVersion: String;
/**
* The path to the installation medium for the specified DB engine. Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso
*/
EngineInstallationMediaPath: String;
/**
* The path to the installation medium for the operating system associated with the specified DB engine. Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso
*/
OSInstallationMediaPath: String;
}
export interface InstallationMedia {
/**
* The installation medium ID.
*/
InstallationMediaId?: String;
/**
* The custom Availability Zone (AZ) that contains the installation media.
*/
CustomAvailabilityZoneId?: String;
/**
* The DB engine.
*/
Engine?: String;
/**
* The engine version of the DB engine.
*/
EngineVersion?: String;
/**
* The path to the installation medium for the DB engine.
*/
EngineInstallationMediaPath?: String;
/**
* The path to the installation medium for the operating system associated with the DB engine.
*/
OSInstallationMediaPath?: String;
/**
* The status of the installation medium.
*/
Status?: String;
/**
* If an installation media failure occurred, the cause of the failure.
*/
FailureCause?: InstallationMediaFailureCause;
}
export interface InstallationMediaFailureCause {
/**
* The reason that an installation media import failed.
*/
Message?: String;
}
export type InstallationMediaList = InstallationMedia[];
export interface InstallationMediaMessage {
/**
* An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The list of InstallationMedia objects for the AWS account.
*/
InstallationMedia?: InstallationMediaList;
}
export type Integer = number;
export type IntegerOptional = number;
export type KeyList = String[];
export interface ListTagsForResourceMessage {
/**
* The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
*/
ResourceName: String;
/**
* This parameter isn't currently supported.
*/
Filters?: FilterList;
}
export type LogTypeList = String[];
export type Long = number;
export type LongOptional = number;
export type MaxRecords = number;
export interface MinimumEngineVersionPerAllowedValue {
/**
* The allowed value for an option setting.
*/
AllowedValue?: String;
/**
* The minimum DB engine version required for the allowed value.
*/
MinimumEngineVersion?: String;
}
export type MinimumEngineVersionPerAllowedValueList = MinimumEngineVersionPerAllowedValue[];
export interface ModifyCertificatesMessage {
/**
* The new default certificate identifier to override the current one with. To determine the valid values, use the describe-certificates AWS CLI command or the DescribeCertificates API operation.
*/
CertificateIdentifier?: String;
/**
* A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.
*/
RemoveCustomerOverride?: BooleanOptional;
}
export interface ModifyCertificatesResult {
Certificate?: Certificate;
}
export interface ModifyCurrentDBClusterCapacityMessage {
/**
* The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB cluster.
*/
DBClusterIdentifier: String;
/**
* The DB cluster capacity. When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes. Constraints: For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.
*/
Capacity?: IntegerOptional;
/**
* The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Value must be from 10 through 600.
*/
SecondsBeforeTimeout?: IntegerOptional;
/**
* The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible. RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.
*/
TimeoutAction?: String;
}
export interface ModifyDBClusterEndpointMessage {
/**
* The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
*/
DBClusterEndpointIdentifier: String;
/**
* The type of the endpoint. One of: READER, WRITER, ANY.
*/
EndpointType?: String;
/**
* List of DB instance identifiers that are part of the custom endpoint group.
*/
StaticMembers?: StringList;
/**
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
*/
ExcludedMembers?: StringList;
}
export interface ModifyDBClusterMessage {
/**
* The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive. Constraints: This identifier must match the identifier of an existing DB cluster.
*/
DBClusterIdentifier: String;
/**
* The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2
*/
NewDBClusterIdentifier?: String;
/**
* A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. By default, this parameter is disabled.
*/
ApplyImmediately?: Boolean;
/**
* The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* The name of the DB cluster parameter group to use for the DB cluster.
*/
DBClusterParameterGroupName?: String;
/**
* A list of VPC security groups that the DB cluster will belong to.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The port number on which the DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
*/
Port?: IntegerOptional;
/**
* The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
*/
MasterUserPassword?: String;
/**
* A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
*/
OptionGroupName?: String;
/**
* The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
PreferredBackupWindow?: String;
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*/
BacktrackWindow?: LongOptional;
/**
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
*/
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
/**
* The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
*/
EngineVersion?: String;
/**
* A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
*/
AllowMajorVersionUpgrade?: Boolean;
/**
* The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB cluster. The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.
*/
DBInstanceParameterGroupName?: String;
/**
* The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
*/
ScalingConfiguration?: ScalingConfiguration;
/**
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
DeletionProtection?: BooleanOptional;
/**
* A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
*/
EnableHttpEndpoint?: BooleanOptional;
/**
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.
*/
EnableGlobalWriteForwarding?: BooleanOptional;
}
export interface ModifyDBClusterParameterGroupMessage {
/**
* The name of the DB cluster parameter group to modify.
*/
DBClusterParameterGroupName: String;
/**
* A list of parameters in the DB cluster parameter group to modify.
*/
Parameters: ParametersList;
}
export interface ModifyDBClusterResult {
DBCluster?: DBCluster;
}
export interface ModifyDBClusterSnapshotAttributeMessage {
/**
* The identifier for the DB cluster snapshot to modify the attributes for.
*/
DBClusterSnapshotIdentifier: String;
/**
* The name of the DB cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API action.
*/
AttributeName: String;
/**
* A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.
*/
ValuesToAdd?: AttributeValueList;
/**
* A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
*/
ValuesToRemove?: AttributeValueList;
}
export interface ModifyDBClusterSnapshotAttributeResult {
DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
}
export interface ModifyDBInstanceMessage {
/**
* The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier: String;
/**
* The new amount of storage (in gibibytes) to allocate for the DB instance. For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. For the valid values for allocated storage for each engine, see CreateDBInstance.
*/
AllocatedStorage?: IntegerOptional;
/**
* The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request. Default: Uses existing setting
*/
DBInstanceClass?: String;
/**
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
*/
DBSubnetGroupName?: String;
/**
* A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups.
*/
DBSecurityGroups?: DBSecurityGroupNameList;
/**
* A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled. If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
*/
ApplyImmediately?: Boolean;
/**
* The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
*/
MasterUserPassword?: String;
/**
* The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
*/
DBParameterGroupName?: String;
/**
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting Constraints: Must be a value from 0 to 35 Can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later Can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5 Can't be set to 0 if the DB instance is a source to read replicas
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the format hh24:mi-hh24:mi Must be in Universal Time Coordinated (UTC) Must not conflict with the preferred maintenance window Must be at least 30 minutes
*/
PreferredBackupWindow?: String;
/**
* The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Must be at least 30 minutes
*/
PreferredMaintenanceWindow?: String;
/**
* A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
*/
MultiAZ?: BooleanOptional;
/**
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is eanbled for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
*/
EngineVersion?: String;
/**
* A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
*/
AllowMajorVersionUpgrade?: Boolean;
/**
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
*/
LicenseModel?: String;
/**
* The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Default: Uses existing setting
*/
Iops?: IntegerOptional;
/**
* Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
*/
OptionGroupName?: String;
/**
* The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
*/
NewDBInstanceIdentifier?: String;
/**
* Specifies the storage type to be associated with the DB instance. If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance. Valid values: standard | gp2 | io1 Default: io1 if the Iops parameter is specified, otherwise gp2
*/
StorageType?: String;
/**
* The ARN from the key store with which to associate the instance for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* The password for the given ARN from the key store in order to access the device.
*/
TdeCredentialPassword?: String;
/**
* Indicates the certificate that needs to be associated with the instance.
*/
CACertificateIdentifier?: String;
/**
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
*/
Domain?: String;
/**
* A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
*/
MonitoringInterval?: IntegerOptional;
/**
* The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter. MySQL Default: 3306 Valid values: 1150-65535 MariaDB Default: 3306 Valid values: 1150-65535 PostgreSQL Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535
*/
DBPortNumber?: IntegerOptional;
/**
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
*/
PubliclyAccessible?: BooleanOptional;
/**
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
*/
MonitoringRoleArn?: String;
/**
* The name of the IAM role to use when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
*/
PromotionTier?: IntegerOptional;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
*/
EnablePerformanceInsights?: BooleanOptional;
/**
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
*/
PerformanceInsightsRetentionPeriod?: IntegerOptional;
/**
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
*/
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
*/
UseDefaultProcessorFeatures?: BooleanOptional;
/**
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
*/
DeletionProtection?: BooleanOptional;
/**
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
*/
MaxAllocatedStorage?: IntegerOptional;
/**
* A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
*/
CertificateRotationRestart?: BooleanOptional;
/**
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
*/
ReplicaMode?: ReplicaMode;
}
export interface ModifyDBInstanceResult {
DBInstance?: DBInstance;
}
export interface ModifyDBParameterGroupMessage {
/**
* The name of the DB parameter group. Constraints: If supplied, must match the name of an existing DBParameterGroup.
*/
DBParameterGroupName: String;
/**
* An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
*/
Parameters: ParametersList;
}
export interface ModifyDBProxyRequest {
/**
* The identifier for the DBProxy to modify.
*/
DBProxyName: String;
/**
* The new identifier for the DBProxy. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*/
NewDBProxyName?: String;
/**
* The new authentication settings for the DBProxy.
*/
Auth?: UserAuthConfigList;
/**
* Whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy, even if the associated database doesn't use TLS.
*/
RequireTLS?: BooleanOptional;
/**
* The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.
*/
IdleClientTimeout?: IntegerOptional;
/**
* Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
*/
DebugLogging?: BooleanOptional;
/**
* The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
*/
RoleArn?: String;
/**
* The new list of security groups for the DBProxy.
*/
SecurityGroups?: StringList;
}
export interface ModifyDBProxyResponse {
/**
* The DBProxy object representing the new settings for the proxy.
*/
DBProxy?: DBProxy;
}
export interface ModifyDBProxyTargetGroupRequest {
/**
* The name of the new target group to assign to the proxy.
*/
TargetGroupName: String;
/**
* The name of the new proxy to which to assign the target group.
*/
DBProxyName: String;
/**
* The settings that determine the size and behavior of the connection pool for the target group.
*/
ConnectionPoolConfig?: ConnectionPoolConfiguration;
/**
* The new name for the modified DBProxyTarget. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
*/
NewName?: String;
}
export interface ModifyDBProxyTargetGroupResponse {
/**
* The settings of the modified DBProxyTarget.
*/
DBProxyTargetGroup?: DBProxyTargetGroup;
}
export interface ModifyDBSnapshotAttributeMessage {
/**
* The identifier for the DB snapshot to modify the attributes for.
*/
DBSnapshotIdentifier: String;
/**
* The name of the DB snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API action.
*/
AttributeName: String;
/**
* A list of DB snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
*/
ValuesToAdd?: AttributeValueList;
/**
* A list of DB snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
*/
ValuesToRemove?: AttributeValueList;
}
export interface ModifyDBSnapshotAttributeResult {
DBSnapshotAttributesResult?: DBSnapshotAttributesResult;
}
export interface ModifyDBSnapshotMessage {
/**
* The identifier of the DB snapshot to modify.
*/
DBSnapshotIdentifier: String;
/**
* The engine version to upgrade the DB snapshot to. The following are the database engines and engine versions that are available when you upgrade a DB snapshot. MySQL 5.5.46 (supported for 5.1 DB snapshots) Oracle 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots) 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots) 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots) PostgreSQL For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS.
*/
EngineVersion?: String;
/**
* The option group to identify with the upgraded DB snapshot. You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.
*/
OptionGroupName?: String;
}
export interface ModifyDBSnapshotResult {
DBSnapshot?: DBSnapshot;
}
export interface ModifyDBSubnetGroupMessage {
/**
* The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
*/
DBSubnetGroupName: String;
/**
* The description for the DB subnet group.
*/
DBSubnetGroupDescription?: String;
/**
* The EC2 subnet IDs for the DB subnet group.
*/
SubnetIds: SubnetIdentifierList;
}
export interface ModifyDBSubnetGroupResult {
DBSubnetGroup?: DBSubnetGroup;
}
export interface ModifyEventSubscriptionMessage {
/**
* The name of the RDS event notification subscription.
*/
SubscriptionName: String;
/**
* The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
*/
SnsTopicArn?: String;
/**
* The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. If this value isn't specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
*/
SourceType?: String;
/**
* A list of event categories for a source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
*/
EventCategories?: EventCategoriesList;
/**
* A value that indicates whether to activate the subscription.
*/
Enabled?: BooleanOptional;
}
export interface ModifyEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface ModifyGlobalClusterMessage {
/**
* The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing global database cluster.
*/
GlobalClusterIdentifier?: String;
/**
* The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster2
*/
NewGlobalClusterIdentifier?: String;
/**
* Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.
*/
DeletionProtection?: BooleanOptional;
}
export interface ModifyGlobalClusterResult {
GlobalCluster?: GlobalCluster;
}
export interface ModifyOptionGroupMessage {
/**
* The name of the option group to be modified. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
*/
OptionGroupName: String;
/**
* Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
*/
OptionsToInclude?: OptionConfigurationList;
/**
* Options in this list are removed from the option group.
*/
OptionsToRemove?: OptionNamesList;
/**
* A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
*/
ApplyImmediately?: Boolean;
}
export interface ModifyOptionGroupResult {
OptionGroup?: OptionGroup;
}
export interface Option {
/**
* The name of the option.
*/
OptionName?: String;
/**
* The description of the option.
*/
OptionDescription?: String;
/**
* Indicate if this option is persistent.
*/
Persistent?: Boolean;
/**
* Indicate if this option is permanent.
*/
Permanent?: Boolean;
/**
* If required, the port configured for this option to use.
*/
Port?: IntegerOptional;
/**
* The version of the option.
*/
OptionVersion?: String;
/**
* The option settings for this option.
*/
OptionSettings?: OptionSettingConfigurationList;
/**
* If the option requires access to a port, then this DB security group allows access to the port.
*/
DBSecurityGroupMemberships?: DBSecurityGroupMembershipList;
/**
* If the option requires access to a port, then this VPC security group allows access to the port.
*/
VpcSecurityGroupMemberships?: VpcSecurityGroupMembershipList;
}
export interface OptionConfiguration {
/**
* The configuration of options to include in a group.
*/
OptionName: String;
/**
* The optional port for the option.
*/
Port?: IntegerOptional;
/**
* The version for the option.
*/
OptionVersion?: String;
/**
* A list of DBSecurityGroupMembership name strings used for this option.
*/
DBSecurityGroupMemberships?: DBSecurityGroupNameList;
/**
* A list of VpcSecurityGroupMembership name strings used for this option.
*/
VpcSecurityGroupMemberships?: VpcSecurityGroupIdList;
/**
* The option settings to include in an option group.
*/
OptionSettings?: OptionSettingsList;
}
export type OptionConfigurationList = OptionConfiguration[];
export interface OptionGroup {
/**
* Specifies the name of the option group.
*/
OptionGroupName?: String;
/**
* Provides a description of the option group.
*/
OptionGroupDescription?: String;
/**
* Indicates the name of the engine that this option group can be applied to.
*/
EngineName?: String;
/**
* Indicates the major engine version associated with this option group.
*/
MajorEngineVersion?: String;
/**
* Indicates what options are available in the option group.
*/
Options?: OptionsList;
/**
* Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
*/
AllowsVpcAndNonVpcInstanceMemberships?: Boolean;
/**
* If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
*/
VpcId?: String;
/**
* The Amazon Resource Name (ARN) for the option group.
*/
OptionGroupArn?: String;
}
export interface OptionGroupMembership {
/**
* The name of the option group that the instance belongs to.
*/
OptionGroupName?: String;
/**
* The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.
*/
Status?: String;
}
export type OptionGroupMembershipList = OptionGroupMembership[];
export interface OptionGroupOption {
/**
* The name of the option.
*/
Name?: String;
/**
* The description of the option.
*/
Description?: String;
/**
* The name of the engine that this option can be applied to.
*/
EngineName?: String;
/**
* Indicates the major engine version that the option is available for.
*/
MajorEngineVersion?: String;
/**
* The minimum required engine version for the option to be applied.
*/
MinimumRequiredMinorEngineVersion?: String;
/**
* Specifies whether the option requires a port.
*/
PortRequired?: Boolean;
/**
* If the option requires a port, specifies the default port for the option.
*/
DefaultPort?: IntegerOptional;
/**
* The options that are prerequisites for this option.
*/
OptionsDependedOn?: OptionsDependedOn;
/**
* The options that conflict with this option.
*/
OptionsConflictsWith?: OptionsConflictsWith;
/**
* Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
*/
Persistent?: Boolean;
/**
* Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
*/
Permanent?: Boolean;
/**
* If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
*/
RequiresAutoMinorEngineVersionUpgrade?: Boolean;
/**
* If true, you can only use this option with a DB instance that is in a VPC.
*/
VpcOnly?: Boolean;
/**
* If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
*/
SupportsOptionVersionDowngrade?: BooleanOptional;
/**
* The option settings that are available (and the default value) for each option in an option group.
*/
OptionGroupOptionSettings?: OptionGroupOptionSettingsList;
/**
* The versions that are available for the option.
*/
OptionGroupOptionVersions?: OptionGroupOptionVersionsList;
}
export interface OptionGroupOptionSetting {
/**
* The name of the option group option.
*/
SettingName?: String;
/**
* The description of the option group option.
*/
SettingDescription?: String;
/**
* The default value for the option group option.
*/
DefaultValue?: String;
/**
* The DB engine specific parameter type for the option group option.
*/
ApplyType?: String;
/**
* Indicates the acceptable values for the option group option.
*/
AllowedValues?: String;
/**
* Boolean value where true indicates that this option group option can be changed from the default value.
*/
IsModifiable?: Boolean;
/**
* Boolean value where true indicates that a value must be specified for this option setting of the option group option.
*/
IsRequired?: Boolean;
/**
* The minimum DB engine version required for the corresponding allowed value for this option setting.
*/
MinimumEngineVersionPerAllowedValue?: MinimumEngineVersionPerAllowedValueList;
}
export type OptionGroupOptionSettingsList = OptionGroupOptionSetting[];
export type OptionGroupOptionVersionsList = OptionVersion[];
export type OptionGroupOptionsList = OptionGroupOption[];
export interface OptionGroupOptionsMessage {
OptionGroupOptions?: OptionGroupOptionsList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface OptionGroups {
/**
* List of option groups.
*/
OptionGroupsList?: OptionGroupsList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export type OptionGroupsList = OptionGroup[];
export type OptionNamesList = String[];
export interface OptionSetting {
/**
* The name of the option that has settings that you can set.
*/
Name?: String;
/**
* The current value of the option setting.
*/
Value?: String;
/**
* The default value of the option setting.
*/
DefaultValue?: String;
/**
* The description of the option setting.
*/
Description?: String;
/**
* The DB engine specific parameter type.
*/
ApplyType?: String;
/**
* The data type of the option setting.
*/
DataType?: String;
/**
* The allowed values of the option setting.
*/
AllowedValues?: String;
/**
* A Boolean value that, when true, indicates the option setting can be modified from the default.
*/
IsModifiable?: Boolean;
/**
* Indicates if the option setting is part of a collection.
*/
IsCollection?: Boolean;
}
export type OptionSettingConfigurationList = OptionSetting[];
export type OptionSettingsList = OptionSetting[];
export interface OptionVersion {
/**
* The version of the option.
*/
Version?: String;
/**
* True if the version is the default version of the option, and otherwise false.
*/
IsDefault?: Boolean;
}
export type OptionsConflictsWith = String[];
export type OptionsDependedOn = String[];
export type OptionsList = Option[];
export interface OrderableDBInstanceOption {
/**
* The engine type of a DB instance.
*/
Engine?: String;
/**
* The engine version of a DB instance.
*/
EngineVersion?: String;
/**
* The DB instance class for a DB instance.
*/
DBInstanceClass?: String;
/**
* The license model for a DB instance.
*/
LicenseModel?: String;
/**
* The Availability Zone group for a DB instance.
*/
AvailabilityZoneGroup?: String;
/**
* A list of Availability Zones for a DB instance.
*/
AvailabilityZones?: AvailabilityZoneList;
/**
* Indicates whether a DB instance is Multi-AZ capable.
*/
MultiAZCapable?: Boolean;
/**
* Indicates whether a DB instance can have a read replica.
*/
ReadReplicaCapable?: Boolean;
/**
* Indicates whether a DB instance is in a VPC.
*/
Vpc?: Boolean;
/**
* Indicates whether a DB instance supports encrypted storage.
*/
SupportsStorageEncryption?: Boolean;
/**
* Indicates the storage type for a DB instance.
*/
StorageType?: String;
/**
* Indicates whether a DB instance supports provisioned IOPS.
*/
SupportsIops?: Boolean;
/**
* Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
*/
SupportsEnhancedMonitoring?: Boolean;
/**
* Indicates whether a DB instance supports IAM database authentication.
*/
SupportsIAMDatabaseAuthentication?: Boolean;
/**
* True if a DB instance supports Performance Insights, otherwise false.
*/
SupportsPerformanceInsights?: Boolean;
/**
* Minimum storage size for a DB instance.
*/
MinStorageSize?: IntegerOptional;
/**
* Maximum storage size for a DB instance.
*/
MaxStorageSize?: IntegerOptional;
/**
* Minimum total provisioned IOPS for a DB instance.
*/
MinIopsPerDbInstance?: IntegerOptional;
/**
* Maximum total provisioned IOPS for a DB instance.
*/
MaxIopsPerDbInstance?: IntegerOptional;
/**
* Minimum provisioned IOPS per GiB for a DB instance.
*/
MinIopsPerGib?: DoubleOptional;
/**
* Maximum provisioned IOPS per GiB for a DB instance.
*/
MaxIopsPerGib?: DoubleOptional;
/**
* A list of the available processor features for the DB instance class of a DB instance.
*/
AvailableProcessorFeatures?: AvailableProcessorFeatureList;
/**
* A list of the supported DB engine modes. global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode.
*/
SupportedEngineModes?: EngineModeList;
/**
* Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
*/
SupportsStorageAutoscaling?: BooleanOptional;
/**
* Whether a DB instance supports Kerberos Authentication.
*/
SupportsKerberosAuthentication?: BooleanOptional;
/**
* Whether a DB instance supports RDS on Outposts. For more information about RDS on Outposts, see Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
*/
OutpostCapable?: Boolean;
/**
* A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
*/
SupportsGlobalDatabases?: Boolean;
}
export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[];
export interface OrderableDBInstanceOptionsMessage {
/**
* An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
*/
OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList;
/**
* An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
*/
Marker?: String;
}
export interface Outpost {
/**
* The Amazon Resource Name (ARN) of the Outpost.
*/
Arn?: String;
}
export interface Parameter {
/**
* Specifies the name of the parameter.
*/
ParameterName?: String;
/**
* Specifies the value of the parameter.
*/
ParameterValue?: String;
/**
* Provides a description of the parameter.
*/
Description?: String;
/**
* Indicates the source of the parameter value.
*/
Source?: String;
/**
* Specifies the engine specific parameters type.
*/
ApplyType?: String;
/**
* Specifies the valid data type for the parameter.
*/
DataType?: String;
/**
* Specifies the valid range of values for the parameter.
*/
AllowedValues?: String;
/**
* Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
*/
IsModifiable?: Boolean;
/**
* The earliest engine version to which the parameter can apply.
*/
MinimumEngineVersion?: String;
/**
* Indicates when to apply parameter updates.
*/
ApplyMethod?: ApplyMethod;
/**
* The valid DB engine modes.
*/
SupportedEngineModes?: EngineModeList;
}
export type ParametersList = Parameter[];
export interface PendingCloudwatchLogsExports {
/**
* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
*/
LogTypesToEnable?: LogTypeList;
/**
* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
*/
LogTypesToDisable?: LogTypeList;
}
export interface PendingMaintenanceAction {
/**
* The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, hardware-maintenance, and ca-certificate-rotation.
*/
Action?: String;
/**
* The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
*/
AutoAppliedAfterDate?: TStamp;
/**
* The date when the maintenance action is automatically applied. On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
*/
ForcedApplyDate?: TStamp;
/**
* Indicates the type of opt-in request that has been received for the resource.
*/
OptInStatus?: String;
/**
* The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
*/
CurrentApplyDate?: TStamp;
/**
* A description providing more detail about the maintenance action.
*/
Description?: String;
}
export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
export interface PendingMaintenanceActionsMessage {
/**
* A list of the pending maintenance actions for the resource.
*/
PendingMaintenanceActions?: PendingMaintenanceActions;
/**
* An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
*/
Marker?: String;
}
export interface PendingModifiedValues {
/**
* Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
*/
DBInstanceClass?: String;
/**
* Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
*/
AllocatedStorage?: IntegerOptional;
/**
* Contains the pending or currently-in-progress change of the master credentials for the DB instance.
*/
MasterUserPassword?: String;
/**
* Specifies the pending port for the DB instance.
*/
Port?: IntegerOptional;
/**
* Specifies the pending number of days for which automated backups are retained.
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
*/
MultiAZ?: BooleanOptional;
/**
* Indicates the database engine version.
*/
EngineVersion?: String;
/**
* The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
*/
LicenseModel?: String;
/**
* Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
*/
Iops?: IntegerOptional;
/**
* Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
*/
DBInstanceIdentifier?: String;
/**
* Specifies the storage type to be associated with the DB instance.
*/
StorageType?: String;
/**
* Specifies the identifier of the CA certificate for the DB instance.
*/
CACertificateIdentifier?: String;
/**
* The new DB subnet group for the DB instance.
*/
DBSubnetGroupName?: String;
PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
}
export interface ProcessorFeature {
/**
* The name of the processor feature. Valid names are coreCount and threadsPerCore.
*/
Name?: String;
/**
* The value of a processor feature name.
*/
Value?: String;
}
export type ProcessorFeatureList = ProcessorFeature[];
export interface PromoteReadReplicaDBClusterMessage {
/**
* The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DB cluster read replica. Example: my-cluster-replica1
*/
DBClusterIdentifier: String;
}
export interface PromoteReadReplicaDBClusterResult {
DBCluster?: DBCluster;
}
export interface PromoteReadReplicaMessage {
/**
* The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing read replica DB instance. Example: mydbinstance
*/
DBInstanceIdentifier: String;
/**
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints: Must be a value from 0 to 35. Can't be set to 0 if the DB instance is a source to read replicas.
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
PreferredBackupWindow?: String;
}
export interface PromoteReadReplicaResult {
DBInstance?: DBInstance;
}
export interface PurchaseReservedDBInstancesOfferingMessage {
/**
* The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
ReservedDBInstancesOfferingId: String;
/**
* Customer-specified identifier to track this reservation. Example: myreservationID
*/
ReservedDBInstanceId?: String;
/**
* The number of instances to reserve. Default: 1
*/
DBInstanceCount?: IntegerOptional;
Tags?: TagList;
}
export interface PurchaseReservedDBInstancesOfferingResult {
ReservedDBInstance?: ReservedDBInstance;
}
export interface Range {
/**
* The minimum value in the range.
*/
From?: Integer;
/**
* The maximum value in the range.
*/
To?: Integer;
/**
* The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
*/
Step?: IntegerOptional;
}
export type RangeList = Range[];
export type ReadReplicaDBClusterIdentifierList = String[];
export type ReadReplicaDBInstanceIdentifierList = String[];
export type ReadReplicaIdentifierList = String[];
export type ReadersArnList = String[];
export interface RebootDBInstanceMessage {
/**
* The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier: String;
/**
* A value that indicates whether the reboot is conducted through a Multi-AZ failover. Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
*/
ForceFailover?: BooleanOptional;
}
export interface RebootDBInstanceResult {
DBInstance?: DBInstance;
}
export interface RecurringCharge {
/**
* The amount of the recurring charge.
*/
RecurringChargeAmount?: Double;
/**
* The frequency of the recurring charge.
*/
RecurringChargeFrequency?: String;
}
export type RecurringChargeList = RecurringCharge[];
export interface RegisterDBProxyTargetsRequest {
/**
* The identifier of the DBProxy that is associated with the DBProxyTargetGroup.
*/
DBProxyName: String;
/**
* The identifier of the DBProxyTargetGroup.
*/
TargetGroupName?: String;
/**
* One or more DB instance identifiers.
*/
DBInstanceIdentifiers?: StringList;
/**
* One or more DB cluster identifiers.
*/
DBClusterIdentifiers?: StringList;
}
export interface RegisterDBProxyTargetsResponse {
/**
* One or more DBProxyTarget objects that are created when you register targets with a target group.
*/
DBProxyTargets?: TargetList;
}
export interface RemoveFromGlobalClusterMessage {
/**
* The cluster identifier to detach from the Aurora global database cluster.
*/
GlobalClusterIdentifier?: String;
/**
* The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.
*/
DbClusterIdentifier?: String;
}
export interface RemoveFromGlobalClusterResult {
GlobalCluster?: GlobalCluster;
}
export interface RemoveRoleFromDBClusterMessage {
/**
* The name of the DB cluster to disassociate the IAM role from.
*/
DBClusterIdentifier: String;
/**
* The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
*/
RoleArn: String;
/**
* The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.
*/
FeatureName?: String;
}
export interface RemoveRoleFromDBInstanceMessage {
/**
* The name of the DB instance to disassociate the IAM role from.
*/
DBInstanceIdentifier: String;
/**
* The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
*/
RoleArn: String;
/**
* The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.
*/
FeatureName: String;
}
export interface RemoveSourceIdentifierFromSubscriptionMessage {
/**
* The name of the RDS event notification subscription you want to remove a source identifier from.
*/
SubscriptionName: String;
/**
* The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
*/
SourceIdentifier: String;
}
export interface RemoveSourceIdentifierFromSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface RemoveTagsFromResourceMessage {
/**
* The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
*/
ResourceName: String;
/**
* The tag key (name) of the tag to be removed.
*/
TagKeys: KeyList;
}
export type ReplicaMode = "open-read-only"|"mounted"|string;
export interface ReservedDBInstance {
/**
* The unique identifier for the reservation.
*/
ReservedDBInstanceId?: String;
/**
* The offering identifier.
*/
ReservedDBInstancesOfferingId?: String;
/**
* The DB instance class for the reserved DB instance.
*/
DBInstanceClass?: String;
/**
* The time the reservation started.
*/
StartTime?: TStamp;
/**
* The duration of the reservation in seconds.
*/
Duration?: Integer;
/**
* The fixed price charged for this reserved DB instance.
*/
FixedPrice?: Double;
/**
* The hourly price charged for this reserved DB instance.
*/
UsagePrice?: Double;
/**
* The currency code for the reserved DB instance.
*/
CurrencyCode?: String;
/**
* The number of reserved DB instances.
*/
DBInstanceCount?: Integer;
/**
* The description of the reserved DB instance.
*/
ProductDescription?: String;
/**
* The offering type of this reserved DB instance.
*/
OfferingType?: String;
/**
* Indicates if the reservation applies to Multi-AZ deployments.
*/
MultiAZ?: Boolean;
/**
* The state of the reserved DB instance.
*/
State?: String;
/**
* The recurring price charged to run this reserved DB instance.
*/
RecurringCharges?: RecurringChargeList;
/**
* The Amazon Resource Name (ARN) for the reserved DB instance.
*/
ReservedDBInstanceArn?: String;
/**
* The unique identifier for the lease associated with the reserved DB instance. AWS Support might request the lease ID for an issue related to a reserved DB instance.
*/
LeaseId?: String;
}
export type ReservedDBInstanceList = ReservedDBInstance[];
export interface ReservedDBInstanceMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of reserved DB instances.
*/
ReservedDBInstances?: ReservedDBInstanceList;
}
export interface ReservedDBInstancesOffering {
/**
* The offering identifier.
*/
ReservedDBInstancesOfferingId?: String;
/**
* The DB instance class for the reserved DB instance.
*/
DBInstanceClass?: String;
/**
* The duration of the offering in seconds.
*/
Duration?: Integer;
/**
* The fixed price charged for this offering.
*/
FixedPrice?: Double;
/**
* The hourly price charged for this offering.
*/
UsagePrice?: Double;
/**
* The currency code for the reserved DB instance offering.
*/
CurrencyCode?: String;
/**
* The database engine used by the offering.
*/
ProductDescription?: String;
/**
* The offering type.
*/
OfferingType?: String;
/**
* Indicates if the offering applies to Multi-AZ deployments.
*/
MultiAZ?: Boolean;
/**
* The recurring price charged to run this reserved DB instance.
*/
RecurringCharges?: RecurringChargeList;
}
export type ReservedDBInstancesOfferingList = ReservedDBInstancesOffering[];
export interface ReservedDBInstancesOfferingMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of reserved DB instance offerings.
*/
ReservedDBInstancesOfferings?: ReservedDBInstancesOfferingList;
}
export interface ResetDBClusterParameterGroupMessage {
/**
* The name of the DB cluster parameter group to reset.
*/
DBClusterParameterGroupName: String;
/**
* A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
*/
ResetAllParameters?: Boolean;
/**
* A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.
*/
Parameters?: ParametersList;
}
export interface ResetDBParameterGroupMessage {
/**
* The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup.
*/
DBParameterGroupName: String;
/**
* A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.
*/
ResetAllParameters?: Boolean;
/**
* To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request. MySQL Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. MariaDB Valid Values (for Apply method): immediate | pending-reboot You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots. Oracle Valid Values (for Apply method): pending-reboot
*/
Parameters?: ParametersList;
}
export interface ResourcePendingMaintenanceActions {
/**
* The ARN of the resource that has pending maintenance actions.
*/
ResourceIdentifier?: String;
/**
* A list that provides details about the pending maintenance actions for the resource.
*/
PendingMaintenanceActionDetails?: PendingMaintenanceActionDetails;
}
export interface RestoreDBClusterFromS3Message {
/**
* A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
*/
CharacterSetName?: String;
/**
* The database name for the restored DB cluster.
*/
DatabaseName?: String;
/**
* The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: my-cluster1
*/
DBClusterIdentifier: String;
/**
* The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
*/
DBClusterParameterGroupName?: String;
/**
* A list of EC2 VPC security groups to associate with the restored DB cluster.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
*/
Engine: String;
/**
* The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7
*/
EngineVersion?: String;
/**
* The port number on which the instances in the restored DB cluster accept connections. Default: 3306
*/
Port?: IntegerOptional;
/**
* The name of the master user for the restored DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
*/
MasterUsername: String;
/**
* The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
*/
MasterUserPassword: String;
/**
* A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
*/
OptionGroupName?: String;
/**
* The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
PreferredBackupWindow?: String;
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
Tags?: TagList;
/**
* A value that indicates whether the restored DB cluster is encrypted.
*/
StorageEncrypted?: BooleanOptional;
/**
* The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: mysql
*/
SourceEngine: String;
/**
* The version of the database that the backup files were created from. MySQL versions 5.5, 5.6, and 5.7 are supported. Example: 5.6.40, 5.7.28
*/
SourceEngineVersion: String;
/**
* The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
*/
S3BucketName: String;
/**
* The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
*/
S3Prefix?: String;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
*/
S3IngestionRoleArn: String;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*/
BacktrackWindow?: LongOptional;
/**
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
DeletionProtection?: BooleanOptional;
/**
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
}
export interface RestoreDBClusterFromS3Result {
DBCluster?: DBCluster;
}
export interface RestoreDBClusterFromSnapshotMessage {
/**
* Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
*/
DBClusterIdentifier: String;
/**
* The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: Must match the identifier of an existing Snapshot.
*/
SnapshotIdentifier: String;
/**
* The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source
*/
Engine: String;
/**
* The version of the database engine to use for the new DB cluster. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-postgresql, use the following command: aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion" If you aren't using the default engine version, then you must specify the engine version. Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7
*/
EngineVersion?: String;
/**
* The port number on which the new DB cluster accepts connections. Constraints: This value must be 1150-65535 Default: The same port as the original DB cluster.
*/
Port?: IntegerOptional;
/**
* The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DB subnet group. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* The database name for the restored DB cluster.
*/
DatabaseName?: String;
/**
* The name of the option group to use for the restored DB cluster.
*/
OptionGroupName?: String;
/**
* A list of VPC security groups that the new DB cluster will belong to.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The tags to be assigned to the restored DB cluster.
*/
Tags?: TagList;
/**
* The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
*/
KmsKeyId?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*/
BacktrackWindow?: LongOptional;
/**
* The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
*/
EngineMode?: String;
/**
* For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
*/
ScalingConfiguration?: ScalingConfiguration;
/**
* The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing default DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
*/
DBClusterParameterGroupName?: String;
/**
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
DeletionProtection?: BooleanOptional;
/**
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
}
export interface RestoreDBClusterFromSnapshotResult {
DBCluster?: DBCluster;
}
export interface RestoreDBClusterToPointInTimeMessage {
/**
* The name of the new DB cluster to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
*/
DBClusterIdentifier: String;
/**
* The type of restore to be performed. You can specify one of the following values: full-copy - The new DB cluster is restored as a full copy of the source DB cluster. copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11. If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
*/
RestoreType?: String;
/**
* The identifier of the source DB cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster.
*/
SourceDBClusterIdentifier: String;
/**
* The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Must be specified if UseLatestRestorableTime parameter isn't provided Can't be specified if the UseLatestRestorableTime parameter is enabled Can't be specified if the RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z
*/
RestoreToTime?: TStamp;
/**
* A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time. Constraints: Can't be specified if RestoreToTime parameter is provided.
*/
UseLatestRestorableTime?: Boolean;
/**
* The port number on which the new DB cluster accepts connections. Constraints: A value from 1150-65535. Default: The default port for the engine.
*/
Port?: IntegerOptional;
/**
* The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* The name of the option group for the new DB cluster.
*/
OptionGroupName?: String;
/**
* A list of VPC security groups that the new DB cluster belongs to.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
Tags?: TagList;
/**
* The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter. If you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted. If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
*/
KmsKeyId?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours).
*/
BacktrackWindow?: LongOptional;
/**
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
*/
DBClusterParameterGroupName?: String;
/**
* A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
*/
DeletionProtection?: BooleanOptional;
/**
* A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
}
export interface RestoreDBClusterToPointInTimeResult {
DBCluster?: DBCluster;
}
export interface RestoreDBInstanceFromDBSnapshotMessage {
/**
* Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive. Constraints: Must contain from 1 to 63 numbers, letters, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-snapshot-id
*/
DBInstanceIdentifier: String;
/**
* The identifier for the DB snapshot to restore from. Constraints: Must match the identifier of an existing DBSnapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
*/
DBSnapshotIdentifier: String;
/**
* The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
*/
DBInstanceClass?: String;
/**
* The port number on which the database accepts connections. Default: The same port as the original DB instance Constraints: Value must be 1150-65535
*/
Port?: IntegerOptional;
/**
* The Availability Zone (AZ) where the DB instance will be created. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: us-east-1a
*/
AvailabilityZone?: String;
/**
* The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
*/
MultiAZ?: BooleanOptional;
/**
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
*/
PubliclyAccessible?: BooleanOptional;
/**
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
*/
LicenseModel?: String;
/**
* The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
*/
DBName?: String;
/**
* The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
*/
Engine?: String;
/**
* Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts. The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: Must be an integer greater than 1000.
*/
Iops?: IntegerOptional;
/**
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
*/
OptionGroupName?: String;
Tags?: TagList;
/**
* Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2
*/
StorageType?: String;
/**
* The ARN from the key store with which to associate the instance for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* The password for the given ARN from the key store in order to access the device.
*/
TdeCredentialPassword?: String;
/**
* A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
*/
Domain?: String;
/**
* A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
*/
UseDefaultProcessorFeatures?: BooleanOptional;
/**
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
*/
DBParameterGroupName?: String;
/**
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
*/
DeletionProtection?: BooleanOptional;
}
export interface RestoreDBInstanceFromDBSnapshotResult {
DBInstance?: DBInstance;
}
export interface RestoreDBInstanceFromS3Message {
/**
* The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
*/
DBName?: String;
/**
* The DB instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
*/
DBInstanceIdentifier: String;
/**
* The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
*/
AllocatedStorage?: IntegerOptional;
/**
* The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
*/
DBInstanceClass: String;
/**
* The name of the database engine to be used for this instance. Valid Values: mysql
*/
Engine: String;
/**
* The name for the master user. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can't be a reserved word for the chosen database engine.
*/
MasterUsername?: String;
/**
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.
*/
MasterUserPassword?: String;
/**
* A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
*/
DBSecurityGroups?: DBSecurityGroupNameList;
/**
* A list of VPC security groups to associate with this DB instance.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
*/
AvailabilityZone?: String;
/**
* A DB subnet group to associate with this DB instance.
*/
DBSubnetGroupName?: String;
/**
* The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred backup window. Must be at least 30 minutes.
*/
PreferredMaintenanceWindow?: String;
/**
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.
*/
DBParameterGroupName?: String;
/**
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide. Constraints: Must be in the format hh24:mi-hh24:mi. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
PreferredBackupWindow?: String;
/**
* The port number on which the database accepts connections. Type: Integer Valid Values: 1150-65535 Default: 3306
*/
Port?: IntegerOptional;
/**
* A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.
*/
MultiAZ?: BooleanOptional;
/**
* The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
*/
EngineVersion?: String;
/**
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The license model for this DB instance. Use general-public-license.
*/
LicenseModel?: String;
/**
* The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
*/
Iops?: IntegerOptional;
/**
* The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
*/
OptionGroupName?: String;
/**
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
*/
PubliclyAccessible?: BooleanOptional;
/**
* A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
*/
Tags?: TagList;
/**
* Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise gp2
*/
StorageType?: String;
/**
* A value that indicates whether the new DB instance is encrypted or not.
*/
StorageEncrypted?: BooleanOptional;
/**
* The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
KmsKeyId?: String;
/**
* A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
*/
CopyTagsToSnapshot?: BooleanOptional;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60 Default: 0
*/
MonitoringInterval?: IntegerOptional;
/**
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
*/
MonitoringRoleArn?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The name of the engine of your source database. Valid Values: mysql
*/
SourceEngine: String;
/**
* The version of the database that the backup files were created from. MySQL versions 5.6 and 5.7 are supported. Example: 5.6.40
*/
SourceEngineVersion: String;
/**
* The name of your Amazon S3 bucket that contains your database backup file.
*/
S3BucketName: String;
/**
* The prefix of your Amazon S3 bucket.
*/
S3Prefix?: String;
/**
* An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
*/
S3IngestionRoleArn: String;
/**
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
*/
EnablePerformanceInsights?: BooleanOptional;
/**
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
*/
PerformanceInsightsRetentionPeriod?: IntegerOptional;
/**
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
*/
UseDefaultProcessorFeatures?: BooleanOptional;
/**
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
*/
DeletionProtection?: BooleanOptional;
/**
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
*/
MaxAllocatedStorage?: IntegerOptional;
}
export interface RestoreDBInstanceFromS3Result {
DBInstance?: DBInstance;
}
export interface RestoreDBInstanceToPointInTimeMessage {
/**
* The identifier of the source DB instance from which to restore. Constraints: Must match the identifier of an existing DB instance.
*/
SourceDBInstanceIdentifier?: String;
/**
* The name of the new DB instance to be created. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
*/
TargetDBInstanceIdentifier: String;
/**
* The date and time to restore from. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: Must be before the latest restorable time for the DB instance Can't be specified if the UseLatestRestorableTime parameter is enabled Example: 2009-09-07T23:45:00Z
*/
RestoreTime?: TStamp;
/**
* A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: Can't be specified if the RestoreTime parameter is provided.
*/
UseLatestRestorableTime?: Boolean;
/**
* The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. Default: The same DBInstanceClass as the original DB instance.
*/
DBInstanceClass?: String;
/**
* The port number on which the database accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB instance.
*/
Port?: IntegerOptional;
/**
* The Availability Zone (AZ) where the DB instance will be created. Default: A random, system-chosen Availability Zone. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. Example: us-east-1a
*/
AvailabilityZone?: String;
/**
* The DB subnet group name to use for the new instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
*/
MultiAZ?: BooleanOptional;
/**
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
*/
PubliclyAccessible?: BooleanOptional;
/**
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
*/
LicenseModel?: String;
/**
* The database name for the restored DB instance. This parameter isn't used for the MySQL or MariaDB engines.
*/
DBName?: String;
/**
* The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
*/
Engine?: String;
/**
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000. SQL Server Setting the IOPS value for the SQL Server database engine isn't supported.
*/
Iops?: IntegerOptional;
/**
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
*/
OptionGroupName?: String;
/**
* A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
*/
CopyTagsToSnapshot?: BooleanOptional;
Tags?: TagList;
/**
* Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2
*/
StorageType?: String;
/**
* The ARN from the key store with which to associate the instance for TDE encryption.
*/
TdeCredentialArn?: String;
/**
* The password for the given ARN from the key store in order to access the device.
*/
TdeCredentialPassword?: String;
/**
* A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
*/
Domain?: String;
/**
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
*/
DomainIAMRoleName?: String;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
*/
ProcessorFeatures?: ProcessorFeatureList;
/**
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
*/
UseDefaultProcessorFeatures?: BooleanOptional;
/**
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
*/
DBParameterGroupName?: String;
/**
* A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
*/
DeletionProtection?: BooleanOptional;
/**
* The resource ID of the source DB instance from which to restore.
*/
SourceDbiResourceId?: String;
/**
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
*/
MaxAllocatedStorage?: IntegerOptional;
}
export interface RestoreDBInstanceToPointInTimeResult {
DBInstance?: DBInstance;
}
export interface RestoreWindow {
/**
* The earliest time you can restore an instance to.
*/
EarliestTime?: TStamp;
/**
* The latest time you can restore an instance to.
*/
LatestTime?: TStamp;
}
export interface RevokeDBSecurityGroupIngressMessage {
/**
* The name of the DB security group to revoke ingress from.
*/
DBSecurityGroupName: String;
/**
* The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.
*/
CIDRIP?: String;
/**
* The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
*/
EC2SecurityGroupName?: String;
/**
* The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
*/
EC2SecurityGroupId?: String;
/**
* The AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.
*/
EC2SecurityGroupOwnerId?: String;
}
export interface RevokeDBSecurityGroupIngressResult {
DBSecurityGroup?: DBSecurityGroup;
}
export interface ScalingConfiguration {
/**
* The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
*/
MinCapacity?: IntegerOptional;
/**
* The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
*/
MaxCapacity?: IntegerOptional;
/**
* A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
*/
AutoPause?: BooleanOptional;
/**
* The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
*/
SecondsUntilAutoPause?: IntegerOptional;
/**
* The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.
*/
TimeoutAction?: String;
}
export interface ScalingConfigurationInfo {
/**
* The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
*/
MinCapacity?: IntegerOptional;
/**
* The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
*/
MaxCapacity?: IntegerOptional;
/**
* A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode. When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.
*/
AutoPause?: BooleanOptional;
/**
* The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
*/
SecondsUntilAutoPause?: IntegerOptional;
/**
* The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.
*/
TimeoutAction?: String;
}
export type SourceIdsList = String[];
export interface SourceRegion {
/**
* The name of the source AWS Region.
*/
RegionName?: String;
/**
* The endpoint for the source AWS Region endpoint.
*/
Endpoint?: String;
/**
* The status of the source AWS Region.
*/
Status?: String;
}
export type SourceRegionList = SourceRegion[];
export interface SourceRegionMessage {
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a read replica or a DB snapshot from.
*/
SourceRegions?: SourceRegionList;
}
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
export interface StartActivityStreamRequest {
/**
* The Amazon Resource Name (ARN) of the DB cluster, for example arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
*/
ResourceArn: String;
/**
* Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
*/
Mode: ActivityStreamMode;
/**
* The AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier can be either a key ID, a key ARN, or a key alias.
*/
KmsKeyId: String;
/**
* Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.
*/
ApplyImmediately?: BooleanOptional;
}
export interface StartActivityStreamResponse {
/**
* The AWS KMS key identifier for encryption of messages in the database activity stream.
*/
KmsKeyId?: String;
/**
* The name of the Amazon Kinesis data stream to be used for the database activity stream.
*/
KinesisStreamName?: String;
/**
* The status of the database activity stream.
*/
Status?: ActivityStreamStatus;
/**
* The mode of the database activity stream.
*/
Mode?: ActivityStreamMode;
/**
* Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
*/
ApplyImmediately?: Boolean;
}
export interface StartDBClusterMessage {
/**
* The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
*/
DBClusterIdentifier: String;
}
export interface StartDBClusterResult {
DBCluster?: DBCluster;
}
export interface StartDBInstanceMessage {
/**
* The user-supplied instance identifier.
*/
DBInstanceIdentifier: String;
}
export interface StartDBInstanceResult {
DBInstance?: DBInstance;
}
export interface StartExportTaskMessage {
/**
* A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.
*/
ExportTaskIdentifier: String;
/**
* The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
*/
SourceArn: String;
/**
* The name of the Amazon S3 bucket to export the snapshot to.
*/
S3BucketName: String;
/**
* The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.
*/
IamRoleArn: String;
/**
* The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The caller of this operation must be authorized to execute the following operations. These can be set in the KMS key policy: GrantOperation.Encrypt GrantOperation.Decrypt GrantOperation.GenerateDataKey GrantOperation.GenerateDataKeyWithoutPlaintext GrantOperation.ReEncryptFrom GrantOperation.ReEncryptTo GrantOperation.CreateGrant GrantOperation.DescribeKey GrantOperation.RetireGrant
*/
KmsKeyId: String;
/**
* The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
*/
S3Prefix?: String;
/**
* The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following: database - Export all the data from a specified database. database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.
*/
ExportOnly?: StringList;
}
export interface StopActivityStreamRequest {
/**
* The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
*/
ResourceArn: String;
/**
* Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.
*/
ApplyImmediately?: BooleanOptional;
}
export interface StopActivityStreamResponse {
/**
* The AWS KMS key identifier used for encrypting messages in the database activity stream.
*/
KmsKeyId?: String;
/**
* The name of the Amazon Kinesis data stream used for the database activity stream.
*/
KinesisStreamName?: String;
/**
* The status of the database activity stream.
*/
Status?: ActivityStreamStatus;
}
export interface StopDBClusterMessage {
/**
* The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
*/
DBClusterIdentifier: String;
}
export interface StopDBClusterResult {
DBCluster?: DBCluster;
}
export interface StopDBInstanceMessage {
/**
* The user-supplied instance identifier.
*/
DBInstanceIdentifier: String;
/**
* The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.
*/
DBSnapshotIdentifier?: String;
}
export interface StopDBInstanceResult {
DBInstance?: DBInstance;
}
export type String = string;
export type StringList = String[];
export type StringSensitive = string;
export interface Subnet {
/**
* The identifier of the subnet.
*/
SubnetIdentifier?: String;
SubnetAvailabilityZone?: AvailabilityZone;
/**
* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
*/
SubnetOutpost?: Outpost;
/**
* The status of the subnet.
*/
SubnetStatus?: String;
}
export type SubnetIdentifierList = String[];
export type SubnetList = Subnet[];
export type SupportedCharacterSetsList = CharacterSet[];
export type SupportedTimezonesList = Timezone[];
export type TStamp = Date;
export interface Tag {
/**
* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
*/
Key?: String;
/**
* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
*/
Value?: String;
}
export type TagList = Tag[];
export interface TagListMessage {
/**
* List of tags returned by the ListTagsForResource operation.
*/
TagList?: TagList;
}
export type TargetGroupList = DBProxyTargetGroup[];
export interface TargetHealth {
/**
* The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: registering > unavailable > available > unavailable > available
*/
State?: TargetState;
/**
* The reason for the current health State of the RDS Proxy target.
*/
Reason?: TargetHealthReason;
/**
* A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
*/
Description?: String;
}
export type TargetHealthReason = "UNREACHABLE"|"CONNECTION_FAILED"|"AUTH_FAILURE"|"PENDING_PROXY_CAPACITY"|string;
export type TargetList = DBProxyTarget[];
export type TargetState = "REGISTERING"|"AVAILABLE"|"UNAVAILABLE"|string;
export type TargetType = "RDS_INSTANCE"|"RDS_SERVERLESS_ENDPOINT"|"TRACKED_CLUSTER"|string;
export interface Timezone {
/**
* The name of the time zone.
*/
TimezoneName?: String;
}
export interface UpgradeTarget {
/**
* The name of the upgrade target database engine.
*/
Engine?: String;
/**
* The version number of the upgrade target database engine.
*/
EngineVersion?: String;
/**
* The version of the database engine that a DB instance can be upgraded to.
*/
Description?: String;
/**
* A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
*/
AutoUpgrade?: Boolean;
/**
* A value that indicates whether a database engine is upgraded to a major version.
*/
IsMajorVersionUpgrade?: Boolean;
}
export interface UserAuthConfig {
/**
* A user-specified description about the authentication used by a proxy to log in as a specific database user.
*/
Description?: String;
/**
* The name of the database user to which the proxy connects.
*/
UserName?: String;
/**
* The type of authentication that the proxy uses for connections from the proxy to the underlying database.
*/
AuthScheme?: AuthScheme;
/**
* The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
*/
SecretArn?: String;
/**
* Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
*/
IAMAuth?: IAMAuthMode;
}
export interface UserAuthConfigInfo {
/**
* A user-specified description about the authentication used by a proxy to log in as a specific database user.
*/
Description?: String;
/**
* The name of the database user to which the proxy connects.
*/
UserName?: String;
/**
* The type of authentication that the proxy uses for connections from the proxy to the underlying database.
*/
AuthScheme?: AuthScheme;
/**
* The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
*/
SecretArn?: String;
/**
* Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
*/
IAMAuth?: IAMAuthMode;
}
export type UserAuthConfigInfoList = UserAuthConfigInfo[];
export type UserAuthConfigList = UserAuthConfig[];
export interface ValidDBInstanceModificationsMessage {
/**
* Valid storage options for your DB instance.
*/
Storage?: ValidStorageOptionsList;
/**
* Valid processor features for your DB instance.
*/
ValidProcessorFeatures?: AvailableProcessorFeatureList;
}
export interface ValidStorageOptions {
/**
* The valid storage types for your DB instance. For example, gp2, io1.
*/
StorageType?: String;
/**
* The valid range of storage in gibibytes. For example, 100 to 16384.
*/
StorageSize?: RangeList;
/**
* The valid range of provisioned IOPS. For example, 1000-20000.
*/
ProvisionedIops?: RangeList;
/**
* The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
*/
IopsToStorageRatio?: DoubleRangeList;
/**
* Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
*/
SupportsStorageAutoscaling?: Boolean;
}
export type ValidStorageOptionsList = ValidStorageOptions[];
export type ValidUpgradeTargetList = UpgradeTarget[];
export type VpcSecurityGroupIdList = String[];
export interface VpcSecurityGroupMembership {
/**
* The name of the VPC security group.
*/
VpcSecurityGroupId?: String;
/**
* The status of the VPC security group.
*/
Status?: String;
}
export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
export interface VpnDetails {
/**
* The ID of the VPN.
*/
VpnId?: String;
/**
* The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
*/
VpnTunnelOriginatorIP?: String;
/**
* The IP address of network traffic from AWS to your on-premises data center.
*/
VpnGatewayIp?: String;
/**
* The preshared key (PSK) for the VPN.
*/
VpnPSK?: StringSensitive;
/**
* The name of the VPN.
*/
VpnName?: String;
/**
* The state of the VPN.
*/
VpnState?: String;
}
export type WriteForwardingStatus = "enabled"|"disabled"|"enabling"|"disabling"|"unknown"|string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2013-01-10"|"2013-02-12"|"2013-09-09"|"2014-09-01"|"2014-09-01"|"2014-10-31"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the RDS client.
*/
export import Types = RDS;
}
export = RDS;