neptune.d.ts
196 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
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';
interface Blob {}
declare class Neptune extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Neptune.Types.ClientConfiguration)
config: Config & Neptune.Types.ClientConfiguration;
/**
* Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
*/
addRoleToDBCluster(params: Neptune.Types.AddRoleToDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
*/
addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds a source identifier to an existing event notification subscription.
*/
addSourceIdentifierToSubscription(params: Neptune.Types.AddSourceIdentifierToSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<Neptune.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
/**
* Adds a source identifier to an existing event notification subscription.
*/
addSourceIdentifierToSubscription(callback?: (err: AWSError, data: Neptune.Types.AddSourceIdentifierToSubscriptionResult) => void): Request<Neptune.Types.AddSourceIdentifierToSubscriptionResult, AWSError>;
/**
* Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
*/
addTagsToResource(params: Neptune.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
*/
addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*/
applyPendingMaintenanceAction(params: Neptune.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: Neptune.Types.ApplyPendingMaintenanceActionResult) => void): Request<Neptune.Types.ApplyPendingMaintenanceActionResult, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to a DB instance).
*/
applyPendingMaintenanceAction(callback?: (err: AWSError, data: Neptune.Types.ApplyPendingMaintenanceActionResult) => void): Request<Neptune.Types.ApplyPendingMaintenanceActionResult, AWSError>;
/**
* Copies the specified DB cluster parameter group.
*/
copyDBClusterParameterGroup(params: Neptune.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterParameterGroupResult) => void): Request<Neptune.Types.CopyDBClusterParameterGroupResult, AWSError>;
/**
* Copies the specified DB cluster parameter group.
*/
copyDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterParameterGroupResult) => void): Request<Neptune.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't copy from one AWS Region to another.
*/
copyDBClusterSnapshot(params: Neptune.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterSnapshotResult) => void): Request<Neptune.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't copy from one AWS Region to another.
*/
copyDBClusterSnapshot(callback?: (err: AWSError, data: Neptune.Types.CopyDBClusterSnapshotResult) => void): Request<Neptune.Types.CopyDBClusterSnapshotResult, AWSError>;
/**
* Copies the specified DB parameter group.
*/
copyDBParameterGroup(params: Neptune.Types.CopyDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CopyDBParameterGroupResult) => void): Request<Neptune.Types.CopyDBParameterGroupResult, AWSError>;
/**
* Copies the specified DB parameter group.
*/
copyDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CopyDBParameterGroupResult) => void): Request<Neptune.Types.CopyDBParameterGroupResult, AWSError>;
/**
* Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.
*/
createDBCluster(params: Neptune.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterResult) => void): Request<Neptune.Types.CreateDBClusterResult, AWSError>;
/**
* Creates a new Amazon Neptune DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.
*/
createDBCluster(callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterResult) => void): Request<Neptune.Types.CreateDBClusterResult, 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 Neptune 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
*/
createDBClusterParameterGroup(params: Neptune.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterParameterGroupResult) => void): Request<Neptune.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 Neptune 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
*/
createDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterParameterGroupResult) => void): Request<Neptune.Types.CreateDBClusterParameterGroupResult, AWSError>;
/**
* Creates a snapshot of a DB cluster.
*/
createDBClusterSnapshot(params: Neptune.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterSnapshotResult) => void): Request<Neptune.Types.CreateDBClusterSnapshotResult, AWSError>;
/**
* Creates a snapshot of a DB cluster.
*/
createDBClusterSnapshot(callback?: (err: AWSError, data: Neptune.Types.CreateDBClusterSnapshotResult) => void): Request<Neptune.Types.CreateDBClusterSnapshotResult, AWSError>;
/**
* Creates a new DB instance.
*/
createDBInstance(params: Neptune.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBInstanceResult) => void): Request<Neptune.Types.CreateDBInstanceResult, AWSError>;
/**
* Creates a new DB instance.
*/
createDBInstance(callback?: (err: AWSError, data: Neptune.Types.CreateDBInstanceResult) => void): Request<Neptune.Types.CreateDBInstanceResult, 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 Neptune 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 Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
createDBParameterGroup(params: Neptune.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBParameterGroupResult) => void): Request<Neptune.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 Neptune 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 Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
createDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.CreateDBParameterGroupResult) => void): Request<Neptune.Types.CreateDBParameterGroupResult, 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: Neptune.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: Neptune.Types.CreateDBSubnetGroupResult) => void): Request<Neptune.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: Neptune.Types.CreateDBSubnetGroupResult) => void): Request<Neptune.Types.CreateDBSubnetGroupResult, AWSError>;
/**
* Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune 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) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
*/
createEventSubscription(params: Neptune.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.CreateEventSubscriptionResult) => void): Request<Neptune.Types.CreateEventSubscriptionResult, AWSError>;
/**
* Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune 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) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
*/
createEventSubscription(callback?: (err: AWSError, data: Neptune.Types.CreateEventSubscriptionResult) => void): Request<Neptune.Types.CreateEventSubscriptionResult, 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.
*/
deleteDBCluster(params: Neptune.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterResult) => void): Request<Neptune.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.
*/
deleteDBCluster(callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterResult) => void): Request<Neptune.Types.DeleteDBClusterResult, AWSError>;
/**
* Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
*/
deleteDBClusterParameterGroup(params: Neptune.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.
*/
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.
*/
deleteDBClusterSnapshot(params: Neptune.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterSnapshotResult) => void): Request<Neptune.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.
*/
deleteDBClusterSnapshot(callback?: (err: AWSError, data: Neptune.Types.DeleteDBClusterSnapshotResult) => void): Request<Neptune.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 Neptune 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. Note that 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 the SkipFinalSnapshot parameter is set to true. You can't delete a DB instance if it is the only instance in the DB cluster.
*/
deleteDBInstance(params: Neptune.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteDBInstanceResult) => void): Request<Neptune.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 Neptune 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. Note that 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 the SkipFinalSnapshot parameter is set to true. You can't delete a DB instance if it is the only instance in the DB cluster.
*/
deleteDBInstance(callback?: (err: AWSError, data: Neptune.Types.DeleteDBInstanceResult) => void): Request<Neptune.Types.DeleteDBInstanceResult, AWSError>;
/**
* Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
*/
deleteDBParameterGroup(params: Neptune.Types.DeleteDBParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
*/
deleteDBParameterGroup(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(params: Neptune.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 event notification subscription.
*/
deleteEventSubscription(params: Neptune.Types.DeleteEventSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.DeleteEventSubscriptionResult) => void): Request<Neptune.Types.DeleteEventSubscriptionResult, AWSError>;
/**
* Deletes an event notification subscription.
*/
deleteEventSubscription(callback?: (err: AWSError, data: Neptune.Types.DeleteEventSubscriptionResult) => void): Request<Neptune.Types.DeleteEventSubscriptionResult, 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.
*/
describeDBClusterParameterGroups(params: Neptune.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupsMessage) => void): Request<Neptune.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.
*/
describeDBClusterParameterGroups(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupsMessage) => void): Request<Neptune.Types.DBClusterParameterGroupsMessage, AWSError>;
/**
* Returns the detailed parameter list for a particular DB cluster parameter group.
*/
describeDBClusterParameters(params: Neptune.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupDetails) => void): Request<Neptune.Types.DBClusterParameterGroupDetails, AWSError>;
/**
* Returns the detailed parameter list for a particular DB cluster parameter group.
*/
describeDBClusterParameters(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupDetails) => void): Request<Neptune.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.
*/
describeDBClusterSnapshotAttributes(params: Neptune.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<Neptune.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.
*/
describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: Neptune.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<Neptune.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
/**
* Returns information about DB cluster snapshots. This API action supports pagination.
*/
describeDBClusterSnapshots(params: Neptune.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterSnapshotMessage) => void): Request<Neptune.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Returns information about DB cluster snapshots. This API action supports pagination.
*/
describeDBClusterSnapshots(callback?: (err: AWSError, data: Neptune.Types.DBClusterSnapshotMessage) => void): Request<Neptune.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Returns information about provisioned DB clusters. This API supports pagination.
*/
describeDBClusters(params: Neptune.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterMessage) => void): Request<Neptune.Types.DBClusterMessage, AWSError>;
/**
* Returns information about provisioned DB clusters. This API supports pagination.
*/
describeDBClusters(callback?: (err: AWSError, data: Neptune.Types.DBClusterMessage) => void): Request<Neptune.Types.DBClusterMessage, AWSError>;
/**
* Returns a list of the available DB engines.
*/
describeDBEngineVersions(params: Neptune.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: Neptune.Types.DBEngineVersionMessage) => void): Request<Neptune.Types.DBEngineVersionMessage, AWSError>;
/**
* Returns a list of the available DB engines.
*/
describeDBEngineVersions(callback?: (err: AWSError, data: Neptune.Types.DBEngineVersionMessage) => void): Request<Neptune.Types.DBEngineVersionMessage, AWSError>;
/**
* Returns information about provisioned instances. This API supports pagination.
*/
describeDBInstances(params: Neptune.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request<Neptune.Types.DBInstanceMessage, AWSError>;
/**
* Returns information about provisioned instances. This API supports pagination.
*/
describeDBInstances(callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request<Neptune.Types.DBInstanceMessage, 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: Neptune.Types.DescribeDBParameterGroupsMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupsMessage) => void): Request<Neptune.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: Neptune.Types.DBParameterGroupsMessage) => void): Request<Neptune.Types.DBParameterGroupsMessage, AWSError>;
/**
* Returns the detailed parameter list for a particular DB parameter group.
*/
describeDBParameters(params: Neptune.Types.DescribeDBParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupDetails) => void): Request<Neptune.Types.DBParameterGroupDetails, AWSError>;
/**
* Returns the detailed parameter list for a particular DB parameter group.
*/
describeDBParameters(callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupDetails) => void): Request<Neptune.Types.DBParameterGroupDetails, 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: Neptune.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: Neptune.Types.DBSubnetGroupMessage) => void): Request<Neptune.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: Neptune.Types.DBSubnetGroupMessage) => void): Request<Neptune.Types.DBSubnetGroupMessage, AWSError>;
/**
* Returns the default engine and system parameter information for the cluster database engine.
*/
describeEngineDefaultClusterParameters(params: Neptune.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<Neptune.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the cluster database engine.
*/
describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<Neptune.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the specified database engine.
*/
describeEngineDefaultParameters(params: Neptune.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultParametersResult) => void): Request<Neptune.Types.DescribeEngineDefaultParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the specified database engine.
*/
describeEngineDefaultParameters(callback?: (err: AWSError, data: Neptune.Types.DescribeEngineDefaultParametersResult) => void): Request<Neptune.Types.DescribeEngineDefaultParametersResult, AWSError>;
/**
* Displays a list of categories for all event source types, or, if specified, for a specified source type.
*/
describeEventCategories(params: Neptune.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: Neptune.Types.EventCategoriesMessage) => void): Request<Neptune.Types.EventCategoriesMessage, AWSError>;
/**
* Displays a list of categories for all event source types, or, if specified, for a specified source type.
*/
describeEventCategories(callback?: (err: AWSError, data: Neptune.Types.EventCategoriesMessage) => void): Request<Neptune.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: Neptune.Types.DescribeEventSubscriptionsMessage, callback?: (err: AWSError, data: Neptune.Types.EventSubscriptionsMessage) => void): Request<Neptune.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: Neptune.Types.EventSubscriptionsMessage) => void): Request<Neptune.Types.EventSubscriptionsMessage, AWSError>;
/**
* Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
*/
describeEvents(params: Neptune.Types.DescribeEventsMessage, callback?: (err: AWSError, data: Neptune.Types.EventsMessage) => void): Request<Neptune.Types.EventsMessage, AWSError>;
/**
* Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter 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: Neptune.Types.EventsMessage) => void): Request<Neptune.Types.EventsMessage, AWSError>;
/**
* Returns a list of orderable DB instance options for the specified engine.
*/
describeOrderableDBInstanceOptions(params: Neptune.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: Neptune.Types.OrderableDBInstanceOptionsMessage) => void): Request<Neptune.Types.OrderableDBInstanceOptionsMessage, AWSError>;
/**
* Returns a list of orderable DB instance options for the specified engine.
*/
describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: Neptune.Types.OrderableDBInstanceOptionsMessage) => void): Request<Neptune.Types.OrderableDBInstanceOptionsMessage, AWSError>;
/**
* Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
*/
describePendingMaintenanceActions(params: Neptune.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: Neptune.Types.PendingMaintenanceActionsMessage) => void): Request<Neptune.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: Neptune.Types.PendingMaintenanceActionsMessage) => void): Request<Neptune.Types.PendingMaintenanceActionsMessage, 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: Neptune.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: Neptune.Types.DescribeValidDBInstanceModificationsResult) => void): Request<Neptune.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: Neptune.Types.DescribeValidDBInstanceModificationsResult) => void): Request<Neptune.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
/**
* Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read 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.
*/
failoverDBCluster(params: Neptune.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.FailoverDBClusterResult) => void): Request<Neptune.Types.FailoverDBClusterResult, AWSError>;
/**
* Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read 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.
*/
failoverDBCluster(callback?: (err: AWSError, data: Neptune.Types.FailoverDBClusterResult) => void): Request<Neptune.Types.FailoverDBClusterResult, AWSError>;
/**
* Lists all tags on an Amazon Neptune resource.
*/
listTagsForResource(params: Neptune.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: Neptune.Types.TagListMessage) => void): Request<Neptune.Types.TagListMessage, AWSError>;
/**
* Lists all tags on an Amazon Neptune resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Neptune.Types.TagListMessage) => void): Request<Neptune.Types.TagListMessage, AWSError>;
/**
* Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
*/
modifyDBCluster(params: Neptune.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterResult) => void): Request<Neptune.Types.ModifyDBClusterResult, AWSError>;
/**
* Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
*/
modifyDBCluster(callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterResult) => void): Request<Neptune.Types.ModifyDBClusterResult, 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. 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 Neptune 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
*/
modifyDBClusterParameterGroup(params: Neptune.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request<Neptune.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. 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 Neptune 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
*/
modifyDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request<Neptune.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. 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. 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 public or private, use the DescribeDBClusterSnapshotAttributes API action.
*/
modifyDBClusterSnapshotAttribute(params: Neptune.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<Neptune.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. 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. 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 public or private, use the DescribeDBClusterSnapshotAttributes API action.
*/
modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: Neptune.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<Neptune.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: Neptune.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBInstanceResult) => void): Request<Neptune.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: Neptune.Types.ModifyDBInstanceResult) => void): Request<Neptune.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 Neptune 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 Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
modifyDBParameterGroup(params: Neptune.Types.ModifyDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request<Neptune.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 Neptune 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 Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
*/
modifyDBParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request<Neptune.Types.DBParameterGroupNameMessage, 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: Neptune.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyDBSubnetGroupResult) => void): Request<Neptune.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: Neptune.Types.ModifyDBSubnetGroupResult) => void): Request<Neptune.Types.ModifyDBSubnetGroupResult, AWSError>;
/**
* Modifies an existing event notification subscription. Note that 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 SourceType by using the DescribeEventCategories action.
*/
modifyEventSubscription(params: Neptune.Types.ModifyEventSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.ModifyEventSubscriptionResult) => void): Request<Neptune.Types.ModifyEventSubscriptionResult, AWSError>;
/**
* Modifies an existing event notification subscription. Note that 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 SourceType by using the DescribeEventCategories action.
*/
modifyEventSubscription(callback?: (err: AWSError, data: Neptune.Types.ModifyEventSubscriptionResult) => void): Request<Neptune.Types.ModifyEventSubscriptionResult, AWSError>;
/**
* Not supported.
*/
promoteReadReplicaDBCluster(params: Neptune.Types.PromoteReadReplicaDBClusterMessage, callback?: (err: AWSError, data: Neptune.Types.PromoteReadReplicaDBClusterResult) => void): Request<Neptune.Types.PromoteReadReplicaDBClusterResult, AWSError>;
/**
* Not supported.
*/
promoteReadReplicaDBCluster(callback?: (err: AWSError, data: Neptune.Types.PromoteReadReplicaDBClusterResult) => void): Request<Neptune.Types.PromoteReadReplicaDBClusterResult, 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.
*/
rebootDBInstance(params: Neptune.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: Neptune.Types.RebootDBInstanceResult) => void): Request<Neptune.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.
*/
rebootDBInstance(callback?: (err: AWSError, data: Neptune.Types.RebootDBInstanceResult) => void): Request<Neptune.Types.RebootDBInstanceResult, AWSError>;
/**
* Disassociates an Identity and Access Management (IAM) role from a DB cluster.
*/
removeRoleFromDBCluster(params: Neptune.Types.RemoveRoleFromDBClusterMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates an Identity and Access Management (IAM) role from a DB cluster.
*/
removeRoleFromDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a source identifier from an existing event notification subscription.
*/
removeSourceIdentifierFromSubscription(params: Neptune.Types.RemoveSourceIdentifierFromSubscriptionMessage, callback?: (err: AWSError, data: Neptune.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<Neptune.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
/**
* Removes a source identifier from an existing event notification subscription.
*/
removeSourceIdentifierFromSubscription(callback?: (err: AWSError, data: Neptune.Types.RemoveSourceIdentifierFromSubscriptionResult) => void): Request<Neptune.Types.RemoveSourceIdentifierFromSubscriptionResult, AWSError>;
/**
* Removes metadata tags from an Amazon Neptune resource.
*/
removeTagsFromResource(params: Neptune.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes metadata tags from an Amazon Neptune resource.
*/
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.
*/
resetDBClusterParameterGroup(params: Neptune.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request<Neptune.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.
*/
resetDBClusterParameterGroup(callback?: (err: AWSError, data: Neptune.Types.DBClusterParameterGroupNameMessage) => void): Request<Neptune.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: Neptune.Types.ResetDBParameterGroupMessage, callback?: (err: AWSError, data: Neptune.Types.DBParameterGroupNameMessage) => void): Request<Neptune.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: Neptune.Types.DBParameterGroupNameMessage) => void): Request<Neptune.Types.DBParameterGroupNameMessage, AWSError>;
/**
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
*/
restoreDBClusterFromSnapshot(params: Neptune.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterFromSnapshotResult) => void): Request<Neptune.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
/**
* Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
*/
restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterFromSnapshotResult) => void): Request<Neptune.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.
*/
restoreDBClusterToPointInTime(params: Neptune.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterToPointInTimeResult) => void): Request<Neptune.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.
*/
restoreDBClusterToPointInTime(callback?: (err: AWSError, data: Neptune.Types.RestoreDBClusterToPointInTimeResult) => void): Request<Neptune.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
/**
* Waits for the dBInstanceAvailable state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceAvailable", params: Neptune.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request<Neptune.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceAvailable state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request<Neptune.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceDeleted state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceDeleted", params: Neptune.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request<Neptune.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceDeleted state by periodically calling the underlying Neptune.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: Neptune.Types.DBInstanceMessage) => void): Request<Neptune.Types.DBInstanceMessage, AWSError>;
}
declare namespace Neptune {
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 Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.
*/
RoleArn: String;
}
export interface AddSourceIdentifierToSubscriptionMessage {
/**
* The name of the 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, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
*/
SourceIdentifier: String;
}
export interface AddSourceIdentifierToSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface AddTagsToResourceMessage {
/**
* The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
*/
ResourceName: String;
/**
* The tags to be assigned to the Amazon Neptune resource.
*/
Tags: TagList;
}
export type ApplyMethod = "immediate"|"pending-reboot"|string;
export interface ApplyPendingMaintenanceActionMessage {
/**
* The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
*/
ResourceIdentifier: String;
/**
* The pending maintenance action to apply to this resource. Valid values: system-update, db-upgrade
*/
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 interface AvailabilityZone {
/**
* The name of the availability zone.
*/
Name?: String;
}
export type AvailabilityZoneList = AvailabilityZone[];
export type AvailabilityZones = String[];
export type Boolean = boolean;
export type BooleanOptional = boolean;
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 CopyDBClusterParameterGroupMessage {
/**
* The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN). 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: Cannot be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Cannot 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;
/**
* The tags to be assigned to the copied DB cluster parameter group.
*/
Tags?: TagList;
}
export interface CopyDBClusterParameterGroupResult {
DBClusterParameterGroup?: DBClusterParameterGroup;
}
export interface CopyDBClusterSnapshotMessage {
/**
* The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. You can't copy from one AWS Region to another. Constraints: Must specify a valid system snapshot in the "available" state. Specify a valid DB snapshot identifier. Example: my-cluster-snapshot1
*/
SourceDBClusterSnapshotIdentifier: String;
/**
* The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-snapshot2
*/
TargetDBClusterSnapshotIdentifier: String;
/**
* The AWS 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon Neptune encrypts the target DB cluster snapshot using the specified 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. 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;
/**
* Not currently supported.
*/
PreSignedUrl?: String;
/**
* True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.
*/
CopyTags?: BooleanOptional;
/**
* The tags to assign to the new DB cluster snapshot copy.
*/
Tags?: TagList;
}
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 Amazon Resource Name (ARN). 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: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. First character must be a letter. Cannot 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;
/**
* The tags to be assigned to the copied DB parameter group.
*/
Tags?: TagList;
}
export interface CopyDBParameterGroupResult {
DBParameterGroup?: DBParameterGroup;
}
export interface CreateDBClusterMessage {
/**
* A list of EC2 Availability Zones that instances in the DB cluster can be created in.
*/
AvailabilityZones?: AvailabilityZones;
/**
* 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;
/**
* 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 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not 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. Cannot 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 this argument is omitted, the default 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 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: neptune
*/
Engine: String;
/**
* The version number of the database engine to use. Example: 1.0.1
*/
EngineVersion?: String;
/**
* The port number on which the instances in the DB cluster accept connections. Default: 8182
*/
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. Cannot 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 Maintenance Window in the Amazon Neptune 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 Neptune 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;
/**
* The tags to assign to the new DB cluster.
*/
Tags?: TagList;
/**
* Specifies 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 is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune 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;
/**
* This parameter is not currently supported.
*/
PreSignedUrl?: String;
/**
* True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
*/
EnableCloudwatchLogsExports?: LogTypeList;
}
export interface CreateDBClusterParameterGroupMessage {
/**
* The name of the DB cluster parameter group. Constraints: Must match the name of an existing DBClusterParameterGroup. 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.
*/
DBParameterGroupFamily: String;
/**
* The description for the DB cluster parameter group.
*/
Description: String;
/**
* The tags to be assigned to the new 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. Cannot 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 is not 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 {
/**
* Not supported.
*/
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. Cannot 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 Not applicable. Neptune 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 a Neptune cluster volume.
*/
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.
*/
DBInstanceClass: String;
/**
* The name of the database engine to be used for this instance. Valid Values: neptune
*/
Engine: String;
/**
* The name for the master user. Not used.
*/
MasterUsername?: String;
/**
* The password for the master user. The password can include any printable ASCII character except "/", """, or "@". Not used.
*/
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 EC2 VPC security groups to associate with this DB instance. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster. Default: The default EC2 VPC security group for the DB subnet group's VPC.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The EC2 Availability Zone that the DB instance is created in 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 MultiAZ parameter is set to true. 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. 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). 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 this argument is omitted, the default DBParameterGroup for the specified engine is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
*/
DBParameterGroupName?: String;
/**
* The number of days for which automated backups are retained. Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster. Default: 1 Constraints: Must be a value from 0 to 35 Cannot 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. Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
*/
PreferredBackupWindow?: String;
/**
* The port number on which the database accepts connections. Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster. Default: 8182 Type: Integer
*/
Port?: IntegerOptional;
/**
* Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
*/
MultiAZ?: BooleanOptional;
/**
* The version number of the database engine to use.
*/
EngineVersion?: String;
/**
* Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: true
*/
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.
*/
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, and that option group can't be removed from a DB instance once it is associated with a DB instance
*/
OptionGroupName?: String;
/**
* Indicates that the DB instance should be associated with the specified CharacterSet. Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
*/
CharacterSetName?: String;
/**
* This flag should no longer be used.
*/
PubliclyAccessible?: BooleanOptional;
/**
* The tags to assign to the new instance.
*/
Tags?: TagList;
/**
* The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String
*/
DBClusterIdentifier?: String;
/**
* Specifies the storage type to be associated with the DB instance. Not applicable. Storage is managed by the DB Cluster.
*/
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;
/**
* Specifies whether the DB instance is encrypted. Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster. Default: false
*/
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. Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune 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;
/**
* Specify the Active Directory Domain to create the instance in.
*/
Domain?: String;
/**
* True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
*/
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 Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. 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 Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15
*/
PromotionTier?: IntegerOptional;
/**
* The time zone of the DB instance.
*/
Timezone?: String;
/**
* True to enable AWS Identity and Access Management (IAM) authentication for Neptune. Default: false
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* True to enable Performance Insights for the DB instance, and otherwise false.
*/
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.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
*/
EnableCloudwatchLogsExports?: LogTypeList;
}
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 Cannot 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.
*/
DBParameterGroupFamily: String;
/**
* The description for the DB parameter group.
*/
Description: String;
/**
* The tags to be assigned to the new DB parameter group.
*/
Tags?: TagList;
}
export interface CreateDBParameterGroupResult {
DBParameterGroup?: DBParameterGroup;
}
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;
/**
* The tags to be assigned to the new 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 would set this parameter to db-instance. if this value is not 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 SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
*/
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 SourceIds are supplied, SourceType must also be provided. If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. If the source type is a DB security group, a DBSecurityGroupName must be supplied. If the source type is a DB parameter group, a DBParameterGroupName must be supplied. If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
*/
SourceIds?: SourceIdsList;
/**
* A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
*/
Enabled?: BooleanOptional;
/**
* The tags to be applied to the new event subscription.
*/
Tags?: TagList;
}
export interface CreateEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
export interface DBCluster {
/**
* AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.
*/
AllocatedStorage?: IntegerOptional;
/**
* Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
*/
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;
/**
* Specifies 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 Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster. If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.
*/
ReaderEndpoint?: String;
/**
* Specifies whether the DB cluster has instances in multiple Availability Zones.
*/
MultiAZ?: Boolean;
/**
* Provides 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;
/**
* Not supported by Neptune.
*/
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 true, 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;
/**
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
*/
IAMDatabaseAuthenticationEnabled?: Boolean;
/**
* 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;
/**
* A list of log types that this DB cluster is configured to export to CloudWatch Logs.
*/
EnabledCloudwatchLogsExports?: LogTypeList;
}
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 a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
*/
PromotionTier?: IntegerOptional;
}
export type DBClusterMemberList = DBClusterMember[];
export interface DBClusterMessage {
/**
* A pagination token that can be used in a subsequent 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 {
/**
* Provides the name of the DB cluster parameter group.
*/
DBClusterParameterGroupName?: String;
/**
* Provides 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 Cannot 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;
}
export type DBClusterRoles = DBClusterRole[];
export interface DBClusterSnapshot {
/**
* Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
*/
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 is not specified.
*/
DefaultCharacterSet?: CharacterSet;
/**
* A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.
*/
SupportedCharacterSets?: 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;
}
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;
/**
* Provides the name of the database engine to be used for this DB instance.
*/
Engine?: String;
/**
* Specifies the current state of this database.
*/
DBInstanceStatus?: String;
/**
* Contains the master username for the DB instance.
*/
MasterUsername?: String;
/**
* The database name.
*/
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;
/**
* Provides List of DB security group elements containing only 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 DB clusters that are Read Replicas of this DB instance.
*/
ReadReplicaDBClusterIdentifiers?: ReadReplicaDBClusterIdentifierList;
/**
* 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;
/**
* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
*/
SecondaryAvailabilityZone?: String;
/**
* This flag should no longer be used.
*/
PubliclyAccessible?: Boolean;
/**
* The status of a Read Replica. If the instance is not 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;
/**
* Not supported: The encryption for DB instances is managed by the DB cluster.
*/
StorageEncrypted?: Boolean;
/**
* Not supported: The encryption for DB instances is managed by the DB cluster.
*/
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;
/**
* Not supported
*/
DomainMemberships?: DomainMembershipList;
/**
* Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
*/
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 Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
*/
MonitoringRoleArn?: String;
/**
* A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
*/
PromotionTier?: IntegerOptional;
/**
* The Amazon Resource Name (ARN) for the DB instance.
*/
DBInstanceArn?: String;
/**
* Not supported.
*/
Timezone?: String;
/**
* True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
*/
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;
/**
* A list of log types that this DB instance is configured to export to CloudWatch Logs.
*/
EnabledCloudwatchLogsExports?: LogTypeList;
}
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 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, error, stopped, or terminated.
*/
Status?: String;
/**
* Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
*/
Message?: String;
}
export type DBInstanceStatusInfoList = DBInstanceStatusInfo[];
export interface DBParameterGroup {
/**
* Provides the name of the DB parameter group.
*/
DBParameterGroupName?: String;
/**
* Provides 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 {
/**
* Provides the name of the DB parameter group.
*/
DBParameterGroupName?: String;
}
export interface DBParameterGroupStatus {
/**
* The name of the DP 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 DBSecurityGroupMembership {
/**
* The name of the DB security group.
*/
DBSecurityGroupName?: String;
/**
* The status of the DB security group.
*/
Status?: String;
}
export type DBSecurityGroupMembershipList = DBSecurityGroupMembership[];
export type DBSecurityGroupNameList = String[];
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 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;
/**
* Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false. Default: false
*/
SkipFinalSnapshot?: Boolean;
/**
* The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Cannot 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. Cannot 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 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;
/**
* Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted. Note that 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 the SkipFinalSnapshot parameter is set to "true". Specify true when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false. Default: false
*/
SkipFinalSnapshot?: Boolean;
/**
* The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Cannot be specified when deleting a Read Replica.
*/
FinalDBSnapshotIdentifier?: String;
}
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 Cannot be associated with any DB instances
*/
DBParameterGroupName: String;
}
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 event notification subscription you want to delete.
*/
SubscriptionName: String;
}
export interface DeleteEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
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 is not 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 the remaining results can be retrieved. 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 is not 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 the remaining results can be retrieved. 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 is not 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 Neptune 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 setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true. 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;
/**
* This parameter is not 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 the remaining results can be retrieved. 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;
/**
* True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false. 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;
/**
* True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false. 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 that the remaining results can be retrieved. 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;
}
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;
/**
* Not 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 that the following results can be retrieved. 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;
/**
* Indicates that only the default version of the specified engine or engine and major version combination is returned.
*/
DefaultOnly?: Boolean;
/**
* If this parameter is specified 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;
/**
* If this parameter is specified 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;
}
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.
*/
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 the remaining results can be retrieved. 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 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 is not 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 the remaining results can be retrieved. 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 is not 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 the remaining results can be retrieved. 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 DescribeDBSubnetGroupsMessage {
/**
* The name of the DB subnet group to return details for.
*/
DBSubnetGroupName?: String;
/**
* This parameter is not 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 the remaining results can be retrieved. 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 is not 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 the remaining results can be retrieved. 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;
/**
* Not 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 the remaining results can be retrieved. 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-parameter-group | db-security-group | db-snapshot
*/
SourceType?: String;
/**
* This parameter is not currently supported.
*/
Filters?: FilterList;
}
export interface DescribeEventSubscriptionsMessage {
/**
* The name of the event notification subscription you want to describe.
*/
SubscriptionName?: String;
/**
* This parameter is not 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 the remaining results can be retrieved. 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 DBInstance, then a DBInstanceIdentifier must be supplied. If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied. If the source type is DBParameterGroup, a DBParameterGroupName must be supplied. If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied. Cannot 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 is not 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 the remaining results can be retrieved. 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 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 VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
*/
Vpc?: BooleanOptional;
/**
* This parameter is not 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 the remaining results can be retrieved. 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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
*/
MaxRecords?: IntegerOptional;
}
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 DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
*/
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 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 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 event notification subscription.
*/
CustomerAwsId?: String;
/**
* The event notification subscription Id.
*/
CustSubscriptionId?: String;
/**
* The topic ARN of the event notification subscription.
*/
SnsTopicArn?: String;
/**
* The status of the 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 Neptune 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 event notification subscription was created.
*/
SubscriptionCreationTime?: String;
/**
* The source type for the event notification subscription.
*/
SourceType?: String;
/**
* A list of source IDs for the event notification subscription.
*/
SourceIdsList?: SourceIdsList;
/**
* A list of event categories for the 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 FailoverDBClusterMessage {
/**
* A DB cluster identifier to force a failover for. This parameter is not 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 Read Replica in the DB cluster. For example, mydbcluster-replica1.
*/
TargetDBInstanceIdentifier?: String;
}
export interface FailoverDBClusterResult {
DBCluster?: DBCluster;
}
export interface Filter {
/**
* This parameter is not currently supported.
*/
Name: String;
/**
* This parameter is not currently supported.
*/
Values: FilterValueList;
}
export type FilterList = Filter[];
export type FilterValueList = String[];
export type Integer = number;
export type IntegerOptional = number;
export type KeyList = String[];
export interface ListTagsForResourceMessage {
/**
* The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
*/
ResourceName: String;
/**
* This parameter is not currently supported.
*/
Filters?: FilterList;
}
export type LogTypeList = String[];
export interface ModifyDBClusterMessage {
/**
* The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
*/
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 Cannot end with a hyphen or contain two consecutive hyphens Example: my-cluster2
*/
NewDBClusterIdentifier?: String;
/**
* A value that specifies 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 set to false, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. Default: false
*/
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 parameter is set to true 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. 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. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
*/
PreferredMaintenanceWindow?: String;
/**
* True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* 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 the ApplyImmediately parameter is set to true. For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
*/
EngineVersion?: String;
}
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.
*/
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. Not applicable. Storage is managed by the DB Cluster.
*/
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. 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 specified as true 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. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter. 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. 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;
/**
* Specifies 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. If this parameter is set to false, 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. Default: false
*/
ApplyImmediately?: Boolean;
/**
* Not applicable.
*/
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. The db instance will NOT be rebooted automatically and the parameter changes will NOT be 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;
/**
* Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* The daily time range during which automated backups are created if automated backups are enabled. 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;
/**
* Specifies if 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 set to true 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 set to true 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.
*/
EngineVersion?: String;
/**
* Indicates that 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: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
*/
AllowMajorVersionUpgrade?: Boolean;
/**
* Indicates that 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 will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* Not supported.
*/
LicenseModel?: String;
/**
* The new Provisioned IOPS (I/O operations per second) value for the 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 set to true for this request. 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 set to true 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 will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. 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. Cannot end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
*/
NewDBInstanceIdentifier?: String;
/**
* Not supported.
*/
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;
/**
* Not supported.
*/
Domain?: String;
/**
* True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
*/
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. Default: 8182
*/
DBPortNumber?: IntegerOptional;
/**
* This flag should no longer be used.
*/
PubliclyAccessible?: BooleanOptional;
/**
* The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
*/
MonitoringRoleArn?: String;
/**
* Not supported
*/
DomainIAMRoleName?: String;
/**
* A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15
*/
PromotionTier?: IntegerOptional;
/**
* True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster. Default: false
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* Not supported.
*/
EnablePerformanceInsights?: BooleanOptional;
/**
* Not supported.
*/
PerformanceInsightsKMSKeyId?: String;
/**
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
*/
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
}
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; subsequent 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 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 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 is not specified, all events are returned. Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
*/
SourceType?: String;
/**
* A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
*/
EventCategories?: EventCategoriesList;
/**
* A Boolean value; set to true to activate the subscription.
*/
Enabled?: BooleanOptional;
}
export interface ModifyEventSubscriptionResult {
EventSubscription?: EventSubscription;
}
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 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;
/**
* 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;
}
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 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;
}
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.
*/
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. If this date is specified, any next-maintenance opt-in requests are ignored.
*/
AutoAppliedAfterDate?: TStamp;
/**
* The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.
*/
ForcedApplyDate?: 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;
/**
* Specifies the CloudWatch logs to be exported.
*/
PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports;
}
export interface PromoteReadReplicaDBClusterMessage {
/**
* Not supported.
*/
DBClusterIdentifier: String;
}
export interface PromoteReadReplicaDBClusterResult {
DBCluster?: DBCluster;
}
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 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;
/**
* When true, the reboot is conducted through a MultiAZ failover. Constraint: You can't specify true if the instance is not configured for MultiAZ.
*/
ForceFailover?: BooleanOptional;
}
export interface RebootDBInstanceResult {
DBInstance?: DBInstance;
}
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 DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.
*/
RoleArn: String;
}
export interface RemoveSourceIdentifierFromSubscriptionMessage {
/**
* The name of the 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 Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
*/
ResourceName: String;
/**
* The tag key (name) of the tag to be removed.
*/
TagKeys: KeyList;
}
export interface ResetDBClusterParameterGroupMessage {
/**
* The name of the DB cluster parameter group to reset.
*/
DBClusterParameterGroupName: String;
/**
* A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. 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 set to true.
*/
Parameters?: ParametersList;
}
export interface ResetDBParameterGroupMessage {
/**
* The name of the DB parameter group. Constraints: Must match the name of an existing DBParameterGroup.
*/
DBParameterGroupName: String;
/**
* Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values. Default: true
*/
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. 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 RestoreDBClusterFromSnapshotMessage {
/**
* Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
*/
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 Cannot 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.
*/
EngineVersion?: String;
/**
* The port number on which the new DB cluster accepts connections. Constraints: 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 DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* Not supported.
*/
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 do not specify a value for the KmsKeyId parameter, then the following will occur: 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 is not encrypted, then the restored DB cluster is not encrypted.
*/
KmsKeyId?: String;
/**
* True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
*/
DBClusterParameterGroupName?: 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 Cannot 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. 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 is not provided Cannot be specified if UseLatestRestorableTime parameter is true Cannot be specified if RestoreType parameter is copy-on-write Example: 2015-03-07T23:45:00Z
*/
RestoreToTime?: TStamp;
/**
* A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if RestoreToTime parameter is provided.
*/
UseLatestRestorableTime?: Boolean;
/**
* The port number on which the new DB cluster accepts connections. Constraints: Value must be 1150-65535 Default: The same port as the original DB cluster.
*/
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;
/**
* The tags to be applied to the restored DB cluster.
*/
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 do not specify a value for the KmsKeyId parameter, then the following will occur: 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 is not encrypted, then the restored DB cluster is not encrypted. If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.
*/
KmsKeyId?: String;
/**
* True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: false
*/
EnableIAMDatabaseAuthentication?: BooleanOptional;
/**
* The list of logs that the restored DB cluster is to export to CloudWatch Logs.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
*/
DBClusterParameterGroupName?: String;
}
export interface RestoreDBClusterToPointInTimeResult {
DBCluster?: DBCluster;
}
export type SourceIdsList = String[];
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
export type String = string;
export interface Subnet {
/**
* Specifies the identifier of the subnet.
*/
SubnetIdentifier?: String;
/**
* Specifies the EC2 Availability Zone that the subnet is in.
*/
SubnetAvailabilityZone?: AvailabilityZone;
/**
* Specifies 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 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 ValidDBInstanceModificationsMessage {
/**
* Valid storage options for your DB instance.
*/
Storage?: ValidStorageOptionsList;
}
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;
}
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[];
/**
* 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 = "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 Neptune client.
*/
export import Types = Neptune;
}
export = Neptune;