docdb.d.ts
128 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class DocDB extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: DocDB.Types.ClientConfiguration)
config: Config & DocDB.Types.ClientConfiguration;
/**
* Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.
*/
addTagsToResource(params: DocDB.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.
*/
addTagsToResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
*/
applyPendingMaintenanceAction(params: DocDB.Types.ApplyPendingMaintenanceActionMessage, callback?: (err: AWSError, data: DocDB.Types.ApplyPendingMaintenanceActionResult) => void): Request<DocDB.Types.ApplyPendingMaintenanceActionResult, AWSError>;
/**
* Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
*/
applyPendingMaintenanceAction(callback?: (err: AWSError, data: DocDB.Types.ApplyPendingMaintenanceActionResult) => void): Request<DocDB.Types.ApplyPendingMaintenanceActionResult, AWSError>;
/**
* Copies the specified cluster parameter group.
*/
copyDBClusterParameterGroup(params: DocDB.Types.CopyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterParameterGroupResult) => void): Request<DocDB.Types.CopyDBClusterParameterGroupResult, AWSError>;
/**
* Copies the specified cluster parameter group.
*/
copyDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterParameterGroupResult) => void): Request<DocDB.Types.CopyDBClusterParameterGroupResult, AWSError>;
/**
* Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
*/
copyDBClusterSnapshot(params: DocDB.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterSnapshotResult) => void): Request<DocDB.Types.CopyDBClusterSnapshotResult, AWSError>;
/**
* Copies a snapshot of a cluster. To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region. To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
*/
copyDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.CopyDBClusterSnapshotResult) => void): Request<DocDB.Types.CopyDBClusterSnapshotResult, AWSError>;
/**
* Creates a new Amazon DocumentDB cluster.
*/
createDBCluster(params: DocDB.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterResult) => void): Request<DocDB.Types.CreateDBClusterResult, AWSError>;
/**
* Creates a new Amazon DocumentDB cluster.
*/
createDBCluster(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterResult) => void): Request<DocDB.Types.CreateDBClusterResult, AWSError>;
/**
* Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
*/
createDBClusterParameterGroup(params: DocDB.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterParameterGroupResult) => void): Request<DocDB.Types.CreateDBClusterParameterGroupResult, AWSError>;
/**
* Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
*/
createDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterParameterGroupResult) => void): Request<DocDB.Types.CreateDBClusterParameterGroupResult, AWSError>;
/**
* Creates a snapshot of a cluster.
*/
createDBClusterSnapshot(params: DocDB.Types.CreateDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterSnapshotResult) => void): Request<DocDB.Types.CreateDBClusterSnapshotResult, AWSError>;
/**
* Creates a snapshot of a cluster.
*/
createDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.CreateDBClusterSnapshotResult) => void): Request<DocDB.Types.CreateDBClusterSnapshotResult, AWSError>;
/**
* Creates a new instance.
*/
createDBInstance(params: DocDB.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBInstanceResult) => void): Request<DocDB.Types.CreateDBInstanceResult, AWSError>;
/**
* Creates a new instance.
*/
createDBInstance(callback?: (err: AWSError, data: DocDB.Types.CreateDBInstanceResult) => void): Request<DocDB.Types.CreateDBInstanceResult, AWSError>;
/**
* Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
*/
createDBSubnetGroup(params: DocDB.Types.CreateDBSubnetGroupMessage, callback?: (err: AWSError, data: DocDB.Types.CreateDBSubnetGroupResult) => void): Request<DocDB.Types.CreateDBSubnetGroupResult, AWSError>;
/**
* Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
*/
createDBSubnetGroup(callback?: (err: AWSError, data: DocDB.Types.CreateDBSubnetGroupResult) => void): Request<DocDB.Types.CreateDBSubnetGroupResult, AWSError>;
/**
* Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
*/
deleteDBCluster(params: DocDB.Types.DeleteDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterResult) => void): Request<DocDB.Types.DeleteDBClusterResult, AWSError>;
/**
* Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
*/
deleteDBCluster(callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterResult) => void): Request<DocDB.Types.DeleteDBClusterResult, AWSError>;
/**
* Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
*/
deleteDBClusterParameterGroup(params: DocDB.Types.DeleteDBClusterParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
*/
deleteDBClusterParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be deleted.
*/
deleteDBClusterSnapshot(params: DocDB.Types.DeleteDBClusterSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterSnapshotResult) => void): Request<DocDB.Types.DeleteDBClusterSnapshotResult, AWSError>;
/**
* Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The cluster snapshot must be in the available state to be deleted.
*/
deleteDBClusterSnapshot(callback?: (err: AWSError, data: DocDB.Types.DeleteDBClusterSnapshotResult) => void): Request<DocDB.Types.DeleteDBClusterSnapshotResult, AWSError>;
/**
* Deletes a previously provisioned instance.
*/
deleteDBInstance(params: DocDB.Types.DeleteDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.DeleteDBInstanceResult) => void): Request<DocDB.Types.DeleteDBInstanceResult, AWSError>;
/**
* Deletes a previously provisioned instance.
*/
deleteDBInstance(callback?: (err: AWSError, data: DocDB.Types.DeleteDBInstanceResult) => void): Request<DocDB.Types.DeleteDBInstanceResult, AWSError>;
/**
* Deletes a subnet group. The specified database subnet group must not be associated with any DB instances.
*/
deleteDBSubnetGroup(params: DocDB.Types.DeleteDBSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a subnet group. The specified database subnet group must not be associated with any DB instances.
*/
deleteDBSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
*/
describeCertificates(params: DocDB.Types.DescribeCertificatesMessage, callback?: (err: AWSError, data: DocDB.Types.CertificateMessage) => void): Request<DocDB.Types.CertificateMessage, AWSError>;
/**
* Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
*/
describeCertificates(callback?: (err: AWSError, data: DocDB.Types.CertificateMessage) => void): Request<DocDB.Types.CertificateMessage, AWSError>;
/**
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.
*/
describeDBClusterParameterGroups(params: DocDB.Types.DescribeDBClusterParameterGroupsMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupsMessage) => void): Request<DocDB.Types.DBClusterParameterGroupsMessage, AWSError>;
/**
* Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.
*/
describeDBClusterParameterGroups(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupsMessage) => void): Request<DocDB.Types.DBClusterParameterGroupsMessage, AWSError>;
/**
* Returns the detailed parameter list for a particular cluster parameter group.
*/
describeDBClusterParameters(params: DocDB.Types.DescribeDBClusterParametersMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupDetails) => void): Request<DocDB.Types.DBClusterParameterGroupDetails, AWSError>;
/**
* Returns the detailed parameter list for a particular cluster parameter group.
*/
describeDBClusterParameters(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupDetails) => void): Request<DocDB.Types.DBClusterParameterGroupDetails, AWSError>;
/**
* Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share 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 cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all AWS accounts.
*/
describeDBClusterSnapshotAttributes(params: DocDB.Types.DescribeDBClusterSnapshotAttributesMessage, callback?: (err: AWSError, data: DocDB.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<DocDB.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
/**
* Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. When you share 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 cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all AWS accounts.
*/
describeDBClusterSnapshotAttributes(callback?: (err: AWSError, data: DocDB.Types.DescribeDBClusterSnapshotAttributesResult) => void): Request<DocDB.Types.DescribeDBClusterSnapshotAttributesResult, AWSError>;
/**
* Returns information about cluster snapshots. This API operation supports pagination.
*/
describeDBClusterSnapshots(params: DocDB.Types.DescribeDBClusterSnapshotsMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterSnapshotMessage) => void): Request<DocDB.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Returns information about cluster snapshots. This API operation supports pagination.
*/
describeDBClusterSnapshots(callback?: (err: AWSError, data: DocDB.Types.DBClusterSnapshotMessage) => void): Request<DocDB.Types.DBClusterSnapshotMessage, AWSError>;
/**
* Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
*/
describeDBClusters(params: DocDB.Types.DescribeDBClustersMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterMessage) => void): Request<DocDB.Types.DBClusterMessage, AWSError>;
/**
* Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
*/
describeDBClusters(callback?: (err: AWSError, data: DocDB.Types.DBClusterMessage) => void): Request<DocDB.Types.DBClusterMessage, AWSError>;
/**
* Returns a list of the available engines.
*/
describeDBEngineVersions(params: DocDB.Types.DescribeDBEngineVersionsMessage, callback?: (err: AWSError, data: DocDB.Types.DBEngineVersionMessage) => void): Request<DocDB.Types.DBEngineVersionMessage, AWSError>;
/**
* Returns a list of the available engines.
*/
describeDBEngineVersions(callback?: (err: AWSError, data: DocDB.Types.DBEngineVersionMessage) => void): Request<DocDB.Types.DBEngineVersionMessage, AWSError>;
/**
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*/
describeDBInstances(params: DocDB.Types.DescribeDBInstancesMessage, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>;
/**
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*/
describeDBInstances(callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>;
/**
* Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
*/
describeDBSubnetGroups(params: DocDB.Types.DescribeDBSubnetGroupsMessage, callback?: (err: AWSError, data: DocDB.Types.DBSubnetGroupMessage) => void): Request<DocDB.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.
*/
describeDBSubnetGroups(callback?: (err: AWSError, data: DocDB.Types.DBSubnetGroupMessage) => void): Request<DocDB.Types.DBSubnetGroupMessage, AWSError>;
/**
* Returns the default engine and system parameter information for the cluster database engine.
*/
describeEngineDefaultClusterParameters(params: DocDB.Types.DescribeEngineDefaultClusterParametersMessage, callback?: (err: AWSError, data: DocDB.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<DocDB.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the cluster database engine.
*/
describeEngineDefaultClusterParameters(callback?: (err: AWSError, data: DocDB.Types.DescribeEngineDefaultClusterParametersResult) => void): Request<DocDB.Types.DescribeEngineDefaultClusterParametersResult, AWSError>;
/**
* Displays a list of categories for all event source types, or, if specified, for a specified source type.
*/
describeEventCategories(params: DocDB.Types.DescribeEventCategoriesMessage, callback?: (err: AWSError, data: DocDB.Types.EventCategoriesMessage) => void): Request<DocDB.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: DocDB.Types.EventCategoriesMessage) => void): Request<DocDB.Types.EventCategoriesMessage, AWSError>;
/**
* Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
*/
describeEvents(params: DocDB.Types.DescribeEventsMessage, callback?: (err: AWSError, data: DocDB.Types.EventsMessage) => void): Request<DocDB.Types.EventsMessage, AWSError>;
/**
* Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
*/
describeEvents(callback?: (err: AWSError, data: DocDB.Types.EventsMessage) => void): Request<DocDB.Types.EventsMessage, AWSError>;
/**
* Returns a list of orderable instance options for the specified engine.
*/
describeOrderableDBInstanceOptions(params: DocDB.Types.DescribeOrderableDBInstanceOptionsMessage, callback?: (err: AWSError, data: DocDB.Types.OrderableDBInstanceOptionsMessage) => void): Request<DocDB.Types.OrderableDBInstanceOptionsMessage, AWSError>;
/**
* Returns a list of orderable instance options for the specified engine.
*/
describeOrderableDBInstanceOptions(callback?: (err: AWSError, data: DocDB.Types.OrderableDBInstanceOptionsMessage) => void): Request<DocDB.Types.OrderableDBInstanceOptionsMessage, AWSError>;
/**
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*/
describePendingMaintenanceActions(params: DocDB.Types.DescribePendingMaintenanceActionsMessage, callback?: (err: AWSError, data: DocDB.Types.PendingMaintenanceActionsMessage) => void): Request<DocDB.Types.PendingMaintenanceActionsMessage, AWSError>;
/**
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*/
describePendingMaintenanceActions(callback?: (err: AWSError, data: DocDB.Types.PendingMaintenanceActionsMessage) => void): Request<DocDB.Types.PendingMaintenanceActionsMessage, AWSError>;
/**
* Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
*/
failoverDBCluster(params: DocDB.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.FailoverDBClusterResult) => void): Request<DocDB.Types.FailoverDBClusterResult, AWSError>;
/**
* Forces a failover for a cluster. A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer). If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
*/
failoverDBCluster(callback?: (err: AWSError, data: DocDB.Types.FailoverDBClusterResult) => void): Request<DocDB.Types.FailoverDBClusterResult, AWSError>;
/**
* Lists all tags on an Amazon DocumentDB resource.
*/
listTagsForResource(params: DocDB.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: DocDB.Types.TagListMessage) => void): Request<DocDB.Types.TagListMessage, AWSError>;
/**
* Lists all tags on an Amazon DocumentDB resource.
*/
listTagsForResource(callback?: (err: AWSError, data: DocDB.Types.TagListMessage) => void): Request<DocDB.Types.TagListMessage, AWSError>;
/**
* Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
*/
modifyDBCluster(params: DocDB.Types.ModifyDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterResult) => void): Request<DocDB.Types.ModifyDBClusterResult, AWSError>;
/**
* Modifies a setting for an Amazon DocumentDB 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: DocDB.Types.ModifyDBClusterResult) => void): Request<DocDB.Types.ModifyDBClusterResult, AWSError>;
/**
* Modifies the parameters of a 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 or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.
*/
modifyDBClusterParameterGroup(params: DocDB.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a 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 or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.
*/
modifyDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.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 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 cluster snapshot. Use the value all to make the manual 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 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.
*/
modifyDBClusterSnapshotAttribute(params: DocDB.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<DocDB.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 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 cluster snapshot. Use the value all to make the manual 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 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.
*/
modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: DocDB.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<DocDB.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
/**
* Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
*/
modifyDBInstance(params: DocDB.Types.ModifyDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBInstanceResult) => void): Request<DocDB.Types.ModifyDBInstanceResult, AWSError>;
/**
* Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
*/
modifyDBInstance(callback?: (err: AWSError, data: DocDB.Types.ModifyDBInstanceResult) => void): Request<DocDB.Types.ModifyDBInstanceResult, AWSError>;
/**
* Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
*/
modifyDBSubnetGroup(params: DocDB.Types.ModifyDBSubnetGroupMessage, callback?: (err: AWSError, data: DocDB.Types.ModifyDBSubnetGroupResult) => void): Request<DocDB.Types.ModifyDBSubnetGroupResult, AWSError>;
/**
* Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
*/
modifyDBSubnetGroup(callback?: (err: AWSError, data: DocDB.Types.ModifyDBSubnetGroupResult) => void): Request<DocDB.Types.ModifyDBSubnetGroupResult, AWSError>;
/**
* You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
*/
rebootDBInstance(params: DocDB.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: DocDB.Types.RebootDBInstanceResult) => void): Request<DocDB.Types.RebootDBInstanceResult, AWSError>;
/**
* You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
*/
rebootDBInstance(callback?: (err: AWSError, data: DocDB.Types.RebootDBInstanceResult) => void): Request<DocDB.Types.RebootDBInstanceResult, AWSError>;
/**
* Removes metadata tags from an Amazon DocumentDB resource.
*/
removeTagsFromResource(params: DocDB.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes metadata tags from an Amazon DocumentDB resource.
*/
removeTagsFromResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.
*/
resetDBClusterParameterGroup(params: DocDB.Types.ResetDBClusterParameterGroupMessage, callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.
*/
resetDBClusterParameterGroup(callback?: (err: AWSError, data: DocDB.Types.DBClusterParameterGroupNameMessage) => void): Request<DocDB.Types.DBClusterParameterGroupNameMessage, AWSError>;
/**
* Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
*/
restoreDBClusterFromSnapshot(params: DocDB.Types.RestoreDBClusterFromSnapshotMessage, callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterFromSnapshotResult) => void): Request<DocDB.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
/**
* Creates a new cluster from a snapshot or cluster snapshot. If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group. If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
*/
restoreDBClusterFromSnapshot(callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterFromSnapshotResult) => void): Request<DocDB.Types.RestoreDBClusterFromSnapshotResult, AWSError>;
/**
* Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.
*/
restoreDBClusterToPointInTime(params: DocDB.Types.RestoreDBClusterToPointInTimeMessage, callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterToPointInTimeResult) => void): Request<DocDB.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
/**
* Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.
*/
restoreDBClusterToPointInTime(callback?: (err: AWSError, data: DocDB.Types.RestoreDBClusterToPointInTimeResult) => void): Request<DocDB.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
/**
* Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
*/
startDBCluster(params: DocDB.Types.StartDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.StartDBClusterResult) => void): Request<DocDB.Types.StartDBClusterResult, AWSError>;
/**
* Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
*/
startDBCluster(callback?: (err: AWSError, data: DocDB.Types.StartDBClusterResult) => void): Request<DocDB.Types.StartDBClusterResult, AWSError>;
/**
* Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
*/
stopDBCluster(params: DocDB.Types.StopDBClusterMessage, callback?: (err: AWSError, data: DocDB.Types.StopDBClusterResult) => void): Request<DocDB.Types.StopDBClusterResult, AWSError>;
/**
* Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
*/
stopDBCluster(callback?: (err: AWSError, data: DocDB.Types.StopDBClusterResult) => void): Request<DocDB.Types.StopDBClusterResult, AWSError>;
/**
* Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceAvailable", params: DocDB.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceAvailable state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceAvailable", callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceDeleted", params: DocDB.Types.DescribeDBInstancesMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>;
/**
* Waits for the dBInstanceDeleted state by periodically calling the underlying DocDB.describeDBInstancesoperation every 30 seconds (at most 60 times).
*/
waitFor(state: "dBInstanceDeleted", callback?: (err: AWSError, data: DocDB.Types.DBInstanceMessage) => void): Request<DocDB.Types.DBInstanceMessage, AWSError>;
}
declare namespace DocDB {
export interface AddTagsToResourceMessage {
/**
* The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .
*/
ResourceName: String;
/**
* The tags to be assigned to the Amazon DocumentDB 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.
*/
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 Certificate {
/**
* The unique key that identifies a certificate. Example: rds-ca-2019
*/
CertificateIdentifier?: String;
/**
* The type of the certificate. Example: CA
*/
CertificateType?: String;
/**
* The thumbprint of the certificate.
*/
Thumbprint?: String;
/**
* The starting date-time from which the certificate is valid. Example: 2019-07-31T17:57:09Z
*/
ValidFrom?: TStamp;
/**
* The date-time after which the certificate is no longer valid. Example: 2024-07-31T17:57:09Z
*/
ValidTill?: TStamp;
/**
* The Amazon Resource Name (ARN) for the certificate. Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
*/
CertificateArn?: String;
}
export type CertificateList = Certificate[];
export interface CertificateMessage {
/**
* A list of certificates for this AWS account.
*/
Certificates?: CertificateList;
/**
* An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.
*/
Marker?: 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 cluster parameter group. Constraints: Must specify a valid cluster parameter group. If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN. If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
*/
SourceDBClusterParameterGroupIdentifier: String;
/**
* The identifier for the copied cluster parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. The 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 cluster parameter group.
*/
TargetDBClusterParameterGroupDescription: String;
/**
* The tags that are to be assigned to the parameter group.
*/
Tags?: TagList;
}
export interface CopyDBClusterParameterGroupResult {
DBClusterParameterGroup?: DBClusterParameterGroup;
}
export interface CopyDBClusterSnapshotMessage {
/**
* The identifier of the cluster snapshot to copy. This parameter is not case sensitive. Constraints: Must specify a valid system snapshot in the available state. If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier. If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN. Example: my-cluster-snapshot1
*/
SourceDBClusterSnapshotIdentifier: String;
/**
* The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive. 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-cluster-snapshot2
*/
TargetDBClusterSnapshotIdentifier: String;
/**
* The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot. If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region. If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
*/
KmsKeyId?: String;
/**
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another AWS Region. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values: SourceRegion - The ID of the region that contains the snapshot to be copied. SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot. TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.
*/
PreSignedUrl?: String;
/**
* Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false. The default is false.
*/
CopyTags?: BooleanOptional;
/**
* The tags to be assigned to the cluster snapshot.
*/
Tags?: TagList;
}
export interface CopyDBClusterSnapshotResult {
DBClusterSnapshot?: DBClusterSnapshot;
}
export interface CreateDBClusterMessage {
/**
* A list of Amazon EC2 Availability Zones that instances in the 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;
/**
* The cluster identifier. This parameter 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-cluster
*/
DBClusterIdentifier: String;
/**
* The name of the cluster parameter group to associate with this cluster.
*/
DBClusterParameterGroupName?: String;
/**
* A list of EC2 VPC security groups to associate with this cluster.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* A subnet group to associate with this 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 cluster. Valid values: docdb
*/
Engine: String;
/**
* The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
*/
EngineVersion?: String;
/**
* The port number on which the instances in the cluster accept connections.
*/
Port?: IntegerOptional;
/**
* The name of the master user for the cluster. Constraints: Must be from 1 to 63 letters or numbers. The 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 forward slash (/), double quote ("), or the "at" symbol (@). Constraints: Must contain from 8 to 100 characters.
*/
MasterUserPassword: 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;
/**
* The tags to be assigned to the cluster.
*/
Tags?: TagList;
/**
* Specifies whether the cluster is encrypted.
*/
StorageEncrypted?: BooleanOptional;
/**
* The AWS KMS key identifier for an encrypted cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. If an encryption key is not specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region. If you create a replica of an encrypted 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 replica in that AWS Region.
*/
KmsKeyId?: String;
/**
* Not currently supported.
*/
PreSignedUrl?: String;
/**
* A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
*/
DeletionProtection?: BooleanOptional;
}
export interface CreateDBClusterParameterGroupMessage {
/**
* The name of the cluster parameter group. Constraints: Must not match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string.
*/
DBClusterParameterGroupName: String;
/**
* The cluster parameter group family name.
*/
DBParameterGroupFamily: String;
/**
* The description for the cluster parameter group.
*/
Description: String;
/**
* The tags to be assigned to the cluster parameter group.
*/
Tags?: TagList;
}
export interface CreateDBClusterParameterGroupResult {
DBClusterParameterGroup?: DBClusterParameterGroup;
}
export interface CreateDBClusterResult {
DBCluster?: DBCluster;
}
export interface CreateDBClusterSnapshotMessage {
/**
* The identifier of the cluster snapshot. This parameter 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-cluster-snapshot1
*/
DBClusterSnapshotIdentifier: String;
/**
* The identifier of the cluster to create a snapshot for. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster
*/
DBClusterIdentifier: String;
/**
* The tags to be assigned to the cluster snapshot.
*/
Tags?: TagList;
}
export interface CreateDBClusterSnapshotResult {
DBClusterSnapshot?: DBClusterSnapshot;
}
export interface CreateDBInstanceMessage {
/**
* The instance identifier. This parameter 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
*/
DBInstanceIdentifier: String;
/**
* The compute and memory capacity of the instance; for example, db.r5.large.
*/
DBInstanceClass: String;
/**
* The name of the database engine to be used for this instance. Valid value: docdb
*/
Engine: String;
/**
* The Amazon EC2 Availability Zone that the instance is created in. Default: A random, system-chosen Availability Zone in the endpoint's AWS Region. Example: us-east-1d
*/
AvailabilityZone?: 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;
/**
* Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window. Default: true
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
*/
Tags?: TagList;
/**
* The identifier of the cluster that the instance will belong to.
*/
DBClusterIdentifier: String;
/**
* A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15
*/
PromotionTier?: IntegerOptional;
}
export interface CreateDBInstanceResult {
DBInstance?: DBInstance;
}
export interface CreateDBSubnetGroupMessage {
/**
* The name for the 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 subnet group.
*/
DBSubnetGroupDescription: String;
/**
* The Amazon EC2 subnet IDs for the subnet group.
*/
SubnetIds: SubnetIdentifierList;
/**
* The tags to be assigned to the subnet group.
*/
Tags?: TagList;
}
export interface CreateDBSubnetGroupResult {
DBSubnetGroup?: DBSubnetGroup;
}
export interface DBCluster {
/**
* Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
*/
AvailabilityZones?: AvailabilityZones;
/**
* Specifies the number of days for which automatic snapshots are retained.
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
*/
DBClusterIdentifier?: String;
/**
* Specifies the name of the cluster parameter group for the cluster.
*/
DBClusterParameterGroup?: String;
/**
* Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
*/
DBSubnetGroup?: String;
/**
* Specifies the current state of this cluster.
*/
Status?: String;
/**
* Specifies the progress of the operation as a percentage.
*/
PercentProgress?: String;
/**
* The earliest time to which a database can be restored with point-in-time restore.
*/
EarliestRestorableTime?: TStamp;
/**
* Specifies the connection endpoint for the primary instance of the cluster.
*/
Endpoint?: String;
/**
* The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
*/
ReaderEndpoint?: String;
/**
* Specifies whether the cluster has instances in multiple Availability Zones.
*/
MultiAZ?: Boolean;
/**
* Provides the name of the database engine to be used for this 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 user name for the cluster.
*/
MasterUsername?: String;
/**
* 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;
/**
* Provides the list of instances that make up the cluster.
*/
DBClusterMembers?: DBClusterMemberList;
/**
* Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
*/
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
/**
* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
*/
HostedZoneId?: String;
/**
* Specifies whether the cluster is encrypted.
*/
StorageEncrypted?: Boolean;
/**
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted cluster.
*/
KmsKeyId?: String;
/**
* The AWS Region-unique, immutable identifier for the cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is accessed.
*/
DbClusterResourceId?: String;
/**
* The Amazon Resource Name (ARN) for the cluster.
*/
DBClusterArn?: String;
/**
* Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the cluster. IAM roles that are associated with a cluster grant permission for the cluster to access other AWS services on your behalf.
*/
AssociatedRoles?: DBClusterRoles;
/**
* Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
*/
ClusterCreateTime?: TStamp;
/**
* A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
*/
EnabledCloudwatchLogsExports?: LogTypeList;
/**
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
*/
DeletionProtection?: Boolean;
}
export type DBClusterList = DBCluster[];
export interface DBClusterMember {
/**
* Specifies the instance identifier for this member of the cluster.
*/
DBInstanceIdentifier?: String;
/**
* A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
*/
IsClusterWriter?: Boolean;
/**
* Specifies the status of the cluster parameter group for this member of the DB cluster.
*/
DBClusterParameterGroupStatus?: String;
/**
* A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
*/
PromotionTier?: IntegerOptional;
}
export type DBClusterMemberList = DBClusterMember[];
export interface DBClusterMessage {
/**
* 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 clusters.
*/
DBClusters?: DBClusterList;
}
export interface DBClusterParameterGroup {
/**
* Provides the name of the cluster parameter group.
*/
DBClusterParameterGroupName?: String;
/**
* Provides the name of the parameter group family that this cluster parameter group is compatible with.
*/
DBParameterGroupFamily?: String;
/**
* Provides the customer-specified description for this cluster parameter group.
*/
Description?: String;
/**
* The Amazon Resource Name (ARN) for the cluster parameter group.
*/
DBClusterParameterGroupArn?: String;
}
export interface DBClusterParameterGroupDetails {
/**
* Provides a list of parameters for the cluster parameter group.
*/
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 DBClusterParameterGroupList = DBClusterParameterGroup[];
export interface DBClusterParameterGroupNameMessage {
/**
* The name of a cluster parameter group. Constraints: Must be from 1 to 255 letters or numbers. The 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 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 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 cluster. The Status property returns one of the following values: ACTIVE - The IAM role ARN is associated with the 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 cluster, but the cluster cannot assume the IAM role to access other AWS services on your behalf.
*/
Status?: String;
}
export type DBClusterRoles = DBClusterRole[];
export interface DBClusterSnapshot {
/**
* Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
*/
AvailabilityZones?: AvailabilityZones;
/**
* Specifies the identifier for the cluster snapshot.
*/
DBClusterSnapshotIdentifier?: String;
/**
* Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
*/
DBClusterIdentifier?: String;
/**
* Provides the time when the snapshot was taken, in UTC.
*/
SnapshotCreateTime?: TStamp;
/**
* Specifies the name of the database engine.
*/
Engine?: String;
/**
* Specifies the status of this cluster snapshot.
*/
Status?: String;
/**
* Specifies the port that the cluster was listening on at the time of the snapshot.
*/
Port?: Integer;
/**
* Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
*/
VpcId?: String;
/**
* Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
*/
ClusterCreateTime?: TStamp;
/**
* Provides the master user name for the cluster snapshot.
*/
MasterUsername?: String;
/**
* Provides the version of the database engine for this cluster snapshot.
*/
EngineVersion?: String;
/**
* Provides the type of the cluster snapshot.
*/
SnapshotType?: String;
/**
* Specifies the percentage of the estimated data that has been transferred.
*/
PercentProgress?: Integer;
/**
* Specifies whether the cluster snapshot is encrypted.
*/
StorageEncrypted?: Boolean;
/**
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted cluster snapshot.
*/
KmsKeyId?: String;
/**
* The Amazon Resource Name (ARN) for the cluster snapshot.
*/
DBClusterSnapshotArn?: String;
/**
* If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
*/
SourceDBClusterSnapshotArn?: String;
}
export interface DBClusterSnapshotAttribute {
/**
* The name of the manual cluster snapshot attribute. The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual cluster snapshot.
*/
AttributeName?: String;
/**
* The values for the manual 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 cluster snapshot. If a value of all is in the list, then the manual 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 cluster snapshot that the attributes apply to.
*/
DBClusterSnapshotIdentifier?: String;
/**
* The list of attributes and values for the cluster snapshot.
*/
DBClusterSnapshotAttributes?: DBClusterSnapshotAttributeList;
}
export type DBClusterSnapshotList = DBClusterSnapshot[];
export interface DBClusterSnapshotMessage {
/**
* 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;
/**
* Provides a list of cluster snapshots.
*/
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 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;
/**
* A list of engine versions that this database engine version can be upgraded to.
*/
ValidUpgradeTarget?: ValidUpgradeTargetList;
/**
* The types of logs that the database engine has available for export to Amazon 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;
}
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;
/**
* Detailed information about one or more engine versions.
*/
DBEngineVersions?: DBEngineVersionList;
}
export interface DBInstance {
/**
* Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
*/
DBInstanceIdentifier?: String;
/**
* Contains the name of the compute and memory capacity class of the instance.
*/
DBInstanceClass?: String;
/**
* Provides the name of the database engine to be used for this instance.
*/
Engine?: String;
/**
* Specifies the current state of this database.
*/
DBInstanceStatus?: String;
/**
* Specifies the connection endpoint.
*/
Endpoint?: Endpoint;
/**
* Provides the date and time that the 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 snapshots are retained.
*/
BackupRetentionPeriod?: Integer;
/**
* Provides a list of VPC security group elements that the instance belongs to.
*/
VpcSecurityGroups?: VpcSecurityGroupMembershipList;
/**
* Specifies the name of the Availability Zone that the instance is located in.
*/
AvailabilityZone?: String;
/**
* Specifies information on the subnet group that is associated with the 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 instance are pending. This element is included only 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;
/**
* Indicates the database engine version.
*/
EngineVersion?: String;
/**
* Indicates that minor version patches are applied automatically.
*/
AutoMinorVersionUpgrade?: Boolean;
/**
* Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
*/
PubliclyAccessible?: Boolean;
/**
* The status of a read replica. If the instance is not a read replica, this is blank.
*/
StatusInfos?: DBInstanceStatusInfoList;
/**
* Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
*/
DBClusterIdentifier?: String;
/**
* Specifies whether or not the instance is encrypted.
*/
StorageEncrypted?: Boolean;
/**
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted instance.
*/
KmsKeyId?: String;
/**
* The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.
*/
DbiResourceId?: String;
/**
* The identifier of the CA certificate for this DB instance.
*/
CACertificateIdentifier?: String;
/**
* A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
*/
PromotionTier?: IntegerOptional;
/**
* The Amazon Resource Name (ARN) for the instance.
*/
DBInstanceArn?: String;
/**
* A list of log types that this instance is configured to export to Amazon 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;
/**
* Detailed information about one or more instances.
*/
DBInstances?: DBInstanceList;
}
export interface DBInstanceStatusInfo {
/**
* This value is currently "read replication."
*/
StatusType?: String;
/**
* A 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 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 DBSubnetGroup {
/**
* The name of the subnet group.
*/
DBSubnetGroupName?: String;
/**
* Provides the description of the subnet group.
*/
DBSubnetGroupDescription?: String;
/**
* Provides the virtual private cloud (VPC) ID of the subnet group.
*/
VpcId?: String;
/**
* Provides the status of the subnet group.
*/
SubnetGroupStatus?: String;
/**
* Detailed information about one or more subnets within a subnet group.
*/
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;
/**
* Detailed information about one or more subnet groups.
*/
DBSubnetGroups?: DBSubnetGroups;
}
export type DBSubnetGroups = DBSubnetGroup[];
export interface DeleteDBClusterMessage {
/**
* The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive. Constraints: Must match an existing DBClusterIdentifier.
*/
DBClusterIdentifier: String;
/**
* Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted. If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter. Default: false
*/
SkipFinalSnapshot?: Boolean;
/**
* The cluster snapshot identifier of the new 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 from 1 to 255 letters, numbers, or hyphens. The 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 cluster parameter group. Constraints: Must be the name of an existing cluster parameter group. You can't delete a default cluster parameter group. Cannot be associated with any clusters.
*/
DBClusterParameterGroupName: String;
}
export interface DeleteDBClusterResult {
DBCluster?: DBCluster;
}
export interface DeleteDBClusterSnapshotMessage {
/**
* The identifier of the cluster snapshot to delete. Constraints: Must be the name of an existing cluster snapshot in the available state.
*/
DBClusterSnapshotIdentifier: String;
}
export interface DeleteDBClusterSnapshotResult {
DBClusterSnapshot?: DBClusterSnapshot;
}
export interface DeleteDBInstanceMessage {
/**
* The instance identifier for the instance to be deleted. This parameter isn't case sensitive. Constraints: Must match the name of an existing instance.
*/
DBInstanceIdentifier: String;
}
export interface DeleteDBInstanceResult {
DBInstance?: DBInstance;
}
export interface DeleteDBSubnetGroupMessage {
/**
* The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup
*/
DBSubnetGroupName: String;
}
export interface DescribeCertificatesMessage {
/**
* The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive. Constraints Must match an existing CertificateIdentifier.
*/
CertificateIdentifier?: 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 DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeDBClusterParameterGroupsMessage {
/**
* The name of a specific cluster parameter group to return details for. Constraints: If provided, 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 (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 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 cluster parameter group to return parameter details for. Constraints: If provided, 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 (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 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 cluster snapshot to describe the attributes for.
*/
DBClusterSnapshotIdentifier: String;
}
export interface DescribeDBClusterSnapshotAttributesResult {
DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
}
export interface DescribeDBClusterSnapshotsMessage {
/**
* The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive. Constraints: If provided, must match the identifier of an existing DBCluster.
*/
DBClusterIdentifier?: String;
/**
* A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If provided, 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 cluster snapshots to be returned. You can specify one of the following values: automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account. manual - Return all cluster snapshots that you have manually created for your AWS account. shared - Return all manual cluster snapshots that have been shared to your AWS account. public - Return all cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public 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 (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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Set to true to include shared manual 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.
*/
IncludeShared?: Boolean;
/**
* Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.
*/
IncludePublic?: Boolean;
}
export interface DescribeDBClustersMessage {
/**
* The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive. Constraints: If provided, must match an existing DBClusterIdentifier.
*/
DBClusterIdentifier?: String;
/**
* A filter that specifies one or more clusters to describe. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the 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 (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 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: 3.6.0
*/
EngineVersion?: String;
/**
* The name of a specific parameter group family to return details for. Constraints: If provided, must match an existing DBParameterGroupFamily.
*/
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 (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 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-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive. Constraints: If provided, must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier?: String;
/**
* A filter that specifies one or more instances to describe. Supported filters: db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs. db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are 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 (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 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 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 (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 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 cluster parameter group family to return the 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 (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 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 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 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 provided, SourceType must also be provided. If the source type is DBInstance, a DBInstanceIdentifier must be provided. If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided. If the source type is DBParameterGroup, a DBParameterGroupName must be provided. If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided. 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. Example: 2009-07-08T18:00Z
*/
StartTime?: TStamp;
/**
* The end of the time interval for which to retrieve events, specified in ISO 8601 format. 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 an 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 (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 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 instance options for.
*/
Engine: String;
/**
* The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.
*/
EngineVersion?: String;
/**
* The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.
*/
DBInstanceClass?: String;
/**
* The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.
*/
LicenseModel?: String;
/**
* The virtual private cloud (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 (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 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 cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs. db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.
*/
Filters?: FilterList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (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 Endpoint {
/**
* Specifies the DNS address of the 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 {
/**
* The name of the cluster parameter group family to return the engine parameter information for.
*/
DBParameterGroupFamily?: String;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* The parameters of a particular cluster parameter group family.
*/
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 event category maps.
*/
EventCategoriesMapList?: EventCategoriesMapList;
}
export type EventList = Event[];
export interface EventsMessage {
/**
* 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;
/**
* Detailed information about one or more events.
*/
Events?: EventList;
}
export interface FailoverDBClusterMessage {
/**
* A 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 Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.
*/
TargetDBInstanceIdentifier?: String;
}
export interface FailoverDBClusterResult {
DBCluster?: DBCluster;
}
export interface Filter {
/**
* The name of the filter. Filter names are case sensitive.
*/
Name: String;
/**
* One or more filter values. Filter values are case sensitive.
*/
Values: FilterValueList;
}
export type FilterList = Filter[];
export type FilterValueList = String[];
export type Integer = number;
export type IntegerOptional = number;
export type KeyList = String[];
export interface ListTagsForResourceMessage {
/**
* The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
*/
ResourceName: String;
/**
* This parameter is not currently supported.
*/
Filters?: FilterList;
}
export type LogTypeList = String[];
export interface ModifyDBClusterMessage {
/**
* The cluster identifier for the cluster that is being modified. This parameter is not case sensitive. Constraints: Must match the identifier of an existing DBCluster.
*/
DBClusterIdentifier: String;
/**
* The new cluster identifier for the cluster when renaming a 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 changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window. The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the 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 cluster parameter group to use for the cluster.
*/
DBClusterParameterGroupName?: String;
/**
* A list of virtual private cloud (VPC) security groups that the cluster will belong to.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The port number on which the cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The same port as the original cluster.
*/
Port?: IntegerOptional;
/**
* The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@). Constraints: Must contain from 8 to 100 characters.
*/
MasterUserPassword?: 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;
/**
* The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.
*/
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.
*/
EngineVersion?: String;
/**
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
*/
DeletionProtection?: BooleanOptional;
}
export interface ModifyDBClusterParameterGroupMessage {
/**
* The name of the cluster parameter group to modify.
*/
DBClusterParameterGroupName: String;
/**
* A list of parameters in the cluster parameter group to modify.
*/
Parameters: ParametersList;
}
export interface ModifyDBClusterResult {
DBCluster?: DBCluster;
}
export interface ModifyDBClusterSnapshotAttributeMessage {
/**
* The identifier for the cluster snapshot to modify the attributes for.
*/
DBClusterSnapshotIdentifier: String;
/**
* The name of the cluster snapshot attribute to modify. To manage authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this value to restore.
*/
AttributeName: String;
/**
* A list of cluster snapshot attributes to add to the attribute specified by AttributeName. To authorize other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or more AWS account IDs. To make the manual cluster snapshot restorable by any AWS account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all AWS accounts.
*/
ValuesToAdd?: AttributeValueList;
/**
* A list of cluster snapshot attributes to remove from the attribute specified by AttributeName. To remove authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the cluster snapshot, set it to all . If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
*/
ValuesToRemove?: AttributeValueList;
}
export interface ModifyDBClusterSnapshotAttributeResult {
DBClusterSnapshotAttributesResult?: DBClusterSnapshotAttributesResult;
}
export interface ModifyDBInstanceMessage {
/**
* The instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
*/
DBInstanceIdentifier: String;
/**
* The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all AWS Regions. If you modify the 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;
/**
* 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 instance. If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot. Default: false
*/
ApplyImmediately?: Boolean;
/**
* 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, changing this parameter causes a reboot of the instance. If you are 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 that 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;
/**
* Indicates that minor version upgrades are applied automatically to the instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set 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;
/**
* Indicates the certificate that needs to be associated with the instance.
*/
CACertificateIdentifier?: String;
/**
* A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid values: 0-15
*/
PromotionTier?: IntegerOptional;
}
export interface ModifyDBInstanceResult {
DBInstance?: DBInstance;
}
export interface ModifyDBSubnetGroupMessage {
/**
* The name for the 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 subnet group.
*/
DBSubnetGroupDescription?: String;
/**
* The Amazon EC2 subnet IDs for the subnet group.
*/
SubnetIds: SubnetIdentifierList;
}
export interface ModifyDBSubnetGroupResult {
DBSubnetGroup?: DBSubnetGroup;
}
export interface OrderableDBInstanceOption {
/**
* The engine type of an instance.
*/
Engine?: String;
/**
* The engine version of an instance.
*/
EngineVersion?: String;
/**
* The instance class for an instance.
*/
DBInstanceClass?: String;
/**
* The license model for an instance.
*/
LicenseModel?: String;
/**
* A list of Availability Zones for an instance.
*/
AvailabilityZones?: AvailabilityZoneList;
/**
* Indicates whether an instance is in a virtual private cloud (VPC).
*/
Vpc?: Boolean;
}
export type OrderableDBInstanceOptionsList = OrderableDBInstanceOption[];
export interface OrderableDBInstanceOptionsMessage {
/**
* The options that are available for a particular orderable instance.
*/
OrderableDBInstanceOptions?: OrderableDBInstanceOptionsList;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface 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 Amazon 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.
*/
CurrentApplyDate?: TStamp;
/**
* A description providing more detail about the maintenance action.
*/
Description?: String;
}
export type PendingMaintenanceActionDetails = PendingMaintenanceAction[];
export type PendingMaintenanceActions = ResourcePendingMaintenanceActions[];
export interface PendingMaintenanceActionsMessage {
/**
* The maintenance actions to be applied.
*/
PendingMaintenanceActions?: PendingMaintenanceActions;
/**
* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface PendingModifiedValues {
/**
* Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
*/
DBInstanceClass?: String;
/**
* Contains the new AllocatedStorage size for then 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 instance.
*/
MasterUserPassword?: String;
/**
* Specifies the pending port for the instance.
*/
Port?: IntegerOptional;
/**
* Specifies the pending number of days for which automated backups are retained.
*/
BackupRetentionPeriod?: IntegerOptional;
/**
* Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
*/
MultiAZ?: BooleanOptional;
/**
* Indicates the database engine version.
*/
EngineVersion?: String;
/**
* The license model for the instance. Valid values: license-included, bring-your-own-license, general-public-license
*/
LicenseModel?: String;
/**
* Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
*/
Iops?: IntegerOptional;
/**
* Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
*/
DBInstanceIdentifier?: String;
/**
* Specifies the storage type to be associated with the instance.
*/
StorageType?: String;
/**
* Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
*/
CACertificateIdentifier?: String;
/**
* The new subnet group for the instance.
*/
DBSubnetGroupName?: String;
/**
* A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
*/
PendingCloudwatchLogsExports?: PendingCloudwatchLogsExports;
}
export interface RebootDBInstanceMessage {
/**
* The 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 Multi-AZ failover. Constraint: You can't specify true if the instance is not configured for Multi-AZ.
*/
ForceFailover?: BooleanOptional;
}
export interface RebootDBInstanceResult {
DBInstance?: DBInstance;
}
export interface RemoveTagsFromResourceMessage {
/**
* The Amazon DocumentDB resource that the tags are removed from. This value is 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 cluster parameter group to reset.
*/
DBClusterParameterGroupName: String;
/**
* A value that is set to true to reset all parameters in the 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 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 ResourcePendingMaintenanceActions {
/**
* The Amazon Resource Name (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 Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive. 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-snapshot-id
*/
DBClusterIdentifier: String;
/**
* The identifier for the snapshot or cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot. Constraints: Must match the identifier of an existing snapshot.
*/
SnapshotIdentifier: String;
/**
* The database engine to use for the new 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 cluster.
*/
EngineVersion?: String;
/**
* The port number on which the new cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The same port as the original cluster.
*/
Port?: IntegerOptional;
/**
* The name of the subnet group to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The tags to be assigned to the restored cluster.
*/
Tags?: TagList;
/**
* The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. If you do not specify a value for the KmsKeyId parameter, then the following occurs: If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot. If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
*/
KmsKeyId?: String;
/**
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
*/
DeletionProtection?: BooleanOptional;
}
export interface RestoreDBClusterFromSnapshotResult {
DBCluster?: DBCluster;
}
export interface RestoreDBClusterToPointInTimeMessage {
/**
* The name of the new cluster to be created. 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.
*/
DBClusterIdentifier: String;
/**
* The identifier of the source cluster from which to restore. Constraints: Must match the identifier of an existing DBCluster.
*/
SourceDBClusterIdentifier: String;
/**
* The date and time to restore the cluster to. Valid values: A time in Universal Coordinated Time (UTC) format. Constraints: Must be before the latest restorable time for the instance. Must be specified if the UseLatestRestorableTime parameter is not provided. Cannot be specified if the UseLatestRestorableTime parameter is true. Cannot be specified if the RestoreType parameter is copy-on-write. Example: 2015-03-07T23:45:00Z
*/
RestoreToTime?: TStamp;
/**
* A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise. Default: false Constraints: Cannot be specified if the RestoreToTime parameter is provided.
*/
UseLatestRestorableTime?: Boolean;
/**
* The port number on which the new cluster accepts connections. Constraints: Must be a value from 1150 to 65535. Default: The default port for the engine.
*/
Port?: IntegerOptional;
/**
* The subnet group name to use for the new cluster. Constraints: If provided, must match the name of an existing DBSubnetGroup. Example: mySubnetgroup
*/
DBSubnetGroupName?: String;
/**
* A list of VPC security groups that the new cluster belongs to.
*/
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The tags to be assigned to the restored cluster.
*/
Tags?: TagList;
/**
* The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster. The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key. You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS KMS key identified by the KmsKeyId parameter. If you do not specify a value for the KmsKeyId parameter, then the following occurs: If the cluster is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the source cluster. If the cluster is not encrypted, then the restored cluster is not encrypted. If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
*/
KmsKeyId?: String;
/**
* A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
*/
EnableCloudwatchLogsExports?: LogTypeList;
/**
* Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
*/
DeletionProtection?: BooleanOptional;
}
export interface RestoreDBClusterToPointInTimeResult {
DBCluster?: DBCluster;
}
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
export interface StartDBClusterMessage {
/**
* The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
*/
DBClusterIdentifier: String;
}
export interface StartDBClusterResult {
DBCluster?: DBCluster;
}
export interface StopDBClusterMessage {
/**
* The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
*/
DBClusterIdentifier: String;
}
export interface StopDBClusterResult {
DBCluster?: DBCluster;
}
export type String = string;
export interface Subnet {
/**
* Specifies the identifier of the subnet.
*/
SubnetIdentifier?: String;
/**
* Specifies the Availability Zone for the subnet.
*/
SubnetAvailabilityZone?: AvailabilityZone;
/**
* Specifies the status of the subnet.
*/
SubnetStatus?: String;
}
export type SubnetIdentifierList = String[];
export type SubnetList = Subnet[];
export type TStamp = Date;
export interface Tag {
/**
* 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 contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/
Key?: String;
/**
* 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 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 {
/**
* A list of one or more tags.
*/
TagList?: TagList;
}
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 an 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 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 DocDB client.
*/
export import Types = DocDB;
}
export = DocDB;