elasticache.d.ts
192 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class ElastiCache extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ElastiCache.Types.ClientConfiguration)
config: Config & ElastiCache.Types.ClientConfiguration;
/**
* Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs. When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
*/
addTagsToResource(params: ElastiCache.Types.AddTagsToResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
/**
* Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs. When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
*/
addTagsToResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
/**
* Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
*/
authorizeCacheSecurityGroupIngress(params: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult, AWSError>;
/**
* Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
*/
authorizeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.AuthorizeCacheSecurityGroupIngressResult, AWSError>;
/**
* Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
*/
batchApplyUpdateAction(params: ElastiCache.Types.BatchApplyUpdateActionMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
/**
* Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
*/
batchApplyUpdateAction(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
/**
* Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
*/
batchStopUpdateAction(params: ElastiCache.Types.BatchStopUpdateActionMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
/**
* Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
*/
batchStopUpdateAction(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionResultsMessage) => void): Request<ElastiCache.Types.UpdateActionResultsMessage, AWSError>;
/**
* Complete the migration of data.
*/
completeMigration(params: ElastiCache.Types.CompleteMigrationMessage, callback?: (err: AWSError, data: ElastiCache.Types.CompleteMigrationResponse) => void): Request<ElastiCache.Types.CompleteMigrationResponse, AWSError>;
/**
* Complete the migration of data.
*/
completeMigration(callback?: (err: AWSError, data: ElastiCache.Types.CompleteMigrationResponse) => void): Request<ElastiCache.Types.CompleteMigrationResponse, AWSError>;
/**
* Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*/
copySnapshot(params: ElastiCache.Types.CopySnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request<ElastiCache.Types.CopySnapshotResult, AWSError>;
/**
* Makes a copy of an existing snapshot. This operation is valid for Redis only. Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control. You could receive the following error messages. Error Messages Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide. Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions. Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName. Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide. Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
*/
copySnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CopySnapshotResult) => void): Request<ElastiCache.Types.CopySnapshotResult, AWSError>;
/**
* Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters.
*/
createCacheCluster(params: ElastiCache.Types.CreateCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request<ElastiCache.Types.CreateCacheClusterResult, AWSError>;
/**
* Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis. This operation is not supported for Redis (cluster mode enabled) clusters.
*/
createCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheClusterResult) => void): Request<ElastiCache.Types.CreateCacheClusterResult, AWSError>;
/**
* Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide.
*/
createCacheParameterGroup(params: ElastiCache.Types.CreateCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request<ElastiCache.Types.CreateCacheParameterGroupResult, AWSError>;
/**
* Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide.
*/
createCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheParameterGroupResult) => void): Request<ElastiCache.Types.CreateCacheParameterGroupResult, AWSError>;
/**
* Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
*/
createCacheSecurityGroup(params: ElastiCache.Types.CreateCacheSecurityGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request<ElastiCache.Types.CreateCacheSecurityGroupResult, AWSError>;
/**
* Creates a new cache security group. Use a cache security group to control access to one or more clusters. Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
*/
createCacheSecurityGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSecurityGroupResult) => void): Request<ElastiCache.Types.CreateCacheSecurityGroupResult, AWSError>;
/**
* Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*/
createCacheSubnetGroup(params: ElastiCache.Types.CreateCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request<ElastiCache.Types.CreateCacheSubnetGroupResult, AWSError>;
/**
* Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*/
createCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateCacheSubnetGroupResult) => void): Request<ElastiCache.Types.CreateCacheSubnetGroupResult, AWSError>;
/**
* Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only.
*/
createReplicationGroup(params: ElastiCache.Types.CreateReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request<ElastiCache.Types.CreateReplicationGroupResult, AWSError>;
/**
* Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only.
*/
createReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.CreateReplicationGroupResult) => void): Request<ElastiCache.Types.CreateReplicationGroupResult, AWSError>;
/**
* Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only.
*/
createSnapshot(params: ElastiCache.Types.CreateSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request<ElastiCache.Types.CreateSnapshotResult, AWSError>;
/**
* Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Redis only.
*/
createSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.CreateSnapshotResult) => void): Request<ElastiCache.Types.CreateSnapshotResult, AWSError>;
/**
* Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
*/
decreaseReplicaCount(params: ElastiCache.Types.DecreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>;
/**
* Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
*/
decreaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.DecreaseReplicaCountResult) => void): Request<ElastiCache.Types.DecreaseReplicaCountResult, AWSError>;
/**
* Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation is not valid for: Redis (cluster mode enabled) clusters A cluster that is the last read replica of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Redis (cluster mode enabled) replication group A cluster that is not in the available state
*/
deleteCacheCluster(params: ElastiCache.Types.DeleteCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>;
/**
* Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation. This operation is not valid for: Redis (cluster mode enabled) clusters A cluster that is the last read replica of a replication group A node group (shard) that has Multi-AZ mode enabled A cluster from a Redis (cluster mode enabled) replication group A cluster that is not in the available state
*/
deleteCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.DeleteCacheClusterResult) => void): Request<ElastiCache.Types.DeleteCacheClusterResult, AWSError>;
/**
* Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
*/
deleteCacheParameterGroup(params: ElastiCache.Types.DeleteCacheParameterGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.
*/
deleteCacheParameterGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
*/
deleteCacheSecurityGroup(params: ElastiCache.Types.DeleteCacheSecurityGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
*/
deleteCacheSecurityGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters.
*/
deleteCacheSubnetGroup(params: ElastiCache.Types.DeleteCacheSubnetGroupMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a cache subnet group. You cannot delete a cache subnet group if it is associated with any clusters.
*/
deleteCacheSubnetGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only.
*/
deleteReplicationGroup(params: ElastiCache.Types.DeleteReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>;
/**
* Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation. This operation is valid for Redis only.
*/
deleteReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.DeleteReplicationGroupResult) => void): Request<ElastiCache.Types.DeleteReplicationGroupResult, AWSError>;
/**
* Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only.
*/
deleteSnapshot(params: ElastiCache.Types.DeleteSnapshotMessage, callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>;
/**
* Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation. This operation is valid for Redis only.
*/
deleteSnapshot(callback?: (err: AWSError, data: ElastiCache.Types.DeleteSnapshotResult) => void): Request<ElastiCache.Types.DeleteSnapshotResult, AWSError>;
/**
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
*/
describeCacheClusters(params: ElastiCache.Types.DescribeCacheClustersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
/**
* Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied. By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint. If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned. If the cluster is in the deleting state, only cluster-level information is displayed. If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use. If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
*/
describeCacheClusters(callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
/**
* Returns a list of the available cache engines and their versions.
*/
describeCacheEngineVersions(params: ElastiCache.Types.DescribeCacheEngineVersionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>;
/**
* Returns a list of the available cache engines and their versions.
*/
describeCacheEngineVersions(callback?: (err: AWSError, data: ElastiCache.Types.CacheEngineVersionMessage) => void): Request<ElastiCache.Types.CacheEngineVersionMessage, AWSError>;
/**
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
*/
describeCacheParameterGroups(params: ElastiCache.Types.DescribeCacheParameterGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>;
/**
* Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
*/
describeCacheParameterGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupsMessage) => void): Request<ElastiCache.Types.CacheParameterGroupsMessage, AWSError>;
/**
* Returns the detailed parameter list for a particular cache parameter group.
*/
describeCacheParameters(params: ElastiCache.Types.DescribeCacheParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>;
/**
* Returns the detailed parameter list for a particular cache parameter group.
*/
describeCacheParameters(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupDetails) => void): Request<ElastiCache.Types.CacheParameterGroupDetails, AWSError>;
/**
* Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
*/
describeCacheSecurityGroups(params: ElastiCache.Types.DescribeCacheSecurityGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>;
/**
* Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
*/
describeCacheSecurityGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSecurityGroupMessage) => void): Request<ElastiCache.Types.CacheSecurityGroupMessage, AWSError>;
/**
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
*/
describeCacheSubnetGroups(params: ElastiCache.Types.DescribeCacheSubnetGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>;
/**
* Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
*/
describeCacheSubnetGroups(callback?: (err: AWSError, data: ElastiCache.Types.CacheSubnetGroupMessage) => void): Request<ElastiCache.Types.CacheSubnetGroupMessage, AWSError>;
/**
* Returns the default engine and system parameter information for the specified cache engine.
*/
describeEngineDefaultParameters(params: ElastiCache.Types.DescribeEngineDefaultParametersMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>;
/**
* Returns the default engine and system parameter information for the specified cache engine.
*/
describeEngineDefaultParameters(callback?: (err: AWSError, data: ElastiCache.Types.DescribeEngineDefaultParametersResult) => void): Request<ElastiCache.Types.DescribeEngineDefaultParametersResult, AWSError>;
/**
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
*/
describeEvents(params: ElastiCache.Types.DescribeEventsMessage, callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>;
/**
* Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter. By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
*/
describeEvents(callback?: (err: AWSError, data: ElastiCache.Types.EventsMessage) => void): Request<ElastiCache.Types.EventsMessage, AWSError>;
/**
* Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only.
*/
describeReplicationGroups(params: ElastiCache.Types.DescribeReplicationGroupsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
/**
* Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Redis only.
*/
describeReplicationGroups(callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
/**
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*/
describeReservedCacheNodes(params: ElastiCache.Types.DescribeReservedCacheNodesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>;
/**
* Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
*/
describeReservedCacheNodes(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodeMessage) => void): Request<ElastiCache.Types.ReservedCacheNodeMessage, AWSError>;
/**
* Lists available reserved cache node offerings.
*/
describeReservedCacheNodesOfferings(params: ElastiCache.Types.DescribeReservedCacheNodesOfferingsMessage, callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>;
/**
* Lists available reserved cache node offerings.
*/
describeReservedCacheNodesOfferings(callback?: (err: AWSError, data: ElastiCache.Types.ReservedCacheNodesOfferingMessage) => void): Request<ElastiCache.Types.ReservedCacheNodesOfferingMessage, AWSError>;
/**
* Returns details of the service updates
*/
describeServiceUpdates(params: ElastiCache.Types.DescribeServiceUpdatesMessage, callback?: (err: AWSError, data: ElastiCache.Types.ServiceUpdatesMessage) => void): Request<ElastiCache.Types.ServiceUpdatesMessage, AWSError>;
/**
* Returns details of the service updates
*/
describeServiceUpdates(callback?: (err: AWSError, data: ElastiCache.Types.ServiceUpdatesMessage) => void): Request<ElastiCache.Types.ServiceUpdatesMessage, AWSError>;
/**
* Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only.
*/
describeSnapshots(params: ElastiCache.Types.DescribeSnapshotsMessage, callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>;
/**
* Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster. This operation is valid for Redis only.
*/
describeSnapshots(callback?: (err: AWSError, data: ElastiCache.Types.DescribeSnapshotsListMessage) => void): Request<ElastiCache.Types.DescribeSnapshotsListMessage, AWSError>;
/**
* Returns details of the update actions
*/
describeUpdateActions(params: ElastiCache.Types.DescribeUpdateActionsMessage, callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionsMessage) => void): Request<ElastiCache.Types.UpdateActionsMessage, AWSError>;
/**
* Returns details of the update actions
*/
describeUpdateActions(callback?: (err: AWSError, data: ElastiCache.Types.UpdateActionsMessage) => void): Request<ElastiCache.Types.UpdateActionsMessage, AWSError>;
/**
* Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
*/
increaseReplicaCount(params: ElastiCache.Types.IncreaseReplicaCountMessage, callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>;
/**
* Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
*/
increaseReplicaCount(callback?: (err: AWSError, data: ElastiCache.Types.IncreaseReplicaCountResult) => void): Request<ElastiCache.Types.IncreaseReplicaCountResult, AWSError>;
/**
* Lists all available node types that you can scale your Redis cluster's or replication group's current node type. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
*/
listAllowedNodeTypeModifications(params: ElastiCache.Types.ListAllowedNodeTypeModificationsMessage, callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>;
/**
* Lists all available node types that you can scale your Redis cluster's or replication group's current node type. When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
*/
listAllowedNodeTypeModifications(callback?: (err: AWSError, data: ElastiCache.Types.AllowedNodeTypeModificationsMessage) => void): Request<ElastiCache.Types.AllowedNodeTypeModificationsMessage, AWSError>;
/**
* Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs. If the cluster is not in the available state, ListTagsForResource returns an error. You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
*/
listTagsForResource(params: ElastiCache.Types.ListTagsForResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
/**
* Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs. If the cluster is not in the available state, ListTagsForResource returns an error. You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.
*/
listTagsForResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
/**
* Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
*/
modifyCacheCluster(params: ElastiCache.Types.ModifyCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>;
/**
* Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
*/
modifyCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheClusterResult) => void): Request<ElastiCache.Types.ModifyCacheClusterResult, AWSError>;
/**
* Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
*/
modifyCacheParameterGroup(params: ElastiCache.Types.ModifyCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
*/
modifyCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
/**
* Modifies an existing cache subnet group.
*/
modifyCacheSubnetGroup(params: ElastiCache.Types.ModifyCacheSubnetGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>;
/**
* Modifies an existing cache subnet group.
*/
modifyCacheSubnetGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyCacheSubnetGroupResult) => void): Request<ElastiCache.Types.ModifyCacheSubnetGroupResult, AWSError>;
/**
* Modifies the settings for a replication group. For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see: Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only.
*/
modifyReplicationGroup(params: ElastiCache.Types.ModifyReplicationGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>;
/**
* Modifies the settings for a replication group. For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see: Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Redis only.
*/
modifyReplicationGroup(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupResult, AWSError>;
/**
* Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.
*/
modifyReplicationGroupShardConfiguration(params: ElastiCache.Types.ModifyReplicationGroupShardConfigurationMessage, callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>;
/**
* Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.
*/
modifyReplicationGroupShardConfiguration(callback?: (err: AWSError, data: ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult) => void): Request<ElastiCache.Types.ModifyReplicationGroupShardConfigurationResult, AWSError>;
/**
* Allows you to purchase a reserved cache node offering.
*/
purchaseReservedCacheNodesOffering(params: ElastiCache.Types.PurchaseReservedCacheNodesOfferingMessage, callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>;
/**
* Allows you to purchase a reserved cache node offering.
*/
purchaseReservedCacheNodesOffering(callback?: (err: AWSError, data: ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult) => void): Request<ElastiCache.Types.PurchaseReservedCacheNodesOfferingResult, AWSError>;
/**
* Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
*/
rebootCacheCluster(params: ElastiCache.Types.RebootCacheClusterMessage, callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>;
/**
* Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING. The reboot causes the contents of the cache (for each cache node being rebooted) to be lost. When the reboot is complete, a cluster event is created. Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters. If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
*/
rebootCacheCluster(callback?: (err: AWSError, data: ElastiCache.Types.RebootCacheClusterResult) => void): Request<ElastiCache.Types.RebootCacheClusterResult, AWSError>;
/**
* Removes the tags identified by the TagKeys list from the named resource.
*/
removeTagsFromResource(params: ElastiCache.Types.RemoveTagsFromResourceMessage, callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
/**
* Removes the tags identified by the TagKeys list from the named resource.
*/
removeTagsFromResource(callback?: (err: AWSError, data: ElastiCache.Types.TagListMessage) => void): Request<ElastiCache.Types.TagListMessage, AWSError>;
/**
* Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
*/
resetCacheParameterGroup(params: ElastiCache.Types.ResetCacheParameterGroupMessage, callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
/**
* Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
*/
resetCacheParameterGroup(callback?: (err: AWSError, data: ElastiCache.Types.CacheParameterGroupNameMessage) => void): Request<ElastiCache.Types.CacheParameterGroupNameMessage, AWSError>;
/**
* Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
*/
revokeCacheSecurityGroupIngress(params: ElastiCache.Types.RevokeCacheSecurityGroupIngressMessage, callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>;
/**
* Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
*/
revokeCacheSecurityGroupIngress(callback?: (err: AWSError, data: ElastiCache.Types.RevokeCacheSecurityGroupIngressResult) => void): Request<ElastiCache.Types.RevokeCacheSecurityGroupIngressResult, AWSError>;
/**
* Start the migration of data.
*/
startMigration(params: ElastiCache.Types.StartMigrationMessage, callback?: (err: AWSError, data: ElastiCache.Types.StartMigrationResponse) => void): Request<ElastiCache.Types.StartMigrationResponse, AWSError>;
/**
* Start the migration of data.
*/
startMigration(callback?: (err: AWSError, data: ElastiCache.Types.StartMigrationResponse) => void): Request<ElastiCache.Types.StartMigrationResponse, AWSError>;
/**
* Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
*/
testFailover(params: ElastiCache.Types.TestFailoverMessage, callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>;
/**
* Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console). Note the following A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period. If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently. If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made. To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> Cache cluster message: Finished recovery for cache nodes <node-id> For more information see: Viewing ElastiCache Events in the ElastiCache User Guide DescribeEvents in the ElastiCache API Reference Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.
*/
testFailover(callback?: (err: AWSError, data: ElastiCache.Types.TestFailoverResult) => void): Request<ElastiCache.Types.TestFailoverResult, AWSError>;
/**
* Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is available.
*/
waitFor(state: "cacheClusterAvailable", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
/**
* Waits for the cacheClusterAvailable state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is available.
*/
waitFor(state: "cacheClusterAvailable", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
/**
* Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is deleted.
*/
waitFor(state: "cacheClusterDeleted", params: ElastiCache.Types.DescribeCacheClustersMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
/**
* Waits for the cacheClusterDeleted state by periodically calling the underlying ElastiCache.describeCacheClustersoperation every 15 seconds (at most 40 times). Wait until ElastiCache cluster is deleted.
*/
waitFor(state: "cacheClusterDeleted", callback?: (err: AWSError, data: ElastiCache.Types.CacheClusterMessage) => void): Request<ElastiCache.Types.CacheClusterMessage, AWSError>;
/**
* Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is available.
*/
waitFor(state: "replicationGroupAvailable", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
/**
* Waits for the replicationGroupAvailable state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is available.
*/
waitFor(state: "replicationGroupAvailable", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
/**
* Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is deleted.
*/
waitFor(state: "replicationGroupDeleted", params: ElastiCache.Types.DescribeReplicationGroupsMessage & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
/**
* Waits for the replicationGroupDeleted state by periodically calling the underlying ElastiCache.describeReplicationGroupsoperation every 15 seconds (at most 40 times). Wait until ElastiCache replication group is deleted.
*/
waitFor(state: "replicationGroupDeleted", callback?: (err: AWSError, data: ElastiCache.Types.ReplicationGroupMessage) => void): Request<ElastiCache.Types.ReplicationGroupMessage, AWSError>;
}
declare namespace ElastiCache {
export type AZMode = "single-az"|"cross-az"|string;
export interface AddTagsToResourceMessage {
/**
* The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*/
ResourceName: String;
/**
* A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
*/
Tags: TagList;
}
export type AllowedNodeGroupId = string;
export interface AllowedNodeTypeModificationsMessage {
/**
* A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
*/
ScaleUpModifications?: NodeTypeList;
/**
* A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down on a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
*/
ScaleDownModifications?: NodeTypeList;
}
export type AuthTokenUpdateStatus = "SETTING"|"ROTATING"|string;
export type AuthTokenUpdateStrategyType = "SET"|"ROTATE"|string;
export interface AuthorizeCacheSecurityGroupIngressMessage {
/**
* The cache security group that allows network ingress.
*/
CacheSecurityGroupName: String;
/**
* The Amazon EC2 security group to be authorized for ingress to the cache security group.
*/
EC2SecurityGroupName: String;
/**
* The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
*/
EC2SecurityGroupOwnerId: String;
}
export interface AuthorizeCacheSecurityGroupIngressResult {
CacheSecurityGroup?: CacheSecurityGroup;
}
export type AutomaticFailoverStatus = "enabled"|"disabled"|"enabling"|"disabling"|string;
export interface AvailabilityZone {
/**
* The name of the Availability Zone.
*/
Name?: String;
}
export type AvailabilityZonesList = String[];
export interface BatchApplyUpdateActionMessage {
/**
* The replication group IDs
*/
ReplicationGroupIds?: ReplicationGroupIdList;
/**
* The cache cluster IDs
*/
CacheClusterIds?: CacheClusterIdList;
/**
* The unique ID of the service update
*/
ServiceUpdateName: String;
}
export interface BatchStopUpdateActionMessage {
/**
* The replication group IDs
*/
ReplicationGroupIds?: ReplicationGroupIdList;
/**
* The cache cluster IDs
*/
CacheClusterIds?: CacheClusterIdList;
/**
* The unique ID of the service update
*/
ServiceUpdateName: String;
}
export type Boolean = boolean;
export type BooleanOptional = boolean;
export interface CacheCluster {
/**
* The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
*/
CacheClusterId?: String;
/**
* Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
*/
ConfigurationEndpoint?: Endpoint;
/**
* The URL of the web page where you can download the latest ElastiCache client library.
*/
ClientDownloadLandingPage?: String;
/**
* The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The name of the cache engine (memcached or redis) to be used for this cluster.
*/
Engine?: String;
/**
* The version of the cache engine that is used in this cluster.
*/
EngineVersion?: String;
/**
* The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.
*/
CacheClusterStatus?: String;
/**
* The number of cache nodes in the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
*/
NumCacheNodes?: IntegerOptional;
/**
* The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
*/
PreferredAvailabilityZone?: String;
/**
* The date and time when the cluster was created.
*/
CacheClusterCreateTime?: TStamp;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
*/
PreferredMaintenanceWindow?: String;
PendingModifiedValues?: PendingModifiedValues;
/**
* Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
*/
NotificationConfiguration?: NotificationConfiguration;
/**
* A list of cache security group elements, composed of name and status sub-elements.
*/
CacheSecurityGroups?: CacheSecurityGroupMembershipList;
/**
* Status of the cache parameter group.
*/
CacheParameterGroup?: CacheParameterGroupStatus;
/**
* The name of the cache subnet group associated with the cluster.
*/
CacheSubnetGroupName?: String;
/**
* A list of cache nodes that are members of the cluster.
*/
CacheNodes?: CacheNodeList;
/**
* This parameter is currently disabled.
*/
AutoMinorVersionUpgrade?: Boolean;
/**
* A list of VPC Security Groups associated with the cluster.
*/
SecurityGroups?: SecurityGroupMembershipList;
/**
* The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
*/
ReplicationGroupId?: String;
/**
* The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00
*/
SnapshotWindow?: String;
/**
* A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
*/
AuthTokenEnabled?: BooleanOptional;
/**
* The date the auth token was last modified
*/
AuthTokenLastModifiedDate?: TStamp;
/**
* A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false
*/
TransitEncryptionEnabled?: BooleanOptional;
/**
* A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false
*/
AtRestEncryptionEnabled?: BooleanOptional;
}
export type CacheClusterIdList = String[];
export type CacheClusterList = CacheCluster[];
export interface CacheClusterMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of clusters. Each item in the list contains detailed information about one cluster.
*/
CacheClusters?: CacheClusterList;
}
export interface CacheEngineVersion {
/**
* The name of the cache engine.
*/
Engine?: String;
/**
* The version number of the cache engine.
*/
EngineVersion?: String;
/**
* The name of the cache parameter group family associated with this cache engine. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
*/
CacheParameterGroupFamily?: String;
/**
* The description of the cache engine.
*/
CacheEngineDescription?: String;
/**
* The description of the cache engine version.
*/
CacheEngineVersionDescription?: String;
}
export type CacheEngineVersionList = CacheEngineVersion[];
export interface CacheEngineVersionMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
*/
CacheEngineVersions?: CacheEngineVersionList;
}
export interface CacheNode {
/**
* The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
*/
CacheNodeId?: String;
/**
* The current state of this cache node.
*/
CacheNodeStatus?: String;
/**
* The date and time when the cache node was created.
*/
CacheNodeCreateTime?: TStamp;
/**
* The hostname for connecting to this cache node.
*/
Endpoint?: Endpoint;
/**
* The status of the parameter group applied to this cache node.
*/
ParameterGroupStatus?: String;
/**
* The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
*/
SourceCacheNodeId?: String;
/**
* The Availability Zone where this node was created and now resides.
*/
CustomerAvailabilityZone?: String;
}
export type CacheNodeIdsList = String[];
export type CacheNodeList = CacheNode[];
export interface CacheNodeTypeSpecificParameter {
/**
* The name of the parameter.
*/
ParameterName?: String;
/**
* A description of the parameter.
*/
Description?: String;
/**
* The source of the parameter value.
*/
Source?: String;
/**
* The valid data type for the parameter.
*/
DataType?: String;
/**
* 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 cache engine version to which the parameter can apply.
*/
MinimumEngineVersion?: String;
/**
* A list of cache node types and their corresponding values for this parameter.
*/
CacheNodeTypeSpecificValues?: CacheNodeTypeSpecificValueList;
/**
* Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
*/
ChangeType?: ChangeType;
}
export type CacheNodeTypeSpecificParametersList = CacheNodeTypeSpecificParameter[];
export interface CacheNodeTypeSpecificValue {
/**
* The cache node type for which this value applies.
*/
CacheNodeType?: String;
/**
* The value for the cache node type.
*/
Value?: String;
}
export type CacheNodeTypeSpecificValueList = CacheNodeTypeSpecificValue[];
export interface CacheNodeUpdateStatus {
/**
* The node ID of the cache cluster
*/
CacheNodeId?: String;
/**
* The update status of the node
*/
NodeUpdateStatus?: NodeUpdateStatus;
/**
* The deletion date of the node
*/
NodeDeletionDate?: TStamp;
/**
* The start date of the update for a node
*/
NodeUpdateStartDate?: TStamp;
/**
* The end date of the update for a node
*/
NodeUpdateEndDate?: TStamp;
/**
* Reflects whether the update was initiated by the customer or automatically applied
*/
NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy;
/**
* The date when the update is triggered
*/
NodeUpdateInitiatedDate?: TStamp;
/**
* The date when the NodeUpdateStatus was last modified>
*/
NodeUpdateStatusModifiedDate?: TStamp;
}
export type CacheNodeUpdateStatusList = CacheNodeUpdateStatus[];
export interface CacheParameterGroup {
/**
* The name of the cache parameter group.
*/
CacheParameterGroupName?: String;
/**
* The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
*/
CacheParameterGroupFamily?: String;
/**
* The description for this cache parameter group.
*/
Description?: String;
}
export interface CacheParameterGroupDetails {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of Parameter instances.
*/
Parameters?: ParametersList;
/**
* A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
*/
CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList;
}
export type CacheParameterGroupList = CacheParameterGroup[];
export interface CacheParameterGroupNameMessage {
/**
* The name of the cache parameter group.
*/
CacheParameterGroupName?: String;
}
export interface CacheParameterGroupStatus {
/**
* The name of the cache parameter group.
*/
CacheParameterGroupName?: String;
/**
* The status of parameter updates.
*/
ParameterApplyStatus?: String;
/**
* A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
*/
CacheNodeIdsToReboot?: CacheNodeIdsList;
}
export interface CacheParameterGroupsMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
*/
CacheParameterGroups?: CacheParameterGroupList;
}
export interface CacheSecurityGroup {
/**
* The AWS account ID of the cache security group owner.
*/
OwnerId?: String;
/**
* The name of the cache security group.
*/
CacheSecurityGroupName?: String;
/**
* The description of the cache security group.
*/
Description?: String;
/**
* A list of Amazon EC2 security groups that are associated with this cache security group.
*/
EC2SecurityGroups?: EC2SecurityGroupList;
}
export interface CacheSecurityGroupMembership {
/**
* The name of the cache security group.
*/
CacheSecurityGroupName?: String;
/**
* The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
*/
Status?: String;
}
export type CacheSecurityGroupMembershipList = CacheSecurityGroupMembership[];
export interface CacheSecurityGroupMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of cache security groups. Each element in the list contains detailed information about one group.
*/
CacheSecurityGroups?: CacheSecurityGroups;
}
export type CacheSecurityGroupNameList = String[];
export type CacheSecurityGroups = CacheSecurityGroup[];
export interface CacheSubnetGroup {
/**
* The name of the cache subnet group.
*/
CacheSubnetGroupName?: String;
/**
* The description of the cache subnet group.
*/
CacheSubnetGroupDescription?: String;
/**
* The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
*/
VpcId?: String;
/**
* A list of subnets associated with the cache subnet group.
*/
Subnets?: SubnetList;
}
export interface CacheSubnetGroupMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of cache subnet groups. Each element in the list contains detailed information about one group.
*/
CacheSubnetGroups?: CacheSubnetGroups;
}
export type CacheSubnetGroups = CacheSubnetGroup[];
export type ChangeType = "immediate"|"requires-reboot"|string;
export type ClusterIdList = String[];
export interface CompleteMigrationMessage {
/**
* The ID of the replication group to which data is being migrated.
*/
ReplicationGroupId: String;
/**
* Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
*/
Force?: Boolean;
}
export interface CompleteMigrationResponse {
ReplicationGroup?: ReplicationGroup;
}
export interface ConfigureShard {
/**
* The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
*/
NodeGroupId: AllowedNodeGroupId;
/**
* The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with. The minimum number of replicas in a shard or replication group is: Redis (cluster mode disabled) If Multi-AZ with Automatic Failover is enabled: 1 If Multi-AZ with Automatic Failover is not enable: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
*/
NewReplicaCount: Integer;
/**
* A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.
*/
PreferredAvailabilityZones?: PreferredAvailabilityZoneList;
}
export interface CopySnapshotMessage {
/**
* The name of an existing snapshot from which to make a copy.
*/
SourceSnapshotName: String;
/**
* A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
*/
TargetSnapshotName: String;
/**
* The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide. For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
*/
TargetBucket?: String;
/**
* The ID of the KMS key used to encrypt the target snapshot.
*/
KmsKeyId?: String;
}
export interface CopySnapshotResult {
Snapshot?: Snapshot;
}
export interface CreateCacheClusterMessage {
/**
* The node group (shard) identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 50 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
*/
CacheClusterId: String;
/**
* The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones. This parameter is only valid if the Engine parameter is redis.
*/
ReplicationGroupId?: String;
/**
* Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. This parameter is only supported for Memcached clusters. If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
*/
AZMode?: AZMode;
/**
* The EC2 Availability Zone in which the cluster is created. All nodes belonging to this Memcached cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones. Default: System chosen Availability Zone.
*/
PreferredAvailabilityZone?: String;
/**
* A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important. This option is only supported on Memcached. If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheNodes. If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones.
*/
PreferredAvailabilityZones?: PreferredAvailabilityZoneList;
/**
* The initial number of cache nodes that the cluster has. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
*/
NumCacheNodes?: IntegerOptional;
/**
* The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The name of the cache engine to be used for this cluster. Valid values for this parameter are: memcached | redis
*/
Engine?: String;
/**
* The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
*/
EngineVersion?: String;
/**
* The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
*/
CacheParameterGroupName?: String;
/**
* The name of the subnet group to be used for the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC). If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
*/
CacheSubnetGroupName?: String;
/**
* A list of security group names to associate with this cluster. Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
*/
CacheSecurityGroupNames?: CacheSecurityGroupNameList;
/**
* One or more VPC security groups associated with the cluster. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
*/
SecurityGroupIds?: SecurityGroupIdsList;
/**
* A list of cost allocation tags to be added to this resource.
*/
Tags?: TagList;
/**
* A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas. This parameter is only valid if the Engine parameter is redis. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
*/
SnapshotArns?: SnapshotArnsList;
/**
* The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created. This parameter is only valid if the Engine parameter is redis.
*/
SnapshotName?: String;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
*/
PreferredMaintenanceWindow?: String;
/**
* The port number on which each of the cache nodes accepts connections.
*/
Port?: IntegerOptional;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
*/
NotificationTopicArn?: String;
/**
* This parameter is currently disabled.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted. This parameter is only valid if the Engine parameter is redis. Default: 0 (i.e., automatic backups are disabled for this cache cluster).
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.
*/
SnapshotWindow?: String;
/**
* Reserved parameter. The password used to access a password protected server. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH.
*/
AuthToken?: String;
}
export interface CreateCacheClusterResult {
CacheCluster?: CacheCluster;
}
export interface CreateCacheParameterGroupMessage {
/**
* A user-specified name for the cache parameter group.
*/
CacheParameterGroupName: String;
/**
* The name of the cache parameter group family that the cache parameter group can be used with. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
*/
CacheParameterGroupFamily: String;
/**
* A user-specified description for the cache parameter group.
*/
Description: String;
}
export interface CreateCacheParameterGroupResult {
CacheParameterGroup?: CacheParameterGroup;
}
export interface CreateCacheSecurityGroupMessage {
/**
* A name for the cache security group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default". Example: mysecuritygroup
*/
CacheSecurityGroupName: String;
/**
* A description for the cache security group.
*/
Description: String;
}
export interface CreateCacheSecurityGroupResult {
CacheSecurityGroup?: CacheSecurityGroup;
}
export interface CreateCacheSubnetGroupMessage {
/**
* A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup
*/
CacheSubnetGroupName: String;
/**
* A description for the cache subnet group.
*/
CacheSubnetGroupDescription: String;
/**
* A list of VPC subnet IDs for the cache subnet group.
*/
SubnetIds: SubnetIdentifierList;
}
export interface CreateCacheSubnetGroupResult {
CacheSubnetGroup?: CacheSubnetGroup;
}
export interface CreateReplicationGroupMessage {
/**
* The replication group identifier. This parameter is stored as a lowercase string. Constraints: A name must contain from 1 to 40 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.
*/
ReplicationGroupId: String;
/**
* A user-created description for the replication group.
*/
ReplicationGroupDescription: String;
/**
* The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
*/
PrimaryClusterId?: String;
/**
* Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. Default: false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 node types. Redis (cluster mode enabled): T1 node types.
*/
AutomaticFailoverEnabled?: BooleanOptional;
/**
* The number of clusters this replication group initially has. This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead. If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6. The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
*/
NumCacheClusters?: IntegerOptional;
/**
* A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of NumCacheClusters. Default: system chosen Availability Zones.
*/
PreferredCacheClusterAZs?: AvailabilityZonesList;
/**
* An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. Default: 1
*/
NumNodeGroups?: IntegerOptional;
/**
* An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
*/
ReplicasPerNodeGroup?: IntegerOptional;
/**
* A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots. If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group (shard) using this parameter because you must specify the slots for each node group.
*/
NodeGroupConfiguration?: NodeGroupConfigurationList;
/**
* The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The name of the cache engine to be used for the clusters in this replication group.
*/
Engine?: String;
/**
* The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
*/
EngineVersion?: String;
/**
* The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0. If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2. To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
*/
CacheParameterGroupName?: String;
/**
* The name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
*/
CacheSubnetGroupName?: String;
/**
* A list of cache security group names to associate with this replication group.
*/
CacheSecurityGroupNames?: CacheSecurityGroupNameList;
/**
* One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
*/
SecurityGroupIds?: SecurityGroupIdsList;
/**
* A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
*/
Tags?: TagList;
/**
* A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here. Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
*/
SnapshotArns?: SnapshotArnsList;
/**
* The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
*/
SnapshotName?: String;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
*/
PreferredMaintenanceWindow?: String;
/**
* The port number on which each member of the replication group accepts connections.
*/
Port?: IntegerOptional;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner.
*/
NotificationTopicArn?: String;
/**
* This parameter is currently disabled.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Default: 0 (i.e., automatic backups are disabled for this cluster).
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
*/
SnapshotWindow?: String;
/**
* Reserved parameter. The password used to access a password protected server. AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. Password constraints: Must be only printable ASCII characters. Must be at least 16 characters and no more than 128 characters in length. The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token. For more information, see AUTH password at http://redis.io/commands/AUTH.
*/
AuthToken?: String;
/**
* A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
*/
TransitEncryptionEnabled?: BooleanOptional;
/**
* A flag that enables encryption at rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false
*/
AtRestEncryptionEnabled?: BooleanOptional;
/**
* The ID of the KMS key used to encrypt the disk on the cluster.
*/
KmsKeyId?: String;
}
export interface CreateReplicationGroupResult {
ReplicationGroup?: ReplicationGroup;
}
export interface CreateSnapshotMessage {
/**
* The identifier of an existing replication group. The snapshot is created from this replication group.
*/
ReplicationGroupId?: String;
/**
* The identifier of an existing cluster. The snapshot is created from this cluster.
*/
CacheClusterId?: String;
/**
* A name for the snapshot being created.
*/
SnapshotName: String;
/**
* The ID of the KMS key used to encrypt the snapshot.
*/
KmsKeyId?: String;
}
export interface CreateSnapshotResult {
Snapshot?: Snapshot;
}
export interface CustomerNodeEndpoint {
/**
* The address of the node endpoint
*/
Address?: String;
/**
* The port of the node endpoint
*/
Port?: IntegerOptional;
}
export type CustomerNodeEndpointList = CustomerNodeEndpoint[];
export interface DecreaseReplicaCountMessage {
/**
* The id of the replication group from which you want to remove replica nodes.
*/
ReplicationGroupId: String;
/**
* The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups. The minimum number of replicas in a shard or replication group is: Redis (cluster mode disabled) If Multi-AZ with Automatic Failover is enabled: 1 If Multi-AZ with Automatic Failover is not enabled: 0 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
*/
NewReplicaCount?: IntegerOptional;
/**
* A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
*/
ReplicaConfiguration?: ReplicaConfigurationList;
/**
* A list of the node ids to remove from the replication group or node group (shard).
*/
ReplicasToRemove?: RemoveReplicasList;
/**
* If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
*/
ApplyImmediately: Boolean;
}
export interface DecreaseReplicaCountResult {
ReplicationGroup?: ReplicationGroup;
}
export interface DeleteCacheClusterMessage {
/**
* The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
*/
CacheClusterId: String;
/**
* The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
*/
FinalSnapshotIdentifier?: String;
}
export interface DeleteCacheClusterResult {
CacheCluster?: CacheCluster;
}
export interface DeleteCacheParameterGroupMessage {
/**
* The name of the cache parameter group to delete. The specified cache security group must not be associated with any clusters.
*/
CacheParameterGroupName: String;
}
export interface DeleteCacheSecurityGroupMessage {
/**
* The name of the cache security group to delete. You cannot delete the default security group.
*/
CacheSecurityGroupName: String;
}
export interface DeleteCacheSubnetGroupMessage {
/**
* The name of the cache subnet group to delete. Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
*/
CacheSubnetGroupName: String;
}
export interface DeleteReplicationGroupMessage {
/**
* The identifier for the cluster to be deleted. This parameter is not case sensitive.
*/
ReplicationGroupId: String;
/**
* If set to true, all of the read replicas are deleted, but the primary node is retained.
*/
RetainPrimaryCluster?: BooleanOptional;
/**
* The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
*/
FinalSnapshotIdentifier?: String;
}
export interface DeleteReplicationGroupResult {
ReplicationGroup?: ReplicationGroup;
}
export interface DeleteSnapshotMessage {
/**
* The name of the snapshot to be deleted.
*/
SnapshotName: String;
}
export interface DeleteSnapshotResult {
Snapshot?: Snapshot;
}
export interface DescribeCacheClustersMessage {
/**
* The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.
*/
CacheClusterId?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
*/
ShowCacheNodeInfo?: BooleanOptional;
/**
* An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.
*/
ShowCacheClustersNotInReplicationGroups?: BooleanOptional;
}
export interface DescribeCacheEngineVersionsMessage {
/**
* The cache engine to return. Valid values: memcached | redis
*/
Engine?: String;
/**
* The cache engine version to return. Example: 1.4.14
*/
EngineVersion?: String;
/**
* The name of a specific cache parameter group family to return details for. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
*/
CacheParameterGroupFamily?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
*/
DefaultOnly?: Boolean;
}
export interface DescribeCacheParameterGroupsMessage {
/**
* The name of a specific cache parameter group to return details for.
*/
CacheParameterGroupName?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeCacheParametersMessage {
/**
* The name of a specific cache parameter group to return details for.
*/
CacheParameterGroupName: String;
/**
* The parameter types to return. Valid values: user | system | engine-default
*/
Source?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeCacheSecurityGroupsMessage {
/**
* The name of the cache security group to return details for.
*/
CacheSecurityGroupName?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeCacheSubnetGroupsMessage {
/**
* The name of the cache subnet group to return details for.
*/
CacheSubnetGroupName?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEngineDefaultParametersMessage {
/**
* The name of the cache parameter group family. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
*/
CacheParameterGroupFamily: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeEngineDefaultParametersResult {
EngineDefaults?: EngineDefaults;
}
export interface DescribeEventsMessage {
/**
* The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
*/
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: 2017-03-30T07:03:49.555Z
*/
StartTime?: TStamp;
/**
* The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
*/
EndTime?: TStamp;
/**
* The number of minutes worth of events to retrieve.
*/
Duration?: IntegerOptional;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReplicationGroupsMessage {
/**
* The identifier for the replication group to be described. This parameter is not case sensitive. If you do not specify this parameter, information about all replication groups is returned.
*/
ReplicationGroupId?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReservedCacheNodesMessage {
/**
* The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
*/
ReservedCacheNodeId?: String;
/**
* The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
*/
ReservedCacheNodesOfferingId?: String;
/**
* The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
*/
Duration?: String;
/**
* The product description filter value. Use this parameter to show only those reservations matching the specified product description.
*/
ProductDescription?: String;
/**
* The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
*/
OfferingType?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeReservedCacheNodesOfferingsMessage {
/**
* The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
ReservedCacheNodesOfferingId?: String;
/**
* The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration. Valid Values: 1 | 3 | 31536000 | 94608000
*/
Duration?: String;
/**
* The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
*/
ProductDescription?: String;
/**
* The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"
*/
OfferingType?: String;
/**
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeServiceUpdatesMessage {
/**
* The unique ID of the service update
*/
ServiceUpdateName?: String;
/**
* The status of the service update
*/
ServiceUpdateStatus?: ServiceUpdateStatusList;
/**
* The maximum number of records to include in the response
*/
MaxRecords?: IntegerOptional;
/**
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export interface DescribeSnapshotsListMessage {
/**
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 snapshots. Each item in the list contains detailed information about one snapshot.
*/
Snapshots?: SnapshotList;
}
export interface DescribeSnapshotsMessage {
/**
* A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
*/
ReplicationGroupId?: String;
/**
* A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
*/
CacheClusterId?: String;
/**
* A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
*/
SnapshotName?: String;
/**
* If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
*/
SnapshotSource?: String;
/**
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.
*/
MaxRecords?: IntegerOptional;
/**
* A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
*/
ShowNodeGroupConfig?: BooleanOptional;
}
export interface DescribeUpdateActionsMessage {
/**
* The unique ID of the service update
*/
ServiceUpdateName?: String;
/**
* The replication group IDs
*/
ReplicationGroupIds?: ReplicationGroupIdList;
/**
* The cache cluster IDs
*/
CacheClusterIds?: CacheClusterIdList;
/**
* The Elasticache engine to which the update applies. Either Redis or Memcached
*/
Engine?: String;
/**
* The status of the service update
*/
ServiceUpdateStatus?: ServiceUpdateStatusList;
/**
* The range of time specified to search for service updates that are in available status
*/
ServiceUpdateTimeRange?: TimeRangeFilter;
/**
* The status of the update action.
*/
UpdateActionStatus?: UpdateActionStatusList;
/**
* Dictates whether to include node level update status in the response
*/
ShowNodeLevelUpdateStatus?: BooleanOptional;
/**
* The maximum number of records to include in the response
*/
MaxRecords?: IntegerOptional;
/**
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
}
export type Double = number;
export interface EC2SecurityGroup {
/**
* The status of the Amazon EC2 security group.
*/
Status?: String;
/**
* The name of the Amazon EC2 security group.
*/
EC2SecurityGroupName?: String;
/**
* The AWS account ID of the Amazon EC2 security group owner.
*/
EC2SecurityGroupOwnerId?: String;
}
export type EC2SecurityGroupList = EC2SecurityGroup[];
export interface Endpoint {
/**
* The DNS hostname of the cache node.
*/
Address?: String;
/**
* The port number that the cache engine is listening on.
*/
Port?: Integer;
}
export interface EngineDefaults {
/**
* Specifies the name of the cache parameter group family to which the engine default parameters apply. Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
*/
CacheParameterGroupFamily?: String;
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* Contains a list of engine default parameters.
*/
Parameters?: ParametersList;
/**
* A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
*/
CacheNodeTypeSpecificParameters?: CacheNodeTypeSpecificParametersList;
}
export interface Event {
/**
* The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
*/
SourceIdentifier?: String;
/**
* Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
*/
SourceType?: SourceType;
/**
* The text of the event.
*/
Message?: String;
/**
* The date and time when the event occurred.
*/
Date?: TStamp;
}
export type EventList = Event[];
export interface EventsMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of events. Each element in the list contains detailed information about one event.
*/
Events?: EventList;
}
export interface IncreaseReplicaCountMessage {
/**
* The id of the replication group to which you want to add replica nodes.
*/
ReplicationGroupId: String;
/**
* The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
*/
NewReplicaCount?: IntegerOptional;
/**
* A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
*/
ReplicaConfiguration?: ReplicaConfigurationList;
/**
* If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.
*/
ApplyImmediately: Boolean;
}
export interface IncreaseReplicaCountResult {
ReplicationGroup?: ReplicationGroup;
}
export type Integer = number;
export type IntegerOptional = number;
export type KeyList = String[];
export interface ListAllowedNodeTypeModificationsMessage {
/**
* The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to. You must provide a value for either the CacheClusterId or the ReplicationGroupId.
*/
CacheClusterId?: String;
/**
* The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to. You must provide a value for either the CacheClusterId or the ReplicationGroupId.
*/
ReplicationGroupId?: String;
}
export interface ListTagsForResourceMessage {
/**
* The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*/
ResourceName: String;
}
export interface ModifyCacheClusterMessage {
/**
* The cluster identifier. This value is stored as a lowercase string.
*/
CacheClusterId: String;
/**
* The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled. If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20. Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately). A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
*/
NumCacheNodes?: IntegerOptional;
/**
* A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request. For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
*/
CacheNodeIdsToRemove?: CacheNodeIdsList;
/**
* Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones. Valid values: single-az | cross-az. This option is only supported for Memcached clusters. You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes are located in different Availability Zones.
*/
AZMode?: AZMode;
/**
* The list of Availability Zones where the new Memcached cache nodes are created. This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request. This option is only supported on Memcached clusters. Scenarios: Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes. Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node. Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations. The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached. Impact of new add/remove requests upon pending requests Scenario-1 Pending Action: Delete New Request: Delete Result: The new delete, pending or immediate, replaces the pending delete. Scenario-2 Pending Action: Delete New Request: Create Result: The new create, pending or immediate, replaces the pending delete. Scenario-3 Pending Action: Create New Request: Delete Result: The new delete, pending or immediate, replaces the pending create. Scenario-4 Pending Action: Create New Request: Create Result: The new create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
*/
NewAvailabilityZones?: PreferredAvailabilityZoneList;
/**
* A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible. You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
*/
CacheSecurityGroupNames?: CacheSecurityGroupNameList;
/**
* Specifies the VPC Security Groups associated with the cluster. This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
*/
SecurityGroupIds?: SecurityGroupIdsList;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
*/
PreferredMaintenanceWindow?: String;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the cluster owner.
*/
NotificationTopicArn?: String;
/**
* The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
*/
CacheParameterGroupName?: String;
/**
* The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Valid values: active | inactive
*/
NotificationTopicStatus?: String;
/**
* If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. Valid values: true | false Default: false
*/
ApplyImmediately?: Boolean;
/**
* The upgraded version of the cache engine to be run on the cache nodes. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
*/
EngineVersion?: String;
/**
* This parameter is currently disabled.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
*/
SnapshotWindow?: String;
/**
* A valid cache node type that you want to scale this cluster up to.
*/
CacheNodeType?: String;
/**
* Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints: Must be only printable ASCII characters Must be at least 16 characters and no more than 128 characters in length Cannot contain any of the following characters: '/', '"', or '@', '%' For more information, see AUTH password at AUTH.
*/
AuthToken?: String;
/**
* Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: Rotate Set For more information, see Authenticating Users with Redis AUTH
*/
AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType;
}
export interface ModifyCacheClusterResult {
CacheCluster?: CacheCluster;
}
export interface ModifyCacheParameterGroupMessage {
/**
* The name of the cache parameter group to modify.
*/
CacheParameterGroupName: String;
/**
* An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
*/
ParameterNameValues: ParameterNameValueList;
}
export interface ModifyCacheSubnetGroupMessage {
/**
* The name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Example: mysubnetgroup
*/
CacheSubnetGroupName: String;
/**
* A description of the cache subnet group.
*/
CacheSubnetGroupDescription?: String;
/**
* The EC2 subnet IDs for the cache subnet group.
*/
SubnetIds?: SubnetIdentifierList;
}
export interface ModifyCacheSubnetGroupResult {
CacheSubnetGroup?: CacheSubnetGroup;
}
export interface ModifyReplicationGroupMessage {
/**
* The identifier of the replication group to modify.
*/
ReplicationGroupId: String;
/**
* A description for the replication group. Maximum length is 255 characters.
*/
ReplicationGroupDescription?: String;
/**
* For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
*/
PrimaryClusterId?: String;
/**
* The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
*/
SnapshottingClusterId?: String;
/**
* Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. Valid values: true | false Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 node types. Redis (cluster mode enabled): T1 node types.
*/
AutomaticFailoverEnabled?: BooleanOptional;
/**
* Deprecated. This parameter is not used.
*/
NodeGroupId?: String;
/**
* A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible. This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC). Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
*/
CacheSecurityGroupNames?: CacheSecurityGroupNameList;
/**
* Specifies the VPC Security Groups associated with the clusters in the replication group. This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
*/
SecurityGroupIds?: SecurityGroupIdsList;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
*/
PreferredMaintenanceWindow?: String;
/**
* The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the replication group owner.
*/
NotificationTopicArn?: String;
/**
* The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
*/
CacheParameterGroupName?: String;
/**
* The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. Valid values: active | inactive
*/
NotificationTopicStatus?: String;
/**
* If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group. If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. Valid values: true | false Default: false
*/
ApplyImmediately?: Boolean;
/**
* The upgraded version of the cache engine to be run on the clusters in the replication group. Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
*/
EngineVersion?: String;
/**
* This parameter is currently disabled.
*/
AutoMinorVersionUpgrade?: BooleanOptional;
/**
* The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId. Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
*/
SnapshotWindow?: String;
/**
* A valid cache node type that you want to scale this replication group to.
*/
CacheNodeType?: String;
/**
* Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints: Must be only printable ASCII characters Must be at least 16 characters and no more than 128 characters in length Cannot contain any of the following characters: '/', '"', or '@', '%' For more information, see AUTH password at AUTH.
*/
AuthToken?: String;
/**
* Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: Rotate Set For more information, see Authenticating Users with Redis AUTH
*/
AuthTokenUpdateStrategy?: AuthTokenUpdateStrategyType;
}
export interface ModifyReplicationGroupResult {
ReplicationGroup?: ReplicationGroup;
}
export interface ModifyReplicationGroupShardConfigurationMessage {
/**
* The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
*/
ReplicationGroupId: String;
/**
* The number of node groups (shards) that results from the modification of the shard configuration.
*/
NodeGroupCount: Integer;
/**
* Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. Value: true
*/
ApplyImmediately: Boolean;
/**
* Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you. You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).
*/
ReshardingConfiguration?: ReshardingConfigurationList;
/**
* If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
*/
NodeGroupsToRemove?: NodeGroupsToRemoveList;
/**
* If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster. ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
*/
NodeGroupsToRetain?: NodeGroupsToRetainList;
}
export interface ModifyReplicationGroupShardConfigurationResult {
ReplicationGroup?: ReplicationGroup;
}
export interface NodeGroup {
/**
* The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
*/
NodeGroupId?: String;
/**
* The current state of this replication group - creating, available, etc.
*/
Status?: String;
/**
* The endpoint of the primary node in this node group (shard).
*/
PrimaryEndpoint?: Endpoint;
/**
* The endpoint of the replica nodes in this node group (shard).
*/
ReaderEndpoint?: Endpoint;
/**
* The keyspace for this node group (shard).
*/
Slots?: String;
/**
* A list containing information about individual nodes within the node group (shard).
*/
NodeGroupMembers?: NodeGroupMemberList;
}
export interface NodeGroupConfiguration {
/**
* Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
*/
NodeGroupId?: AllowedNodeGroupId;
/**
* A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey. Example: "0-3999"
*/
Slots?: String;
/**
* The number of read replica nodes in this node group (shard).
*/
ReplicaCount?: IntegerOptional;
/**
* The Availability Zone where the primary node of this node group (shard) is launched.
*/
PrimaryAvailabilityZone?: String;
/**
* A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
*/
ReplicaAvailabilityZones?: AvailabilityZonesList;
}
export type NodeGroupConfigurationList = NodeGroupConfiguration[];
export type NodeGroupList = NodeGroup[];
export interface NodeGroupMember {
/**
* The ID of the cluster to which the node belongs.
*/
CacheClusterId?: String;
/**
* The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
*/
CacheNodeId?: String;
/**
* The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
*/
ReadEndpoint?: Endpoint;
/**
* The name of the Availability Zone in which the node is located.
*/
PreferredAvailabilityZone?: String;
/**
* The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
*/
CurrentRole?: String;
}
export type NodeGroupMemberList = NodeGroupMember[];
export interface NodeGroupMemberUpdateStatus {
/**
* The cache cluster ID
*/
CacheClusterId?: String;
/**
* The node ID of the cache cluster
*/
CacheNodeId?: String;
/**
* The update status of the node
*/
NodeUpdateStatus?: NodeUpdateStatus;
/**
* The deletion date of the node
*/
NodeDeletionDate?: TStamp;
/**
* The start date of the update for a node
*/
NodeUpdateStartDate?: TStamp;
/**
* The end date of the update for a node
*/
NodeUpdateEndDate?: TStamp;
/**
* Reflects whether the update was initiated by the customer or automatically applied
*/
NodeUpdateInitiatedBy?: NodeUpdateInitiatedBy;
/**
* The date when the update is triggered
*/
NodeUpdateInitiatedDate?: TStamp;
/**
* The date when the NodeUpdateStatus was last modified
*/
NodeUpdateStatusModifiedDate?: TStamp;
}
export type NodeGroupMemberUpdateStatusList = NodeGroupMemberUpdateStatus[];
export interface NodeGroupUpdateStatus {
/**
* The ID of the node group
*/
NodeGroupId?: String;
/**
* The status of the service update on the node group member
*/
NodeGroupMemberUpdateStatus?: NodeGroupMemberUpdateStatusList;
}
export type NodeGroupUpdateStatusList = NodeGroupUpdateStatus[];
export type NodeGroupsToRemoveList = AllowedNodeGroupId[];
export type NodeGroupsToRetainList = AllowedNodeGroupId[];
export interface NodeSnapshot {
/**
* A unique identifier for the source cluster.
*/
CacheClusterId?: String;
/**
* A unique identifier for the source node group (shard).
*/
NodeGroupId?: String;
/**
* The cache node identifier for the node in the source cluster.
*/
CacheNodeId?: String;
/**
* The configuration for the source node group (shard).
*/
NodeGroupConfiguration?: NodeGroupConfiguration;
/**
* The size of the cache on the source cache node.
*/
CacheSize?: String;
/**
* The date and time when the cache node was created in the source cluster.
*/
CacheNodeCreateTime?: TStamp;
/**
* The date and time when the source node's metadata and cache data set was obtained for the snapshot.
*/
SnapshotCreateTime?: TStamp;
}
export type NodeSnapshotList = NodeSnapshot[];
export type NodeTypeList = String[];
export type NodeUpdateInitiatedBy = "system"|"customer"|string;
export type NodeUpdateStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|string;
export interface NotificationConfiguration {
/**
* The Amazon Resource Name (ARN) that identifies the topic.
*/
TopicArn?: String;
/**
* The current state of the topic.
*/
TopicStatus?: String;
}
export interface Parameter {
/**
* The name of the parameter.
*/
ParameterName?: String;
/**
* The value of the parameter.
*/
ParameterValue?: String;
/**
* A description of the parameter.
*/
Description?: String;
/**
* The source of the parameter.
*/
Source?: String;
/**
* The valid data type for the parameter.
*/
DataType?: String;
/**
* 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 cache engine version to which the parameter can apply.
*/
MinimumEngineVersion?: String;
/**
* Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
*/
ChangeType?: ChangeType;
}
export interface ParameterNameValue {
/**
* The name of the parameter.
*/
ParameterName?: String;
/**
* The value of the parameter.
*/
ParameterValue?: String;
}
export type ParameterNameValueList = ParameterNameValue[];
export type ParametersList = Parameter[];
export type PendingAutomaticFailoverStatus = "enabled"|"disabled"|string;
export interface PendingModifiedValues {
/**
* The new number of cache nodes for the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
*/
NumCacheNodes?: IntegerOptional;
/**
* A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
*/
CacheNodeIdsToRemove?: CacheNodeIdsList;
/**
* The new cache engine version that the cluster runs.
*/
EngineVersion?: String;
/**
* The cache node type that this cluster or replication group is scaled to.
*/
CacheNodeType?: String;
/**
* The auth token status
*/
AuthTokenStatus?: AuthTokenUpdateStatus;
}
export type PreferredAvailabilityZoneList = String[];
export interface ProcessedUpdateAction {
/**
* The ID of the replication group
*/
ReplicationGroupId?: String;
/**
* The ID of the cache cluster
*/
CacheClusterId?: String;
/**
* The unique ID of the service update
*/
ServiceUpdateName?: String;
/**
* The status of the update action on the Redis cluster
*/
UpdateActionStatus?: UpdateActionStatus;
}
export type ProcessedUpdateActionList = ProcessedUpdateAction[];
export interface PurchaseReservedCacheNodesOfferingMessage {
/**
* The ID of the reserved cache node offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
*/
ReservedCacheNodesOfferingId: String;
/**
* A customer-specified identifier to track this reservation. The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation. Example: myreservationID
*/
ReservedCacheNodeId?: String;
/**
* The number of cache node instances to reserve. Default: 1
*/
CacheNodeCount?: IntegerOptional;
}
export interface PurchaseReservedCacheNodesOfferingResult {
ReservedCacheNode?: ReservedCacheNode;
}
export interface RebootCacheClusterMessage {
/**
* The cluster identifier. This parameter is stored as a lowercase string.
*/
CacheClusterId: String;
/**
* A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
*/
CacheNodeIdsToReboot: CacheNodeIdsList;
}
export interface RebootCacheClusterResult {
CacheCluster?: CacheCluster;
}
export interface RecurringCharge {
/**
* The monetary amount of the recurring charge.
*/
RecurringChargeAmount?: Double;
/**
* The frequency of the recurring charge.
*/
RecurringChargeFrequency?: String;
}
export type RecurringChargeList = RecurringCharge[];
export type RemoveReplicasList = String[];
export interface RemoveTagsFromResourceMessage {
/**
* The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
*/
ResourceName: String;
/**
* A list of TagKeys identifying the tags you want removed from the named resource.
*/
TagKeys: KeyList;
}
export type ReplicaConfigurationList = ConfigureShard[];
export interface ReplicationGroup {
/**
* The identifier for the replication group.
*/
ReplicationGroupId?: String;
/**
* The user supplied description of the replication group.
*/
Description?: String;
/**
* The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
*/
Status?: String;
/**
* A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
*/
PendingModifiedValues?: ReplicationGroupPendingModifiedValues;
/**
* The names of all the cache clusters that are part of this replication group.
*/
MemberClusters?: ClusterIdList;
/**
* A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
*/
NodeGroups?: NodeGroupList;
/**
* The cluster ID that is used as the daily snapshot source for the replication group.
*/
SnapshottingClusterId?: String;
/**
* Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 node types. Redis (cluster mode enabled): T1 node types.
*/
AutomaticFailover?: AutomaticFailoverStatus;
/**
* The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
*/
ConfigurationEndpoint?: Endpoint;
/**
* The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: 05:00-09:00 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. This parameter is only valid if the Engine parameter is redis.
*/
SnapshotWindow?: String;
/**
* A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). Valid values: true | false
*/
ClusterEnabled?: BooleanOptional;
/**
* The name of the compute and memory capacity node type for each node in the replication group.
*/
CacheNodeType?: String;
/**
* A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false
*/
AuthTokenEnabled?: BooleanOptional;
/**
* The date the auth token was last modified
*/
AuthTokenLastModifiedDate?: TStamp;
/**
* A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false
*/
TransitEncryptionEnabled?: BooleanOptional;
/**
* A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false
*/
AtRestEncryptionEnabled?: BooleanOptional;
/**
* The ID of the KMS key used to encrypt the disk in the cluster.
*/
KmsKeyId?: String;
}
export type ReplicationGroupIdList = String[];
export type ReplicationGroupList = ReplicationGroup[];
export interface ReplicationGroupMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of replication groups. Each item in the list contains detailed information about one replication group.
*/
ReplicationGroups?: ReplicationGroupList;
}
export interface ReplicationGroupPendingModifiedValues {
/**
* The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
*/
PrimaryClusterId?: String;
/**
* Indicates the status of Multi-AZ with automatic failover for this Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 node types. Redis (cluster mode enabled): T1 node types.
*/
AutomaticFailoverStatus?: PendingAutomaticFailoverStatus;
/**
* The status of an online resharding operation.
*/
Resharding?: ReshardingStatus;
/**
* The auth token status
*/
AuthTokenStatus?: AuthTokenUpdateStatus;
}
export interface ReservedCacheNode {
/**
* The unique identifier for the reservation.
*/
ReservedCacheNodeId?: String;
/**
* The offering identifier.
*/
ReservedCacheNodesOfferingId?: String;
/**
* The cache node type for the reserved cache nodes. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The time the reservation started.
*/
StartTime?: TStamp;
/**
* The duration of the reservation in seconds.
*/
Duration?: Integer;
/**
* The fixed price charged for this reserved cache node.
*/
FixedPrice?: Double;
/**
* The hourly price charged for this reserved cache node.
*/
UsagePrice?: Double;
/**
* The number of cache nodes that have been reserved.
*/
CacheNodeCount?: Integer;
/**
* The description of the reserved cache node.
*/
ProductDescription?: String;
/**
* The offering type of this reserved cache node.
*/
OfferingType?: String;
/**
* The state of the reserved cache node.
*/
State?: String;
/**
* The recurring price charged to run this reserved cache node.
*/
RecurringCharges?: RecurringChargeList;
/**
* The Amazon Resource Name (ARN) of the reserved cache node. Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
*/
ReservationARN?: String;
}
export type ReservedCacheNodeList = ReservedCacheNode[];
export interface ReservedCacheNodeMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of reserved cache nodes. Each element in the list contains detailed information about one node.
*/
ReservedCacheNodes?: ReservedCacheNodeList;
}
export interface ReservedCacheNodesOffering {
/**
* A unique identifier for the reserved cache node offering.
*/
ReservedCacheNodesOfferingId?: String;
/**
* The cache node type for the reserved cache node. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The duration of the offering. in seconds.
*/
Duration?: Integer;
/**
* The fixed price charged for this offering.
*/
FixedPrice?: Double;
/**
* The hourly price charged for this offering.
*/
UsagePrice?: Double;
/**
* The cache engine used by the offering.
*/
ProductDescription?: String;
/**
* The offering type.
*/
OfferingType?: String;
/**
* The recurring price charged to run this reserved cache node.
*/
RecurringCharges?: RecurringChargeList;
}
export type ReservedCacheNodesOfferingList = ReservedCacheNodesOffering[];
export interface ReservedCacheNodesOfferingMessage {
/**
* Provides an identifier to allow retrieval of paginated results.
*/
Marker?: String;
/**
* A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
*/
ReservedCacheNodesOfferings?: ReservedCacheNodesOfferingList;
}
export interface ResetCacheParameterGroupMessage {
/**
* The name of the cache parameter group to reset.
*/
CacheParameterGroupName: String;
/**
* If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values. Valid values: true | false
*/
ResetAllParameters?: Boolean;
/**
* An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.
*/
ParameterNameValues?: ParameterNameValueList;
}
export interface ReshardingConfiguration {
/**
* Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
*/
NodeGroupId?: AllowedNodeGroupId;
/**
* A list of preferred availability zones for the nodes in this cluster.
*/
PreferredAvailabilityZones?: AvailabilityZonesList;
}
export type ReshardingConfigurationList = ReshardingConfiguration[];
export interface ReshardingStatus {
/**
* Represents the progress of an online resharding operation.
*/
SlotMigration?: SlotMigration;
}
export interface RevokeCacheSecurityGroupIngressMessage {
/**
* The name of the cache security group to revoke ingress from.
*/
CacheSecurityGroupName: String;
/**
* The name of the Amazon EC2 security group to revoke access from.
*/
EC2SecurityGroupName: String;
/**
* The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.
*/
EC2SecurityGroupOwnerId: String;
}
export interface RevokeCacheSecurityGroupIngressResult {
CacheSecurityGroup?: CacheSecurityGroup;
}
export type SecurityGroupIdsList = String[];
export interface SecurityGroupMembership {
/**
* The identifier of the cache security group.
*/
SecurityGroupId?: String;
/**
* The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
*/
Status?: String;
}
export type SecurityGroupMembershipList = SecurityGroupMembership[];
export interface ServiceUpdate {
/**
* The unique ID of the service update
*/
ServiceUpdateName?: String;
/**
* The date when the service update is initially available
*/
ServiceUpdateReleaseDate?: TStamp;
/**
* The date after which the service update is no longer available
*/
ServiceUpdateEndDate?: TStamp;
/**
* The severity of the service update
*/
ServiceUpdateSeverity?: ServiceUpdateSeverity;
/**
* The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
*/
ServiceUpdateRecommendedApplyByDate?: TStamp;
/**
* The status of the service update
*/
ServiceUpdateStatus?: ServiceUpdateStatus;
/**
* Provides details of the service update
*/
ServiceUpdateDescription?: String;
/**
* Reflects the nature of the service update
*/
ServiceUpdateType?: ServiceUpdateType;
/**
* The Elasticache engine to which the update applies. Either Redis or Memcached
*/
Engine?: String;
/**
* The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
*/
EngineVersion?: String;
/**
* Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
*/
AutoUpdateAfterRecommendedApplyByDate?: BooleanOptional;
/**
* The estimated length of time the service update will take
*/
EstimatedUpdateTime?: String;
}
export type ServiceUpdateList = ServiceUpdate[];
export type ServiceUpdateSeverity = "critical"|"important"|"medium"|"low"|string;
export type ServiceUpdateStatus = "available"|"cancelled"|"expired"|string;
export type ServiceUpdateStatusList = ServiceUpdateStatus[];
export type ServiceUpdateType = "security-update"|string;
export interface ServiceUpdatesMessage {
/**
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 service updates
*/
ServiceUpdates?: ServiceUpdateList;
}
export type SlaMet = "yes"|"no"|"n/a"|string;
export interface SlotMigration {
/**
* The percentage of the slot migration that is complete.
*/
ProgressPercentage?: Double;
}
export interface Snapshot {
/**
* The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
*/
SnapshotName?: String;
/**
* The unique identifier of the source replication group.
*/
ReplicationGroupId?: String;
/**
* A description of the source replication group.
*/
ReplicationGroupDescription?: String;
/**
* The user-supplied identifier of the source cluster.
*/
CacheClusterId?: String;
/**
* The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
*/
SnapshotStatus?: String;
/**
* Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
*/
SnapshotSource?: String;
/**
* The name of the compute and memory capacity node type for the source cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
*/
CacheNodeType?: String;
/**
* The name of the cache engine (memcached or redis) used by the source cluster.
*/
Engine?: String;
/**
* The version of the cache engine version that is used by the source cluster.
*/
EngineVersion?: String;
/**
* The number of cache nodes in the source cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
*/
NumCacheNodes?: IntegerOptional;
/**
* The name of the Availability Zone in which the source cluster is located.
*/
PreferredAvailabilityZone?: String;
/**
* The date and time when the source cluster was created.
*/
CacheClusterCreateTime?: TStamp;
/**
* Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30
*/
PreferredMaintenanceWindow?: String;
/**
* The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
*/
TopicArn?: String;
/**
* The port number used by each cache nodes in the source cluster.
*/
Port?: IntegerOptional;
/**
* The cache parameter group that is associated with the source cluster.
*/
CacheParameterGroupName?: String;
/**
* The name of the cache subnet group associated with the source cluster.
*/
CacheSubnetGroupName?: String;
/**
* The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
*/
VpcId?: String;
/**
* This parameter is currently disabled.
*/
AutoMinorVersionUpgrade?: Boolean;
/**
* For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
*/
SnapshotRetentionLimit?: IntegerOptional;
/**
* The daily time range during which ElastiCache takes daily snapshots of the source cluster.
*/
SnapshotWindow?: String;
/**
* The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
*/
NumNodeGroups?: IntegerOptional;
/**
* Indicates the status of Multi-AZ with automatic failover for the source Redis replication group. Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on: Redis versions earlier than 2.8.6. Redis (cluster mode disabled): T1 node types. Redis (cluster mode enabled): T1 node types.
*/
AutomaticFailover?: AutomaticFailoverStatus;
/**
* A list of the cache nodes in the source cluster.
*/
NodeSnapshots?: NodeSnapshotList;
/**
* The ID of the KMS key used to encrypt the snapshot.
*/
KmsKeyId?: String;
}
export type SnapshotArnsList = String[];
export type SnapshotList = Snapshot[];
export type SourceType = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|string;
export interface StartMigrationMessage {
/**
* The ID of the replication group to which data should be migrated.
*/
ReplicationGroupId: String;
/**
* List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
*/
CustomerNodeEndpointList: CustomerNodeEndpointList;
}
export interface StartMigrationResponse {
ReplicationGroup?: ReplicationGroup;
}
export type String = string;
export interface Subnet {
/**
* The unique identifier for the subnet.
*/
SubnetIdentifier?: String;
/**
* The Availability Zone associated with the subnet.
*/
SubnetAvailabilityZone?: AvailabilityZone;
}
export type SubnetIdentifierList = String[];
export type SubnetList = Subnet[];
export type TStamp = Date;
export interface Tag {
/**
* The key for the tag. May not be null.
*/
Key?: String;
/**
* The tag's value. May be null.
*/
Value?: String;
}
export type TagList = Tag[];
export interface TagListMessage {
/**
* A list of cost allocation tags as key-value pairs.
*/
TagList?: TagList;
}
export interface TestFailoverMessage {
/**
* The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
*/
ReplicationGroupId: String;
/**
* The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
*/
NodeGroupId: AllowedNodeGroupId;
}
export interface TestFailoverResult {
ReplicationGroup?: ReplicationGroup;
}
export interface TimeRangeFilter {
/**
* The start time of the time range filter
*/
StartTime?: TStamp;
/**
* The end time of the time range filter
*/
EndTime?: TStamp;
}
export interface UnprocessedUpdateAction {
/**
* The replication group ID
*/
ReplicationGroupId?: String;
/**
* The ID of the cache cluster
*/
CacheClusterId?: String;
/**
* The unique ID of the service update
*/
ServiceUpdateName?: String;
/**
* The error type for requests that are not processed
*/
ErrorType?: String;
/**
* The error message that describes the reason the request was not processed
*/
ErrorMessage?: String;
}
export type UnprocessedUpdateActionList = UnprocessedUpdateAction[];
export interface UpdateAction {
/**
* The ID of the replication group
*/
ReplicationGroupId?: String;
/**
* The ID of the cache cluster
*/
CacheClusterId?: String;
/**
* The unique ID of the service update
*/
ServiceUpdateName?: String;
/**
* The date the update is first available
*/
ServiceUpdateReleaseDate?: TStamp;
/**
* The severity of the service update
*/
ServiceUpdateSeverity?: ServiceUpdateSeverity;
/**
* The status of the service update
*/
ServiceUpdateStatus?: ServiceUpdateStatus;
/**
* The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
*/
ServiceUpdateRecommendedApplyByDate?: TStamp;
/**
* Reflects the nature of the service update
*/
ServiceUpdateType?: ServiceUpdateType;
/**
* The date that the service update is available to a replication group
*/
UpdateActionAvailableDate?: TStamp;
/**
* The status of the update action
*/
UpdateActionStatus?: UpdateActionStatus;
/**
* The progress of the service update on the replication group
*/
NodesUpdated?: String;
/**
* The date when the UpdateActionStatus was last modified
*/
UpdateActionStatusModifiedDate?: TStamp;
/**
* If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
*/
SlaMet?: SlaMet;
/**
* The status of the service update on the node group
*/
NodeGroupUpdateStatus?: NodeGroupUpdateStatusList;
/**
* The status of the service update on the cache node
*/
CacheNodeUpdateStatus?: CacheNodeUpdateStatusList;
/**
* The estimated length of time for the update to complete
*/
EstimatedUpdateTime?: String;
/**
* The Elasticache engine to which the update applies. Either Redis or Memcached
*/
Engine?: String;
}
export type UpdateActionList = UpdateAction[];
export interface UpdateActionResultsMessage {
/**
* Update actions that have been processed successfully
*/
ProcessedUpdateActions?: ProcessedUpdateActionList;
/**
* Update actions that haven't been processed successfully
*/
UnprocessedUpdateActions?: UnprocessedUpdateActionList;
}
export type UpdateActionStatus = "not-applied"|"waiting-to-start"|"in-progress"|"stopping"|"stopped"|"complete"|string;
export type UpdateActionStatusList = UpdateActionStatus[];
export interface UpdateActionsMessage {
/**
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
*/
Marker?: String;
/**
* Returns a list of update actions
*/
UpdateActions?: UpdateActionList;
}
/**
* 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 = "2012-11-15"|"2014-03-24"|"2014-07-15"|"2014-09-30"|"2015-02-02"|"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 ElastiCache client.
*/
export import Types = ElastiCache;
}
export = ElastiCache;