lightsail.d.ts
353 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Lightsail extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Lightsail.Types.ClientConfiguration)
config: Config & Lightsail.Types.ClientConfiguration;
/**
* Allocates a static IP address.
*/
allocateStaticIp(params: Lightsail.Types.AllocateStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.AllocateStaticIpResult) => void): Request<Lightsail.Types.AllocateStaticIpResult, AWSError>;
/**
* Allocates a static IP address.
*/
allocateStaticIp(callback?: (err: AWSError, data: Lightsail.Types.AllocateStaticIpResult) => void): Request<Lightsail.Types.AllocateStaticIpResult, AWSError>;
/**
* Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate. Use the CreateCertificate action to create a certificate that you can attach to your distribution. Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
*/
attachCertificateToDistribution(params: Lightsail.Types.AttachCertificateToDistributionRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachCertificateToDistributionResult) => void): Request<Lightsail.Types.AttachCertificateToDistributionResult, AWSError>;
/**
* Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate. Use the CreateCertificate action to create a certificate that you can attach to your distribution. Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
*/
attachCertificateToDistribution(callback?: (err: AWSError, data: Lightsail.Types.AttachCertificateToDistributionResult) => void): Request<Lightsail.Types.AttachCertificateToDistributionResult, AWSError>;
/**
* Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
*/
attachDisk(params: Lightsail.Types.AttachDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachDiskResult) => void): Request<Lightsail.Types.AttachDiskResult, AWSError>;
/**
* Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name. The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
*/
attachDisk(callback?: (err: AWSError, data: Lightsail.Types.AttachDiskResult) => void): Request<Lightsail.Types.AttachDiskResult, AWSError>;
/**
* Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
attachInstancesToLoadBalancer(params: Lightsail.Types.AttachInstancesToLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachInstancesToLoadBalancerResult) => void): Request<Lightsail.Types.AttachInstancesToLoadBalancerResult, AWSError>;
/**
* Attaches one or more Lightsail instances to a load balancer. After some time, the instances are attached to the load balancer and the health check status is available. The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
attachInstancesToLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.AttachInstancesToLoadBalancerResult) => void): Request<Lightsail.Types.AttachInstancesToLoadBalancerResult, AWSError>;
/**
* Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
attachLoadBalancerTlsCertificate(params: Lightsail.Types.AttachLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.AttachLoadBalancerTlsCertificateResult, AWSError>;
/**
* Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
attachLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.AttachLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.AttachLoadBalancerTlsCertificateResult, AWSError>;
/**
* Attaches a static IP address to a specific Amazon Lightsail instance.
*/
attachStaticIp(params: Lightsail.Types.AttachStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachStaticIpResult) => void): Request<Lightsail.Types.AttachStaticIpResult, AWSError>;
/**
* Attaches a static IP address to a specific Amazon Lightsail instance.
*/
attachStaticIp(callback?: (err: AWSError, data: Lightsail.Types.AttachStaticIpResult) => void): Request<Lightsail.Types.AttachStaticIpResult, AWSError>;
/**
* Closes ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
*/
closeInstancePublicPorts(params: Lightsail.Types.CloseInstancePublicPortsRequest, callback?: (err: AWSError, data: Lightsail.Types.CloseInstancePublicPortsResult) => void): Request<Lightsail.Types.CloseInstancePublicPortsResult, AWSError>;
/**
* Closes ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
*/
closeInstancePublicPorts(callback?: (err: AWSError, data: Lightsail.Types.CloseInstancePublicPortsResult) => void): Request<Lightsail.Types.CloseInstancePublicPortsResult, AWSError>;
/**
* Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail. When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters. When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.
*/
copySnapshot(params: Lightsail.Types.CopySnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CopySnapshotResult) => void): Request<Lightsail.Types.CopySnapshotResult, AWSError>;
/**
* Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail. When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters. When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.
*/
copySnapshot(callback?: (err: AWSError, data: Lightsail.Types.CopySnapshotResult) => void): Request<Lightsail.Types.CopySnapshotResult, AWSError>;
/**
* Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution. After the certificate is created, use the AttachCertificateToDistribution action to attach the certificate to your distribution. Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
*/
createCertificate(params: Lightsail.Types.CreateCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateCertificateResult) => void): Request<Lightsail.Types.CreateCertificateResult, AWSError>;
/**
* Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution. After the certificate is created, use the AttachCertificateToDistribution action to attach the certificate to your distribution. Only certificates created in the us-east-1 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
*/
createCertificate(callback?: (err: AWSError, data: Lightsail.Types.CreateCertificateResult) => void): Request<Lightsail.Types.CreateCertificateResult, AWSError>;
/**
* Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.
*/
createCloudFormationStack(params: Lightsail.Types.CreateCloudFormationStackRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateCloudFormationStackResult) => void): Request<Lightsail.Types.CreateCloudFormationStackResult, AWSError>;
/**
* Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.
*/
createCloudFormationStack(callback?: (err: AWSError, data: Lightsail.Types.CreateCloudFormationStackResult) => void): Request<Lightsail.Types.CreateCloudFormationStackResult, AWSError>;
/**
* Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
*/
createContactMethod(params: Lightsail.Types.CreateContactMethodRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateContactMethodResult) => void): Request<Lightsail.Types.CreateContactMethodResult, AWSError>;
/**
* Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
*/
createContactMethod(callback?: (err: AWSError, data: Lightsail.Types.CreateContactMethodResult) => void): Request<Lightsail.Types.CreateContactMethodResult, AWSError>;
/**
* Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createDisk(params: Lightsail.Types.CreateDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDiskResult) => void): Request<Lightsail.Types.CreateDiskResult, AWSError>;
/**
* Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createDisk(callback?: (err: AWSError, data: Lightsail.Types.CreateDiskResult) => void): Request<Lightsail.Types.CreateDiskResult, AWSError>;
/**
* Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.
*/
createDiskFromSnapshot(params: Lightsail.Types.CreateDiskFromSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDiskFromSnapshotResult) => void): Request<Lightsail.Types.CreateDiskFromSnapshotResult, AWSError>;
/**
* Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.
*/
createDiskFromSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateDiskFromSnapshotResult) => void): Request<Lightsail.Types.CreateDiskFromSnapshotResult, AWSError>;
/**
* Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createDiskSnapshot(params: Lightsail.Types.CreateDiskSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDiskSnapshotResult) => void): Request<Lightsail.Types.CreateDiskSnapshotResult, AWSError>;
/**
* Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance. You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending. You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk. The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateDiskSnapshotResult) => void): Request<Lightsail.Types.CreateDiskSnapshotResult, AWSError>;
/**
* Creates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
*/
createDistribution(params: Lightsail.Types.CreateDistributionRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDistributionResult) => void): Request<Lightsail.Types.CreateDistributionResult, AWSError>;
/**
* Creates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
*/
createDistribution(callback?: (err: AWSError, data: Lightsail.Types.CreateDistributionResult) => void): Request<Lightsail.Types.CreateDistributionResult, AWSError>;
/**
* Creates a domain resource for the specified domain (e.g., example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createDomain(params: Lightsail.Types.CreateDomainRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDomainResult) => void): Request<Lightsail.Types.CreateDomainResult, AWSError>;
/**
* Creates a domain resource for the specified domain (e.g., example.com). The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createDomain(callback?: (err: AWSError, data: Lightsail.Types.CreateDomainResult) => void): Request<Lightsail.Types.CreateDomainResult, AWSError>;
/**
* Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
createDomainEntry(params: Lightsail.Types.CreateDomainEntryRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateDomainEntryResult) => void): Request<Lightsail.Types.CreateDomainEntryResult, AWSError>;
/**
* Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
createDomainEntry(callback?: (err: AWSError, data: Lightsail.Types.CreateDomainEntryResult) => void): Request<Lightsail.Types.CreateDomainEntryResult, AWSError>;
/**
* Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createInstanceSnapshot(params: Lightsail.Types.CreateInstanceSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateInstanceSnapshotResult) => void): Request<Lightsail.Types.CreateInstanceSnapshotResult, AWSError>;
/**
* Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createInstanceSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateInstanceSnapshotResult) => void): Request<Lightsail.Types.CreateInstanceSnapshotResult, AWSError>;
/**
* Creates one or more Amazon Lightsail instances. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createInstances(params: Lightsail.Types.CreateInstancesRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesResult) => void): Request<Lightsail.Types.CreateInstancesResult, AWSError>;
/**
* Creates one or more Amazon Lightsail instances. The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createInstances(callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesResult) => void): Request<Lightsail.Types.CreateInstancesResult, AWSError>;
/**
* Creates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.
*/
createInstancesFromSnapshot(params: Lightsail.Types.CreateInstancesFromSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesFromSnapshotResult) => void): Request<Lightsail.Types.CreateInstancesFromSnapshotResult, AWSError>;
/**
* Creates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.
*/
createInstancesFromSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateInstancesFromSnapshotResult) => void): Request<Lightsail.Types.CreateInstancesFromSnapshotResult, AWSError>;
/**
* Creates an SSH key pair. The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createKeyPair(params: Lightsail.Types.CreateKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateKeyPairResult) => void): Request<Lightsail.Types.CreateKeyPairResult, AWSError>;
/**
* Creates an SSH key pair. The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createKeyPair(callback?: (err: AWSError, data: Lightsail.Types.CreateKeyPairResult) => void): Request<Lightsail.Types.CreateKeyPairResult, AWSError>;
/**
* Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createLoadBalancer(params: Lightsail.Types.CreateLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerResult) => void): Request<Lightsail.Types.CreateLoadBalancerResult, AWSError>;
/**
* Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerResult) => void): Request<Lightsail.Types.CreateLoadBalancerResult, AWSError>;
/**
* Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
createLoadBalancerTlsCertificate(params: Lightsail.Types.CreateLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.CreateLoadBalancerTlsCertificateResult, AWSError>;
/**
* Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
createLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.CreateLoadBalancerTlsCertificateResult, AWSError>;
/**
* Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createRelationalDatabase(params: Lightsail.Types.CreateRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseResult, AWSError>;
/**
* Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseResult, AWSError>;
/**
* Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
*/
createRelationalDatabaseFromSnapshot(params: Lightsail.Types.CreateRelationalDatabaseFromSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseFromSnapshotResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseFromSnapshotResult, AWSError>;
/**
* Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
*/
createRelationalDatabaseFromSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseFromSnapshotResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseFromSnapshotResult, AWSError>;
/**
* Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createRelationalDatabaseSnapshot(params: Lightsail.Types.CreateRelationalDatabaseSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseSnapshotResult, AWSError>;
/**
* Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
*/
createRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseSnapshotResult, AWSError>;
/**
* Deletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
*/
deleteAlarm(params: Lightsail.Types.DeleteAlarmRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteAlarmResult) => void): Request<Lightsail.Types.DeleteAlarmResult, AWSError>;
/**
* Deletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
*/
deleteAlarm(callback?: (err: AWSError, data: Lightsail.Types.DeleteAlarmResult) => void): Request<Lightsail.Types.DeleteAlarmResult, AWSError>;
/**
* Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
*/
deleteAutoSnapshot(params: Lightsail.Types.DeleteAutoSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteAutoSnapshotResult) => void): Request<Lightsail.Types.DeleteAutoSnapshotResult, AWSError>;
/**
* Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
*/
deleteAutoSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteAutoSnapshotResult) => void): Request<Lightsail.Types.DeleteAutoSnapshotResult, AWSError>;
/**
* Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution. Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.
*/
deleteCertificate(params: Lightsail.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteCertificateResult) => void): Request<Lightsail.Types.DeleteCertificateResult, AWSError>;
/**
* Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution. Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.
*/
deleteCertificate(callback?: (err: AWSError, data: Lightsail.Types.DeleteCertificateResult) => void): Request<Lightsail.Types.DeleteCertificateResult, AWSError>;
/**
* Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
*/
deleteContactMethod(params: Lightsail.Types.DeleteContactMethodRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteContactMethodResult) => void): Request<Lightsail.Types.DeleteContactMethodResult, AWSError>;
/**
* Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
*/
deleteContactMethod(callback?: (err: AWSError, data: Lightsail.Types.DeleteContactMethodResult) => void): Request<Lightsail.Types.DeleteContactMethodResult, AWSError>;
/**
* Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
*/
deleteDisk(params: Lightsail.Types.DeleteDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskResult) => void): Request<Lightsail.Types.DeleteDiskResult, AWSError>;
/**
* Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
*/
deleteDisk(callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskResult) => void): Request<Lightsail.Types.DeleteDiskResult, AWSError>;
/**
* Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.
*/
deleteDiskSnapshot(params: Lightsail.Types.DeleteDiskSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskSnapshotResult) => void): Request<Lightsail.Types.DeleteDiskSnapshotResult, AWSError>;
/**
* Deletes the specified disk snapshot. When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.
*/
deleteDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteDiskSnapshotResult) => void): Request<Lightsail.Types.DeleteDiskSnapshotResult, AWSError>;
/**
* Deletes your Amazon Lightsail content delivery network (CDN) distribution.
*/
deleteDistribution(params: Lightsail.Types.DeleteDistributionRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDistributionResult) => void): Request<Lightsail.Types.DeleteDistributionResult, AWSError>;
/**
* Deletes your Amazon Lightsail content delivery network (CDN) distribution.
*/
deleteDistribution(callback?: (err: AWSError, data: Lightsail.Types.DeleteDistributionResult) => void): Request<Lightsail.Types.DeleteDistributionResult, AWSError>;
/**
* Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
deleteDomain(params: Lightsail.Types.DeleteDomainRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainResult) => void): Request<Lightsail.Types.DeleteDomainResult, AWSError>;
/**
* Deletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
deleteDomain(callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainResult) => void): Request<Lightsail.Types.DeleteDomainResult, AWSError>;
/**
* Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
deleteDomainEntry(params: Lightsail.Types.DeleteDomainEntryRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainEntryResult) => void): Request<Lightsail.Types.DeleteDomainEntryResult, AWSError>;
/**
* Deletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
deleteDomainEntry(callback?: (err: AWSError, data: Lightsail.Types.DeleteDomainEntryResult) => void): Request<Lightsail.Types.DeleteDomainEntryResult, AWSError>;
/**
* Deletes an Amazon Lightsail instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
deleteInstance(params: Lightsail.Types.DeleteInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceResult) => void): Request<Lightsail.Types.DeleteInstanceResult, AWSError>;
/**
* Deletes an Amazon Lightsail instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
deleteInstance(callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceResult) => void): Request<Lightsail.Types.DeleteInstanceResult, AWSError>;
/**
* Deletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.
*/
deleteInstanceSnapshot(params: Lightsail.Types.DeleteInstanceSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceSnapshotResult) => void): Request<Lightsail.Types.DeleteInstanceSnapshotResult, AWSError>;
/**
* Deletes a specific snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.
*/
deleteInstanceSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteInstanceSnapshotResult) => void): Request<Lightsail.Types.DeleteInstanceSnapshotResult, AWSError>;
/**
* Deletes a specific SSH key pair. The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Lightsail Dev Guide.
*/
deleteKeyPair(params: Lightsail.Types.DeleteKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteKeyPairResult) => void): Request<Lightsail.Types.DeleteKeyPairResult, AWSError>;
/**
* Deletes a specific SSH key pair. The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Lightsail Dev Guide.
*/
deleteKeyPair(callback?: (err: AWSError, data: Lightsail.Types.DeleteKeyPairResult) => void): Request<Lightsail.Types.DeleteKeyPairResult, AWSError>;
/**
* Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
*/
deleteKnownHostKeys(params: Lightsail.Types.DeleteKnownHostKeysRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteKnownHostKeysResult) => void): Request<Lightsail.Types.DeleteKnownHostKeysResult, AWSError>;
/**
* Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
*/
deleteKnownHostKeys(callback?: (err: AWSError, data: Lightsail.Types.DeleteKnownHostKeysResult) => void): Request<Lightsail.Types.DeleteKnownHostKeysResult, AWSError>;
/**
* Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
deleteLoadBalancer(params: Lightsail.Types.DeleteLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerResult) => void): Request<Lightsail.Types.DeleteLoadBalancerResult, AWSError>;
/**
* Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
deleteLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerResult) => void): Request<Lightsail.Types.DeleteLoadBalancerResult, AWSError>;
/**
* Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
deleteLoadBalancerTlsCertificate(params: Lightsail.Types.DeleteLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.DeleteLoadBalancerTlsCertificateResult, AWSError>;
/**
* Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
deleteLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.DeleteLoadBalancerTlsCertificateResult, AWSError>;
/**
* Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
deleteRelationalDatabase(params: Lightsail.Types.DeleteRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseResult) => void): Request<Lightsail.Types.DeleteRelationalDatabaseResult, AWSError>;
/**
* Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
deleteRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseResult) => void): Request<Lightsail.Types.DeleteRelationalDatabaseResult, AWSError>;
/**
* Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
deleteRelationalDatabaseSnapshot(params: Lightsail.Types.DeleteRelationalDatabaseSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.DeleteRelationalDatabaseSnapshotResult, AWSError>;
/**
* Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
deleteRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.DeleteRelationalDatabaseSnapshotResult, AWSError>;
/**
* Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
*/
detachCertificateFromDistribution(params: Lightsail.Types.DetachCertificateFromDistributionRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachCertificateFromDistributionResult) => void): Request<Lightsail.Types.DetachCertificateFromDistributionResult, AWSError>;
/**
* Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
*/
detachCertificateFromDistribution(callback?: (err: AWSError, data: Lightsail.Types.DetachCertificateFromDistributionResult) => void): Request<Lightsail.Types.DetachCertificateFromDistributionResult, AWSError>;
/**
* Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
*/
detachDisk(params: Lightsail.Types.DetachDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachDiskResult) => void): Request<Lightsail.Types.DetachDiskResult, AWSError>;
/**
* Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
*/
detachDisk(callback?: (err: AWSError, data: Lightsail.Types.DetachDiskResult) => void): Request<Lightsail.Types.DetachDiskResult, AWSError>;
/**
* Detaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
detachInstancesFromLoadBalancer(params: Lightsail.Types.DetachInstancesFromLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachInstancesFromLoadBalancerResult) => void): Request<Lightsail.Types.DetachInstancesFromLoadBalancerResult, AWSError>;
/**
* Detaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
detachInstancesFromLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.DetachInstancesFromLoadBalancerResult) => void): Request<Lightsail.Types.DetachInstancesFromLoadBalancerResult, AWSError>;
/**
* Detaches a static IP from the Amazon Lightsail instance to which it is attached.
*/
detachStaticIp(params: Lightsail.Types.DetachStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.DetachStaticIpResult) => void): Request<Lightsail.Types.DetachStaticIpResult, AWSError>;
/**
* Detaches a static IP from the Amazon Lightsail instance to which it is attached.
*/
detachStaticIp(callback?: (err: AWSError, data: Lightsail.Types.DetachStaticIpResult) => void): Request<Lightsail.Types.DetachStaticIpResult, AWSError>;
/**
* Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
*/
disableAddOn(params: Lightsail.Types.DisableAddOnRequest, callback?: (err: AWSError, data: Lightsail.Types.DisableAddOnResult) => void): Request<Lightsail.Types.DisableAddOnResult, AWSError>;
/**
* Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
*/
disableAddOn(callback?: (err: AWSError, data: Lightsail.Types.DisableAddOnResult) => void): Request<Lightsail.Types.DisableAddOnResult, AWSError>;
/**
* Downloads the default SSH key pair from the user's account.
*/
downloadDefaultKeyPair(params: Lightsail.Types.DownloadDefaultKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.DownloadDefaultKeyPairResult) => void): Request<Lightsail.Types.DownloadDefaultKeyPairResult, AWSError>;
/**
* Downloads the default SSH key pair from the user's account.
*/
downloadDefaultKeyPair(callback?: (err: AWSError, data: Lightsail.Types.DownloadDefaultKeyPairResult) => void): Request<Lightsail.Types.DownloadDefaultKeyPairResult, AWSError>;
/**
* Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
*/
enableAddOn(params: Lightsail.Types.EnableAddOnRequest, callback?: (err: AWSError, data: Lightsail.Types.EnableAddOnResult) => void): Request<Lightsail.Types.EnableAddOnResult, AWSError>;
/**
* Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
*/
enableAddOn(callback?: (err: AWSError, data: Lightsail.Types.EnableAddOnResult) => void): Request<Lightsail.Types.EnableAddOnResult, AWSError>;
/**
* Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Lightsail Dev Guide. Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.
*/
exportSnapshot(params: Lightsail.Types.ExportSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.ExportSnapshotResult) => void): Request<Lightsail.Types.ExportSnapshotResult, AWSError>;
/**
* Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Lightsail Dev Guide. Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.
*/
exportSnapshot(callback?: (err: AWSError, data: Lightsail.Types.ExportSnapshotResult) => void): Request<Lightsail.Types.ExportSnapshotResult, AWSError>;
/**
* Returns the names of all active (not deleted) resources.
*/
getActiveNames(params: Lightsail.Types.GetActiveNamesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetActiveNamesResult) => void): Request<Lightsail.Types.GetActiveNamesResult, AWSError>;
/**
* Returns the names of all active (not deleted) resources.
*/
getActiveNames(callback?: (err: AWSError, data: Lightsail.Types.GetActiveNamesResult) => void): Request<Lightsail.Types.GetActiveNamesResult, AWSError>;
/**
* Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
*/
getAlarms(params: Lightsail.Types.GetAlarmsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetAlarmsResult) => void): Request<Lightsail.Types.GetAlarmsResult, AWSError>;
/**
* Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
*/
getAlarms(callback?: (err: AWSError, data: Lightsail.Types.GetAlarmsResult) => void): Request<Lightsail.Types.GetAlarmsResult, AWSError>;
/**
* Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
*/
getAutoSnapshots(params: Lightsail.Types.GetAutoSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetAutoSnapshotsResult) => void): Request<Lightsail.Types.GetAutoSnapshotsResult, AWSError>;
/**
* Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
*/
getAutoSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetAutoSnapshotsResult) => void): Request<Lightsail.Types.GetAutoSnapshotsResult, AWSError>;
/**
* Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
*/
getBlueprints(params: Lightsail.Types.GetBlueprintsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetBlueprintsResult) => void): Request<Lightsail.Types.GetBlueprintsResult, AWSError>;
/**
* Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
*/
getBlueprints(callback?: (err: AWSError, data: Lightsail.Types.GetBlueprintsResult) => void): Request<Lightsail.Types.GetBlueprintsResult, AWSError>;
/**
* Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
*/
getBundles(params: Lightsail.Types.GetBundlesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetBundlesResult) => void): Request<Lightsail.Types.GetBundlesResult, AWSError>;
/**
* Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
*/
getBundles(callback?: (err: AWSError, data: Lightsail.Types.GetBundlesResult) => void): Request<Lightsail.Types.GetBundlesResult, AWSError>;
/**
* Returns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
*/
getCertificates(params: Lightsail.Types.GetCertificatesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetCertificatesResult) => void): Request<Lightsail.Types.GetCertificatesResult, AWSError>;
/**
* Returns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
*/
getCertificates(callback?: (err: AWSError, data: Lightsail.Types.GetCertificatesResult) => void): Request<Lightsail.Types.GetCertificatesResult, AWSError>;
/**
* Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
*/
getCloudFormationStackRecords(params: Lightsail.Types.GetCloudFormationStackRecordsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetCloudFormationStackRecordsResult) => void): Request<Lightsail.Types.GetCloudFormationStackRecordsResult, AWSError>;
/**
* Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
*/
getCloudFormationStackRecords(callback?: (err: AWSError, data: Lightsail.Types.GetCloudFormationStackRecordsResult) => void): Request<Lightsail.Types.GetCloudFormationStackRecordsResult, AWSError>;
/**
* Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
*/
getContactMethods(params: Lightsail.Types.GetContactMethodsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetContactMethodsResult) => void): Request<Lightsail.Types.GetContactMethodsResult, AWSError>;
/**
* Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
*/
getContactMethods(callback?: (err: AWSError, data: Lightsail.Types.GetContactMethodsResult) => void): Request<Lightsail.Types.GetContactMethodsResult, AWSError>;
/**
* Returns information about a specific block storage disk.
*/
getDisk(params: Lightsail.Types.GetDiskRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskResult) => void): Request<Lightsail.Types.GetDiskResult, AWSError>;
/**
* Returns information about a specific block storage disk.
*/
getDisk(callback?: (err: AWSError, data: Lightsail.Types.GetDiskResult) => void): Request<Lightsail.Types.GetDiskResult, AWSError>;
/**
* Returns information about a specific block storage disk snapshot.
*/
getDiskSnapshot(params: Lightsail.Types.GetDiskSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotResult) => void): Request<Lightsail.Types.GetDiskSnapshotResult, AWSError>;
/**
* Returns information about a specific block storage disk snapshot.
*/
getDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotResult) => void): Request<Lightsail.Types.GetDiskSnapshotResult, AWSError>;
/**
* Returns information about all block storage disk snapshots in your AWS account and region.
*/
getDiskSnapshots(params: Lightsail.Types.GetDiskSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotsResult) => void): Request<Lightsail.Types.GetDiskSnapshotsResult, AWSError>;
/**
* Returns information about all block storage disk snapshots in your AWS account and region.
*/
getDiskSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotsResult) => void): Request<Lightsail.Types.GetDiskSnapshotsResult, AWSError>;
/**
* Returns information about all block storage disks in your AWS account and region.
*/
getDisks(params: Lightsail.Types.GetDisksRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDisksResult) => void): Request<Lightsail.Types.GetDisksResult, AWSError>;
/**
* Returns information about all block storage disks in your AWS account and region.
*/
getDisks(callback?: (err: AWSError, data: Lightsail.Types.GetDisksResult) => void): Request<Lightsail.Types.GetDisksResult, AWSError>;
/**
* Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
*/
getDistributionBundles(params: Lightsail.Types.GetDistributionBundlesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDistributionBundlesResult) => void): Request<Lightsail.Types.GetDistributionBundlesResult, AWSError>;
/**
* Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.
*/
getDistributionBundles(callback?: (err: AWSError, data: Lightsail.Types.GetDistributionBundlesResult) => void): Request<Lightsail.Types.GetDistributionBundlesResult, AWSError>;
/**
* Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
*/
getDistributionLatestCacheReset(params: Lightsail.Types.GetDistributionLatestCacheResetRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDistributionLatestCacheResetResult) => void): Request<Lightsail.Types.GetDistributionLatestCacheResetResult, AWSError>;
/**
* Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
*/
getDistributionLatestCacheReset(callback?: (err: AWSError, data: Lightsail.Types.GetDistributionLatestCacheResetResult) => void): Request<Lightsail.Types.GetDistributionLatestCacheResetResult, AWSError>;
/**
* Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getDistributionMetricData(params: Lightsail.Types.GetDistributionMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDistributionMetricDataResult) => void): Request<Lightsail.Types.GetDistributionMetricDataResult, AWSError>;
/**
* Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getDistributionMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetDistributionMetricDataResult) => void): Request<Lightsail.Types.GetDistributionMetricDataResult, AWSError>;
/**
* Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
*/
getDistributions(params: Lightsail.Types.GetDistributionsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDistributionsResult) => void): Request<Lightsail.Types.GetDistributionsResult, AWSError>;
/**
* Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
*/
getDistributions(callback?: (err: AWSError, data: Lightsail.Types.GetDistributionsResult) => void): Request<Lightsail.Types.GetDistributionsResult, AWSError>;
/**
* Returns information about a specific domain recordset.
*/
getDomain(params: Lightsail.Types.GetDomainRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDomainResult) => void): Request<Lightsail.Types.GetDomainResult, AWSError>;
/**
* Returns information about a specific domain recordset.
*/
getDomain(callback?: (err: AWSError, data: Lightsail.Types.GetDomainResult) => void): Request<Lightsail.Types.GetDomainResult, AWSError>;
/**
* Returns a list of all domains in the user's account.
*/
getDomains(params: Lightsail.Types.GetDomainsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDomainsResult) => void): Request<Lightsail.Types.GetDomainsResult, AWSError>;
/**
* Returns a list of all domains in the user's account.
*/
getDomains(callback?: (err: AWSError, data: Lightsail.Types.GetDomainsResult) => void): Request<Lightsail.Types.GetDomainsResult, AWSError>;
/**
* Returns the export snapshot record created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.
*/
getExportSnapshotRecords(params: Lightsail.Types.GetExportSnapshotRecordsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetExportSnapshotRecordsResult) => void): Request<Lightsail.Types.GetExportSnapshotRecordsResult, AWSError>;
/**
* Returns the export snapshot record created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.
*/
getExportSnapshotRecords(callback?: (err: AWSError, data: Lightsail.Types.GetExportSnapshotRecordsResult) => void): Request<Lightsail.Types.GetExportSnapshotRecordsResult, AWSError>;
/**
* Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
*/
getInstance(params: Lightsail.Types.GetInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceResult) => void): Request<Lightsail.Types.GetInstanceResult, AWSError>;
/**
* Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
*/
getInstance(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceResult) => void): Request<Lightsail.Types.GetInstanceResult, AWSError>;
/**
* Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
getInstanceAccessDetails(params: Lightsail.Types.GetInstanceAccessDetailsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceAccessDetailsResult) => void): Request<Lightsail.Types.GetInstanceAccessDetailsResult, AWSError>;
/**
* Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
getInstanceAccessDetails(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceAccessDetailsResult) => void): Request<Lightsail.Types.GetInstanceAccessDetailsResult, AWSError>;
/**
* Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getInstanceMetricData(params: Lightsail.Types.GetInstanceMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceMetricDataResult) => void): Request<Lightsail.Types.GetInstanceMetricDataResult, AWSError>;
/**
* Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getInstanceMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceMetricDataResult) => void): Request<Lightsail.Types.GetInstanceMetricDataResult, AWSError>;
/**
* Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
*/
getInstancePortStates(params: Lightsail.Types.GetInstancePortStatesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstancePortStatesResult) => void): Request<Lightsail.Types.GetInstancePortStatesResult, AWSError>;
/**
* Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
*/
getInstancePortStates(callback?: (err: AWSError, data: Lightsail.Types.GetInstancePortStatesResult) => void): Request<Lightsail.Types.GetInstancePortStatesResult, AWSError>;
/**
* Returns information about a specific instance snapshot.
*/
getInstanceSnapshot(params: Lightsail.Types.GetInstanceSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotResult) => void): Request<Lightsail.Types.GetInstanceSnapshotResult, AWSError>;
/**
* Returns information about a specific instance snapshot.
*/
getInstanceSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotResult) => void): Request<Lightsail.Types.GetInstanceSnapshotResult, AWSError>;
/**
* Returns all instance snapshots for the user's account.
*/
getInstanceSnapshots(params: Lightsail.Types.GetInstanceSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotsResult) => void): Request<Lightsail.Types.GetInstanceSnapshotsResult, AWSError>;
/**
* Returns all instance snapshots for the user's account.
*/
getInstanceSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceSnapshotsResult) => void): Request<Lightsail.Types.GetInstanceSnapshotsResult, AWSError>;
/**
* Returns the state of a specific instance. Works on one instance at a time.
*/
getInstanceState(params: Lightsail.Types.GetInstanceStateRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstanceStateResult) => void): Request<Lightsail.Types.GetInstanceStateResult, AWSError>;
/**
* Returns the state of a specific instance. Works on one instance at a time.
*/
getInstanceState(callback?: (err: AWSError, data: Lightsail.Types.GetInstanceStateResult) => void): Request<Lightsail.Types.GetInstanceStateResult, AWSError>;
/**
* Returns information about all Amazon Lightsail virtual private servers, or instances.
*/
getInstances(params: Lightsail.Types.GetInstancesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetInstancesResult) => void): Request<Lightsail.Types.GetInstancesResult, AWSError>;
/**
* Returns information about all Amazon Lightsail virtual private servers, or instances.
*/
getInstances(callback?: (err: AWSError, data: Lightsail.Types.GetInstancesResult) => void): Request<Lightsail.Types.GetInstancesResult, AWSError>;
/**
* Returns information about a specific key pair.
*/
getKeyPair(params: Lightsail.Types.GetKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairResult) => void): Request<Lightsail.Types.GetKeyPairResult, AWSError>;
/**
* Returns information about a specific key pair.
*/
getKeyPair(callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairResult) => void): Request<Lightsail.Types.GetKeyPairResult, AWSError>;
/**
* Returns information about all key pairs in the user's account.
*/
getKeyPairs(params: Lightsail.Types.GetKeyPairsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairsResult) => void): Request<Lightsail.Types.GetKeyPairsResult, AWSError>;
/**
* Returns information about all key pairs in the user's account.
*/
getKeyPairs(callback?: (err: AWSError, data: Lightsail.Types.GetKeyPairsResult) => void): Request<Lightsail.Types.GetKeyPairsResult, AWSError>;
/**
* Returns information about the specified Lightsail load balancer.
*/
getLoadBalancer(params: Lightsail.Types.GetLoadBalancerRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerResult) => void): Request<Lightsail.Types.GetLoadBalancerResult, AWSError>;
/**
* Returns information about the specified Lightsail load balancer.
*/
getLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerResult) => void): Request<Lightsail.Types.GetLoadBalancerResult, AWSError>;
/**
* Returns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getLoadBalancerMetricData(params: Lightsail.Types.GetLoadBalancerMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerMetricDataResult) => void): Request<Lightsail.Types.GetLoadBalancerMetricDataResult, AWSError>;
/**
* Returns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getLoadBalancerMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerMetricDataResult) => void): Request<Lightsail.Types.GetLoadBalancerMetricDataResult, AWSError>;
/**
* Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
*/
getLoadBalancerTlsCertificates(params: Lightsail.Types.GetLoadBalancerTlsCertificatesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerTlsCertificatesResult) => void): Request<Lightsail.Types.GetLoadBalancerTlsCertificatesResult, AWSError>;
/**
* Returns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
*/
getLoadBalancerTlsCertificates(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerTlsCertificatesResult) => void): Request<Lightsail.Types.GetLoadBalancerTlsCertificatesResult, AWSError>;
/**
* Returns information about all load balancers in an account.
*/
getLoadBalancers(params: Lightsail.Types.GetLoadBalancersRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancersResult) => void): Request<Lightsail.Types.GetLoadBalancersResult, AWSError>;
/**
* Returns information about all load balancers in an account.
*/
getLoadBalancers(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancersResult) => void): Request<Lightsail.Types.GetLoadBalancersResult, AWSError>;
/**
* Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
*/
getOperation(params: Lightsail.Types.GetOperationRequest, callback?: (err: AWSError, data: Lightsail.Types.GetOperationResult) => void): Request<Lightsail.Types.GetOperationResult, AWSError>;
/**
* Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
*/
getOperation(callback?: (err: AWSError, data: Lightsail.Types.GetOperationResult) => void): Request<Lightsail.Types.GetOperationResult, AWSError>;
/**
* Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.
*/
getOperations(params: Lightsail.Types.GetOperationsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetOperationsResult) => void): Request<Lightsail.Types.GetOperationsResult, AWSError>;
/**
* Returns information about all operations. Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.
*/
getOperations(callback?: (err: AWSError, data: Lightsail.Types.GetOperationsResult) => void): Request<Lightsail.Types.GetOperationsResult, AWSError>;
/**
* Gets operations for a specific resource (e.g., an instance or a static IP).
*/
getOperationsForResource(params: Lightsail.Types.GetOperationsForResourceRequest, callback?: (err: AWSError, data: Lightsail.Types.GetOperationsForResourceResult) => void): Request<Lightsail.Types.GetOperationsForResourceResult, AWSError>;
/**
* Gets operations for a specific resource (e.g., an instance or a static IP).
*/
getOperationsForResource(callback?: (err: AWSError, data: Lightsail.Types.GetOperationsForResourceResult) => void): Request<Lightsail.Types.GetOperationsForResourceResult, AWSError>;
/**
* Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.
*/
getRegions(params: Lightsail.Types.GetRegionsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRegionsResult) => void): Request<Lightsail.Types.GetRegionsResult, AWSError>;
/**
* Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.
*/
getRegions(callback?: (err: AWSError, data: Lightsail.Types.GetRegionsResult) => void): Request<Lightsail.Types.GetRegionsResult, AWSError>;
/**
* Returns information about a specific database in Amazon Lightsail.
*/
getRelationalDatabase(params: Lightsail.Types.GetRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseResult) => void): Request<Lightsail.Types.GetRelationalDatabaseResult, AWSError>;
/**
* Returns information about a specific database in Amazon Lightsail.
*/
getRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseResult) => void): Request<Lightsail.Types.GetRelationalDatabaseResult, AWSError>;
/**
* Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine.
*/
getRelationalDatabaseBlueprints(params: Lightsail.Types.GetRelationalDatabaseBlueprintsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBlueprintsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseBlueprintsResult, AWSError>;
/**
* Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a specific database engine.
*/
getRelationalDatabaseBlueprints(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBlueprintsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseBlueprintsResult, AWSError>;
/**
* Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications.
*/
getRelationalDatabaseBundles(params: Lightsail.Types.GetRelationalDatabaseBundlesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBundlesResult) => void): Request<Lightsail.Types.GetRelationalDatabaseBundlesResult, AWSError>;
/**
* Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database. You can use a bundle ID to create a new database with explicit performance specifications.
*/
getRelationalDatabaseBundles(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseBundlesResult) => void): Request<Lightsail.Types.GetRelationalDatabaseBundlesResult, AWSError>;
/**
* Returns a list of events for a specific database in Amazon Lightsail.
*/
getRelationalDatabaseEvents(params: Lightsail.Types.GetRelationalDatabaseEventsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseEventsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseEventsResult, AWSError>;
/**
* Returns a list of events for a specific database in Amazon Lightsail.
*/
getRelationalDatabaseEvents(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseEventsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseEventsResult, AWSError>;
/**
* Returns a list of log events for a database in Amazon Lightsail.
*/
getRelationalDatabaseLogEvents(params: Lightsail.Types.GetRelationalDatabaseLogEventsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogEventsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseLogEventsResult, AWSError>;
/**
* Returns a list of log events for a database in Amazon Lightsail.
*/
getRelationalDatabaseLogEvents(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogEventsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseLogEventsResult, AWSError>;
/**
* Returns a list of available log streams for a specific database in Amazon Lightsail.
*/
getRelationalDatabaseLogStreams(params: Lightsail.Types.GetRelationalDatabaseLogStreamsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogStreamsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseLogStreamsResult, AWSError>;
/**
* Returns a list of available log streams for a specific database in Amazon Lightsail.
*/
getRelationalDatabaseLogStreams(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseLogStreamsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseLogStreamsResult, AWSError>;
/**
* Returns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.
*/
getRelationalDatabaseMasterUserPassword(params: Lightsail.Types.GetRelationalDatabaseMasterUserPasswordRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMasterUserPasswordResult) => void): Request<Lightsail.Types.GetRelationalDatabaseMasterUserPasswordResult, AWSError>;
/**
* Returns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.
*/
getRelationalDatabaseMasterUserPassword(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMasterUserPasswordResult) => void): Request<Lightsail.Types.GetRelationalDatabaseMasterUserPasswordResult, AWSError>;
/**
* Returns the data points of the specified metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getRelationalDatabaseMetricData(params: Lightsail.Types.GetRelationalDatabaseMetricDataRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMetricDataResult) => void): Request<Lightsail.Types.GetRelationalDatabaseMetricDataResult, AWSError>;
/**
* Returns the data points of the specified metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
*/
getRelationalDatabaseMetricData(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseMetricDataResult) => void): Request<Lightsail.Types.GetRelationalDatabaseMetricDataResult, AWSError>;
/**
* Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
*/
getRelationalDatabaseParameters(params: Lightsail.Types.GetRelationalDatabaseParametersRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseParametersResult) => void): Request<Lightsail.Types.GetRelationalDatabaseParametersResult, AWSError>;
/**
* Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
*/
getRelationalDatabaseParameters(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseParametersResult) => void): Request<Lightsail.Types.GetRelationalDatabaseParametersResult, AWSError>;
/**
* Returns information about a specific database snapshot in Amazon Lightsail.
*/
getRelationalDatabaseSnapshot(params: Lightsail.Types.GetRelationalDatabaseSnapshotRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.GetRelationalDatabaseSnapshotResult, AWSError>;
/**
* Returns information about a specific database snapshot in Amazon Lightsail.
*/
getRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.GetRelationalDatabaseSnapshotResult, AWSError>;
/**
* Returns information about all of your database snapshots in Amazon Lightsail.
*/
getRelationalDatabaseSnapshots(params: Lightsail.Types.GetRelationalDatabaseSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseSnapshotsResult, AWSError>;
/**
* Returns information about all of your database snapshots in Amazon Lightsail.
*/
getRelationalDatabaseSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabaseSnapshotsResult) => void): Request<Lightsail.Types.GetRelationalDatabaseSnapshotsResult, AWSError>;
/**
* Returns information about all of your databases in Amazon Lightsail.
*/
getRelationalDatabases(params: Lightsail.Types.GetRelationalDatabasesRequest, callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabasesResult) => void): Request<Lightsail.Types.GetRelationalDatabasesResult, AWSError>;
/**
* Returns information about all of your databases in Amazon Lightsail.
*/
getRelationalDatabases(callback?: (err: AWSError, data: Lightsail.Types.GetRelationalDatabasesResult) => void): Request<Lightsail.Types.GetRelationalDatabasesResult, AWSError>;
/**
* Returns information about a specific static IP.
*/
getStaticIp(params: Lightsail.Types.GetStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpResult) => void): Request<Lightsail.Types.GetStaticIpResult, AWSError>;
/**
* Returns information about a specific static IP.
*/
getStaticIp(callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpResult) => void): Request<Lightsail.Types.GetStaticIpResult, AWSError>;
/**
* Returns information about all static IPs in the user's account.
*/
getStaticIps(params: Lightsail.Types.GetStaticIpsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpsResult) => void): Request<Lightsail.Types.GetStaticIpsResult, AWSError>;
/**
* Returns information about all static IPs in the user's account.
*/
getStaticIps(callback?: (err: AWSError, data: Lightsail.Types.GetStaticIpsResult) => void): Request<Lightsail.Types.GetStaticIpsResult, AWSError>;
/**
* Imports a public SSH key from a specific key pair.
*/
importKeyPair(params: Lightsail.Types.ImportKeyPairRequest, callback?: (err: AWSError, data: Lightsail.Types.ImportKeyPairResult) => void): Request<Lightsail.Types.ImportKeyPairResult, AWSError>;
/**
* Imports a public SSH key from a specific key pair.
*/
importKeyPair(callback?: (err: AWSError, data: Lightsail.Types.ImportKeyPairResult) => void): Request<Lightsail.Types.ImportKeyPairResult, AWSError>;
/**
* Returns a Boolean value indicating whether your Lightsail VPC is peered.
*/
isVpcPeered(params: Lightsail.Types.IsVpcPeeredRequest, callback?: (err: AWSError, data: Lightsail.Types.IsVpcPeeredResult) => void): Request<Lightsail.Types.IsVpcPeeredResult, AWSError>;
/**
* Returns a Boolean value indicating whether your Lightsail VPC is peered.
*/
isVpcPeered(callback?: (err: AWSError, data: Lightsail.Types.IsVpcPeeredResult) => void): Request<Lightsail.Types.IsVpcPeeredResult, AWSError>;
/**
* Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
*/
openInstancePublicPorts(params: Lightsail.Types.OpenInstancePublicPortsRequest, callback?: (err: AWSError, data: Lightsail.Types.OpenInstancePublicPortsResult) => void): Request<Lightsail.Types.OpenInstancePublicPortsResult, AWSError>;
/**
* Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
*/
openInstancePublicPorts(callback?: (err: AWSError, data: Lightsail.Types.OpenInstancePublicPortsResult) => void): Request<Lightsail.Types.OpenInstancePublicPortsResult, AWSError>;
/**
* Tries to peer the Lightsail VPC with the user's default VPC.
*/
peerVpc(params: Lightsail.Types.PeerVpcRequest, callback?: (err: AWSError, data: Lightsail.Types.PeerVpcResult) => void): Request<Lightsail.Types.PeerVpcResult, AWSError>;
/**
* Tries to peer the Lightsail VPC with the user's default VPC.
*/
peerVpc(callback?: (err: AWSError, data: Lightsail.Types.PeerVpcResult) => void): Request<Lightsail.Types.PeerVpcResult, AWSError>;
/**
* Creates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
*/
putAlarm(params: Lightsail.Types.PutAlarmRequest, callback?: (err: AWSError, data: Lightsail.Types.PutAlarmResult) => void): Request<Lightsail.Types.PutAlarmResult, AWSError>;
/**
* Creates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
*/
putAlarm(callback?: (err: AWSError, data: Lightsail.Types.PutAlarmResult) => void): Request<Lightsail.Types.PutAlarmResult, AWSError>;
/**
* Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports. The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
*/
putInstancePublicPorts(params: Lightsail.Types.PutInstancePublicPortsRequest, callback?: (err: AWSError, data: Lightsail.Types.PutInstancePublicPortsResult) => void): Request<Lightsail.Types.PutInstancePublicPortsResult, AWSError>;
/**
* Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports. The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
*/
putInstancePublicPorts(callback?: (err: AWSError, data: Lightsail.Types.PutInstancePublicPortsResult) => void): Request<Lightsail.Types.PutInstancePublicPortsResult, AWSError>;
/**
* Restarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
rebootInstance(params: Lightsail.Types.RebootInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.RebootInstanceResult) => void): Request<Lightsail.Types.RebootInstanceResult, AWSError>;
/**
* Restarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
rebootInstance(callback?: (err: AWSError, data: Lightsail.Types.RebootInstanceResult) => void): Request<Lightsail.Types.RebootInstanceResult, AWSError>;
/**
* Restarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
rebootRelationalDatabase(params: Lightsail.Types.RebootRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.RebootRelationalDatabaseResult) => void): Request<Lightsail.Types.RebootRelationalDatabaseResult, AWSError>;
/**
* Restarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
rebootRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.RebootRelationalDatabaseResult) => void): Request<Lightsail.Types.RebootRelationalDatabaseResult, AWSError>;
/**
* Deletes a specific static IP from your account.
*/
releaseStaticIp(params: Lightsail.Types.ReleaseStaticIpRequest, callback?: (err: AWSError, data: Lightsail.Types.ReleaseStaticIpResult) => void): Request<Lightsail.Types.ReleaseStaticIpResult, AWSError>;
/**
* Deletes a specific static IP from your account.
*/
releaseStaticIp(callback?: (err: AWSError, data: Lightsail.Types.ReleaseStaticIpResult) => void): Request<Lightsail.Types.ReleaseStaticIpResult, AWSError>;
/**
* Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
*/
resetDistributionCache(params: Lightsail.Types.ResetDistributionCacheRequest, callback?: (err: AWSError, data: Lightsail.Types.ResetDistributionCacheResult) => void): Request<Lightsail.Types.ResetDistributionCacheResult, AWSError>;
/**
* Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
*/
resetDistributionCache(callback?: (err: AWSError, data: Lightsail.Types.ResetDistributionCacheResult) => void): Request<Lightsail.Types.ResetDistributionCacheResult, AWSError>;
/**
* Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
*/
sendContactMethodVerification(params: Lightsail.Types.SendContactMethodVerificationRequest, callback?: (err: AWSError, data: Lightsail.Types.SendContactMethodVerificationResult) => void): Request<Lightsail.Types.SendContactMethodVerificationResult, AWSError>;
/**
* Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
*/
sendContactMethodVerification(callback?: (err: AWSError, data: Lightsail.Types.SendContactMethodVerificationResult) => void): Request<Lightsail.Types.SendContactMethodVerificationResult, AWSError>;
/**
* Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
startInstance(params: Lightsail.Types.StartInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.StartInstanceResult) => void): Request<Lightsail.Types.StartInstanceResult, AWSError>;
/**
* Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
startInstance(callback?: (err: AWSError, data: Lightsail.Types.StartInstanceResult) => void): Request<Lightsail.Types.StartInstanceResult, AWSError>;
/**
* Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
startRelationalDatabase(params: Lightsail.Types.StartRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.StartRelationalDatabaseResult) => void): Request<Lightsail.Types.StartRelationalDatabaseResult, AWSError>;
/**
* Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
startRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.StartRelationalDatabaseResult) => void): Request<Lightsail.Types.StartRelationalDatabaseResult, AWSError>;
/**
* Stops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
stopInstance(params: Lightsail.Types.StopInstanceRequest, callback?: (err: AWSError, data: Lightsail.Types.StopInstanceResult) => void): Request<Lightsail.Types.StopInstanceResult, AWSError>;
/**
* Stops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
*/
stopInstance(callback?: (err: AWSError, data: Lightsail.Types.StopInstanceResult) => void): Request<Lightsail.Types.StopInstanceResult, AWSError>;
/**
* Stops a specific database that is currently running in Amazon Lightsail. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
stopRelationalDatabase(params: Lightsail.Types.StopRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.StopRelationalDatabaseResult) => void): Request<Lightsail.Types.StopRelationalDatabaseResult, AWSError>;
/**
* Stops a specific database that is currently running in Amazon Lightsail. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
stopRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.StopRelationalDatabaseResult) => void): Request<Lightsail.Types.StopRelationalDatabaseResult, AWSError>;
/**
* Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
*/
tagResource(params: Lightsail.Types.TagResourceRequest, callback?: (err: AWSError, data: Lightsail.Types.TagResourceResult) => void): Request<Lightsail.Types.TagResourceResult, AWSError>;
/**
* Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
*/
tagResource(callback?: (err: AWSError, data: Lightsail.Types.TagResourceResult) => void): Request<Lightsail.Types.TagResourceResult, AWSError>;
/**
* Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
*/
testAlarm(params: Lightsail.Types.TestAlarmRequest, callback?: (err: AWSError, data: Lightsail.Types.TestAlarmResult) => void): Request<Lightsail.Types.TestAlarmResult, AWSError>;
/**
* Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
*/
testAlarm(callback?: (err: AWSError, data: Lightsail.Types.TestAlarmResult) => void): Request<Lightsail.Types.TestAlarmResult, AWSError>;
/**
* Attempts to unpeer the Lightsail VPC from the user's default VPC.
*/
unpeerVpc(params: Lightsail.Types.UnpeerVpcRequest, callback?: (err: AWSError, data: Lightsail.Types.UnpeerVpcResult) => void): Request<Lightsail.Types.UnpeerVpcResult, AWSError>;
/**
* Attempts to unpeer the Lightsail VPC from the user's default VPC.
*/
unpeerVpc(callback?: (err: AWSError, data: Lightsail.Types.UnpeerVpcResult) => void): Request<Lightsail.Types.UnpeerVpcResult, AWSError>;
/**
* Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
*/
untagResource(params: Lightsail.Types.UntagResourceRequest, callback?: (err: AWSError, data: Lightsail.Types.UntagResourceResult) => void): Request<Lightsail.Types.UntagResourceResult, AWSError>;
/**
* Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
*/
untagResource(callback?: (err: AWSError, data: Lightsail.Types.UntagResourceResult) => void): Request<Lightsail.Types.UntagResourceResult, AWSError>;
/**
* Updates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution
*/
updateDistribution(params: Lightsail.Types.UpdateDistributionRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateDistributionResult) => void): Request<Lightsail.Types.UpdateDistributionResult, AWSError>;
/**
* Updates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution
*/
updateDistribution(callback?: (err: AWSError, data: Lightsail.Types.UpdateDistributionResult) => void): Request<Lightsail.Types.UpdateDistributionResult, AWSError>;
/**
* Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution. Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee. You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.
*/
updateDistributionBundle(params: Lightsail.Types.UpdateDistributionBundleRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateDistributionBundleResult) => void): Request<Lightsail.Types.UpdateDistributionBundleResult, AWSError>;
/**
* Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution. Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee. You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.
*/
updateDistributionBundle(callback?: (err: AWSError, data: Lightsail.Types.UpdateDistributionBundleResult) => void): Request<Lightsail.Types.UpdateDistributionBundleResult, AWSError>;
/**
* Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
updateDomainEntry(params: Lightsail.Types.UpdateDomainEntryRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateDomainEntryResult) => void): Request<Lightsail.Types.UpdateDomainEntryResult, AWSError>;
/**
* Updates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.
*/
updateDomainEntry(callback?: (err: AWSError, data: Lightsail.Types.UpdateDomainEntryResult) => void): Request<Lightsail.Types.UpdateDomainEntryResult, AWSError>;
/**
* Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
updateLoadBalancerAttribute(params: Lightsail.Types.UpdateLoadBalancerAttributeRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateLoadBalancerAttributeResult) => void): Request<Lightsail.Types.UpdateLoadBalancerAttributeResult, AWSError>;
/**
* Updates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
*/
updateLoadBalancerAttribute(callback?: (err: AWSError, data: Lightsail.Types.UpdateLoadBalancerAttributeResult) => void): Request<Lightsail.Types.UpdateLoadBalancerAttributeResult, AWSError>;
/**
* Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
updateRelationalDatabase(params: Lightsail.Types.UpdateRelationalDatabaseRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseResult) => void): Request<Lightsail.Types.UpdateRelationalDatabaseResult, AWSError>;
/**
* Allows the update of one or more attributes of a database in Amazon Lightsail. Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window. The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
updateRelationalDatabase(callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseResult) => void): Request<Lightsail.Types.UpdateRelationalDatabaseResult, AWSError>;
/**
* Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
updateRelationalDatabaseParameters(params: Lightsail.Types.UpdateRelationalDatabaseParametersRequest, callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseParametersResult) => void): Request<Lightsail.Types.UpdateRelationalDatabaseParametersResult, AWSError>;
/**
* Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
*/
updateRelationalDatabaseParameters(callback?: (err: AWSError, data: Lightsail.Types.UpdateRelationalDatabaseParametersResult) => void): Request<Lightsail.Types.UpdateRelationalDatabaseParametersResult, AWSError>;
}
declare namespace Lightsail {
export type AccessDirection = "inbound"|"outbound"|string;
export interface AddOn {
/**
* The name of the add-on.
*/
name?: string;
/**
* The status of the add-on.
*/
status?: string;
/**
* The daily time when an automatic snapshot is created. The time shown is in HH:00 format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after.
*/
snapshotTimeOfDay?: TimeOfDay;
/**
* The next daily time an automatic snapshot will be created. The time shown is in HH:00 format, and in Coordinated Universal Time (UTC). The snapshot is automatically created between the time shown and up to 45 minutes after.
*/
nextSnapshotTimeOfDay?: TimeOfDay;
}
export type AddOnList = AddOn[];
export interface AddOnRequest {
/**
* The add-on type.
*/
addOnType: AddOnType;
/**
* An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
*/
autoSnapshotAddOnRequest?: AutoSnapshotAddOnRequest;
}
export type AddOnRequestList = AddOnRequest[];
export type AddOnType = "AutoSnapshot"|string;
export interface Alarm {
/**
* The name of the alarm.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the alarm.
*/
arn?: NonEmptyString;
/**
* The timestamp when the alarm was created.
*/
createdAt?: IsoDate;
/**
* An object that lists information about the location of the alarm.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., Alarm).
*/
resourceType?: ResourceType;
/**
* The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* An object that lists information about the resource monitored by the alarm.
*/
monitoredResourceInfo?: MonitoredResourceInfo;
/**
* The arithmetic operation used when comparing the specified statistic and threshold.
*/
comparisonOperator?: ComparisonOperator;
/**
* The number of periods over which data is compared to the specified threshold.
*/
evaluationPeriods?: integer;
/**
* The period, in seconds, over which the statistic is applied.
*/
period?: MetricPeriod;
/**
* The value against which the specified statistic is compared.
*/
threshold?: double;
/**
* The number of data points that must not within the specified threshold to trigger the alarm.
*/
datapointsToAlarm?: integer;
/**
* Specifies how the alarm handles missing data points. An alarm can treat missing data in the following ways: breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. ignore - Ignore the missing data. Maintains the current alarm state. missing - Missing data is treated as missing.
*/
treatMissingData?: TreatMissingData;
/**
* The statistic for the metric associated with the alarm. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.
*/
statistic?: MetricStatistic;
/**
* The name of the metric associated with the alarm.
*/
metricName?: MetricName;
/**
* The current state of the alarm. An alarm has the following possible states: ALARM - The metric is outside of the defined threshold. INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK - The metric is within the defined threshold.
*/
state?: AlarmState;
/**
* The unit of the metric associated with the alarm.
*/
unit?: MetricUnit;
/**
* The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
*/
contactProtocols?: ContactProtocolsList;
/**
* The alarm states that trigger a notification.
*/
notificationTriggers?: NotificationTriggerList;
/**
* Indicates whether the alarm is enabled.
*/
notificationEnabled?: boolean;
}
export type AlarmState = "OK"|"ALARM"|"INSUFFICIENT_DATA"|string;
export type AlarmsList = Alarm[];
export interface AllocateStaticIpRequest {
/**
* The name of the static IP address.
*/
staticIpName: ResourceName;
}
export interface AllocateStaticIpResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface AttachCertificateToDistributionRequest {
/**
* The name of the distribution that the certificate will be attached to. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName: ResourceName;
/**
* The name of the certificate to attach to a distribution. Only certificates with a status of ISSUED can be attached to a distribution. Use the GetCertificates action to get a list of certificate names that you can specify. This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be WordPress-Blog-Certificate and the domain name of the certificate might be example.com.
*/
certificateName: ResourceName;
}
export interface AttachCertificateToDistributionResult {
/**
* An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface AttachDiskRequest {
/**
* The unique Lightsail disk name (e.g., my-disk).
*/
diskName: ResourceName;
/**
* The name of the Lightsail instance where you want to utilize the storage disk.
*/
instanceName: ResourceName;
/**
* The disk path to expose to the instance (e.g., /dev/xvdf).
*/
diskPath: NonEmptyString;
}
export interface AttachDiskResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface AttachInstancesToLoadBalancerRequest {
/**
* The name of the load balancer.
*/
loadBalancerName: ResourceName;
/**
* An array of strings representing the instance name(s) you want to attach to your load balancer. An instance must be running before you can attach it to your load balancer. There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).
*/
instanceNames: ResourceNameList;
}
export interface AttachInstancesToLoadBalancerResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface AttachLoadBalancerTlsCertificateRequest {
/**
* The name of the load balancer to which you want to associate the SSL/TLS certificate.
*/
loadBalancerName: ResourceName;
/**
* The name of your SSL/TLS certificate.
*/
certificateName: ResourceName;
}
export interface AttachLoadBalancerTlsCertificateResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request. These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
*/
operations?: OperationList;
}
export interface AttachStaticIpRequest {
/**
* The name of the static IP.
*/
staticIpName: ResourceName;
/**
* The instance name to which you want to attach the static IP address.
*/
instanceName: ResourceName;
}
export interface AttachStaticIpResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface AttachedDisk {
/**
* The path of the disk (e.g., /dev/xvdf).
*/
path?: string;
/**
* The size of the disk in GB.
*/
sizeInGb?: integer;
}
export type AttachedDiskList = AttachedDisk[];
export type AttachedDiskMap = {[key: string]: DiskMapList};
export interface AutoSnapshotAddOnRequest {
/**
* The daily time when an automatic snapshot will be created. Constraints: Must be in HH:00 format, and in an hourly increment. Specified in Coordinated Universal Time (UTC). The snapshot will be automatically created between the time specified and up to 45 minutes after.
*/
snapshotTimeOfDay?: TimeOfDay;
}
export type AutoSnapshotDate = string;
export interface AutoSnapshotDetails {
/**
* The date of the automatic snapshot in YYYY-MM-DD format.
*/
date?: string;
/**
* The timestamp when the automatic snapshot was created.
*/
createdAt?: IsoDate;
/**
* The status of the automatic snapshot.
*/
status?: AutoSnapshotStatus;
/**
* An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.
*/
fromAttachedDisks?: AttachedDiskList;
}
export type AutoSnapshotDetailsList = AutoSnapshotDetails[];
export type AutoSnapshotStatus = "Success"|"Failed"|"InProgress"|"NotFound"|string;
export interface AvailabilityZone {
/**
* The name of the Availability Zone. The format is us-east-2a (case-sensitive).
*/
zoneName?: NonEmptyString;
/**
* The state of the Availability Zone.
*/
state?: NonEmptyString;
}
export type AvailabilityZoneList = AvailabilityZone[];
export type Base64 = string;
export type BehaviorEnum = "dont-cache"|"cache"|string;
export interface Blueprint {
/**
* The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
*/
blueprintId?: NonEmptyString;
/**
* The friendly name of the blueprint (e.g., Amazon Linux).
*/
name?: ResourceName;
/**
* The group name of the blueprint (e.g., amazon-linux).
*/
group?: NonEmptyString;
/**
* The type of the blueprint (e.g., os or app).
*/
type?: BlueprintType;
/**
* The description of the blueprint.
*/
description?: string;
/**
* A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
*/
isActive?: boolean;
/**
* The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
*/
minPower?: integer;
/**
* The version number of the operating system, application, or stack (e.g., 2016.03.0).
*/
version?: string;
/**
* The version code.
*/
versionCode?: string;
/**
* The product URL to learn more about the image or blueprint.
*/
productUrl?: string;
/**
* The end-user license agreement URL for the image or blueprint.
*/
licenseUrl?: string;
/**
* The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
*/
platform?: InstancePlatform;
}
export type BlueprintList = Blueprint[];
export type BlueprintType = "os"|"app"|string;
export interface Bundle {
/**
* The price in US dollars (e.g., 5.0) of the bundle.
*/
price?: float;
/**
* The number of vCPUs included in the bundle (e.g., 2).
*/
cpuCount?: integer;
/**
* The size of the SSD (e.g., 30).
*/
diskSizeInGb?: integer;
/**
* The bundle ID (e.g., micro_1_0).
*/
bundleId?: NonEmptyString;
/**
* The Amazon EC2 instance type (e.g., t2.micro).
*/
instanceType?: string;
/**
* A Boolean value indicating whether the bundle is active.
*/
isActive?: boolean;
/**
* A friendly name for the bundle (e.g., Micro).
*/
name?: string;
/**
* A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.
*/
power?: integer;
/**
* The amount of RAM in GB (e.g., 2.0).
*/
ramSizeInGb?: float;
/**
* The data transfer rate per month in GB (e.g., 2000).
*/
transferPerMonthInGb?: integer;
/**
* The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.
*/
supportedPlatforms?: InstancePlatformList;
}
export type BundleList = Bundle[];
export interface CacheBehavior {
/**
* The cache behavior of the distribution. The following cache behaviors can be specified: cache - This option is best for static sites. When specified, your distribution caches and serves your entire website as static content. This behavior is ideal for websites with static content that doesn't change depending on who views it, or for websites that don't use cookies, headers, or query strings to personalize content. dont-cache - This option is best for sites that serve a mix of static and dynamic content. When specified, your distribution caches and serve only the content that is specified in the distribution's CacheBehaviorPerPath parameter. This behavior is ideal for websites or web applications that use cookies, headers, and query strings to personalize content for individual users.
*/
behavior?: BehaviorEnum;
}
export type CacheBehaviorList = CacheBehaviorPerPath[];
export interface CacheBehaviorPerPath {
/**
* The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive. Examples: Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance. var/www/html/ Specify the following file to cache only the index page in the document root of an Apache web server. var/www/html/index.html Specify the following to cache only the .html files in the document root of an Apache web server. var/www/html/*.html Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server. var/www/html/images/*.jpg var/www/html/images/*.png var/www/html/images/*.gif Specify the following to cache all files in the images sub-directory of the document root of an Apache web server. var/www/html/images/
*/
path?: string;
/**
* The cache behavior for the specified path. You can specify one of the following per-path cache behaviors: cache - This behavior caches the specified path. dont-cache - This behavior doesn't cache the specified path.
*/
behavior?: BehaviorEnum;
}
export interface CacheSettings {
/**
* The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated. The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
*/
defaultTTL?: long;
/**
* The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated. A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.
*/
minimumTTL?: long;
/**
* The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated. The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.
*/
maximumTTL?: long;
/**
* The HTTP methods that are processed and forwarded to the distribution's origin. You can specify the following options: GET,HEAD - The distribution forwards the GET and HEAD methods. GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods. GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods. If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.
*/
allowedHTTPMethods?: NonEmptyString;
/**
* The HTTP method responses that are cached by your distribution. You can specify the following options: GET,HEAD - The distribution caches responses to the GET and HEAD methods. GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.
*/
cachedHTTPMethods?: NonEmptyString;
/**
* An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
*/
forwardedCookies?: CookieObject;
/**
* An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
*/
forwardedHeaders?: HeaderObject;
/**
* An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.
*/
forwardedQueryStrings?: QueryStringObject;
}
export interface Certificate {
/**
* The Amazon Resource Name (ARN) of the certificate.
*/
arn?: NonEmptyString;
/**
* The name of the certificate (e.g., my-certificate).
*/
name?: CertificateName;
/**
* The domain name of the certificate.
*/
domainName?: DomainName;
/**
* The validation status of the certificate.
*/
status?: CertificateStatus;
/**
* The serial number of the certificate.
*/
serialNumber?: SerialNumber;
/**
* An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) of the certificate.
*/
subjectAlternativeNames?: SubjectAlternativeNameList;
/**
* An array of objects that describe the domain validation records of the certificate.
*/
domainValidationRecords?: DomainValidationRecordList;
/**
* The validation failure reason, if any, of the certificate. The following failure reasons are possible: NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates. ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support. You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do. If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate. If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case. INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain. OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
*/
requestFailureReason?: RequestFailureReason;
/**
* The number of Lightsail resources that the certificate is attached to.
*/
inUseResourceCount?: InUseResourceCount;
/**
* The algorithm used to generate the key pair (the public and private key) of the certificate.
*/
keyAlgorithm?: KeyAlgorithm;
/**
* The timestamp when the certificate was created.
*/
createdAt?: IsoDate;
/**
* The timestamp when the certificate was issued.
*/
issuedAt?: IsoDate;
/**
* The certificate authority that issued the certificate.
*/
issuerCA?: IssuerCA;
/**
* The timestamp when the certificate is first valid.
*/
notBefore?: IsoDate;
/**
* The timestamp when the certificate expires.
*/
notAfter?: IsoDate;
/**
* The renewal eligibility of the certificate.
*/
eligibleToRenew?: EligibleToRenew;
/**
* An object that describes the status of the certificate renewal managed by Lightsail.
*/
renewalSummary?: RenewalSummary;
/**
* The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.
*/
revokedAt?: IsoDate;
/**
* The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.
*/
revocationReason?: RevocationReason;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The support code. Include this code in your email to support when you have questions about your Lightsail certificate. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
}
export type CertificateName = string;
export type CertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|string;
export type CertificateStatusList = CertificateStatus[];
export interface CertificateSummary {
/**
* The Amazon Resource Name (ARN) of the certificate.
*/
certificateArn?: NonEmptyString;
/**
* The name of the certificate.
*/
certificateName?: CertificateName;
/**
* The domain name of the certificate.
*/
domainName?: DomainName;
/**
* An object that describes a certificate in detail.
*/
certificateDetail?: Certificate;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
}
export type CertificateSummaryList = CertificateSummary[];
export interface CloseInstancePublicPortsRequest {
/**
* An object to describe the ports to close for the specified instance.
*/
portInfo: PortInfo;
/**
* The name of the instance for which to close ports.
*/
instanceName: ResourceName;
}
export interface CloseInstancePublicPortsResult {
/**
* An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface CloudFormationStackRecord {
/**
* The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the CloudFormation stack record.
*/
arn?: NonEmptyString;
/**
* The date when the CloudFormation stack record was created.
*/
createdAt?: IsoDate;
/**
* A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., CloudFormationStackRecord).
*/
resourceType?: ResourceType;
/**
* The current state of the CloudFormation stack record.
*/
state?: RecordState;
/**
* A list of objects describing the source of the CloudFormation stack record.
*/
sourceInfo?: CloudFormationStackRecordSourceInfoList;
/**
* A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.
*/
destinationInfo?: DestinationInfo;
}
export type CloudFormationStackRecordList = CloudFormationStackRecord[];
export interface CloudFormationStackRecordSourceInfo {
/**
* The Lightsail resource type (e.g., ExportSnapshotRecord).
*/
resourceType?: CloudFormationStackRecordSourceType;
/**
* The name of the record.
*/
name?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the export snapshot record.
*/
arn?: NonEmptyString;
}
export type CloudFormationStackRecordSourceInfoList = CloudFormationStackRecordSourceInfo[];
export type CloudFormationStackRecordSourceType = "ExportSnapshotRecord"|string;
export type ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|string;
export interface ContactMethod {
/**
* The destination of the contact method, such as an email address or a mobile phone number.
*/
contactEndpoint?: NonEmptyString;
/**
* The current status of the contact method. A contact method has the following possible status: PendingVerification - The contact method has not yet been verified, and the verification has not yet expired. Valid - The contact method has been verified. InValid - An attempt was made to verify the contact method, but the verification has expired.
*/
status?: ContactMethodStatus;
/**
* The protocol of the contact method, such as email or SMS (text messaging).
*/
protocol?: ContactProtocol;
/**
* The name of the contact method.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the contact method.
*/
arn?: NonEmptyString;
/**
* The timestamp when the contact method was created.
*/
createdAt?: IsoDate;
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., ContactMethod).
*/
resourceType?: ResourceType;
/**
* The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
}
export type ContactMethodStatus = "PendingVerification"|"Valid"|"Invalid"|string;
export type ContactMethodVerificationProtocol = "Email"|string;
export type ContactMethodsList = ContactMethod[];
export type ContactProtocol = "Email"|"SMS"|string;
export type ContactProtocolsList = ContactProtocol[];
export interface CookieObject {
/**
* Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
*/
option?: ForwardValues;
/**
* The specific cookies to forward to your distribution's origin.
*/
cookiesAllowList?: StringList;
}
export interface CopySnapshotRequest {
/**
* The name of the source manual snapshot to copy. Constraint: Define this parameter only when copying a manual snapshot as another manual snapshot.
*/
sourceSnapshotName?: ResourceName;
/**
* The name of the source instance or disk from which the source automatic snapshot was created. Constraint: Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
*/
sourceResourceName?: string;
/**
* The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
*/
restoreDate?: string;
/**
* A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk. Constraints: This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.
*/
useLatestRestorableAutoSnapshot?: boolean;
/**
* The name of the new manual snapshot to be created as a copy.
*/
targetSnapshotName: ResourceName;
/**
* The AWS Region where the source manual or automatic snapshot is located.
*/
sourceRegion: RegionName;
}
export interface CopySnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateCertificateRequest {
/**
* The name for the certificate.
*/
certificateName: CertificateName;
/**
* The domain name (e.g., example.com) for the certificate.
*/
domainName: DomainName;
/**
* An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate. You can specify a maximum of nine alternate domains (in addition to the primary domain name). Wildcard domain entries (e.g., *.example.com) are not supported.
*/
subjectAlternativeNames?: SubjectAlternativeNameList;
/**
* The tag keys and optional values to add to the certificate during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateCertificateResult {
/**
* An object that describes the certificate created.
*/
certificate?: CertificateSummary;
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateCloudFormationStackRequest {
/**
* An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.
*/
instances: InstanceEntryList;
}
export interface CreateCloudFormationStackResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateContactMethodRequest {
/**
* The protocol of the contact method, such as Email or SMS (text messaging). The SMS protocol is supported only in the following AWS Regions. US East (N. Virginia) (us-east-1) US West (Oregon) (us-west-2) Europe (Ireland) (eu-west-1) Asia Pacific (Tokyo) (ap-northeast-1) Asia Pacific (Singapore) (ap-southeast-1) Asia Pacific (Sydney) (ap-southeast-2) For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide. For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
*/
protocol: ContactProtocol;
/**
* The destination of the contact method, such as an email address or a mobile phone number. Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.
*/
contactEndpoint: StringMax256;
}
export interface CreateContactMethodResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateDiskFromSnapshotRequest {
/**
* The unique Lightsail disk name (e.g., my-disk).
*/
diskName: ResourceName;
/**
* The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk. Constraint: This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.
*/
diskSnapshotName?: ResourceName;
/**
* The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk. Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
*/
availabilityZone: NonEmptyString;
/**
* The size of the disk in GB (e.g., 32).
*/
sizeInGb: integer;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
/**
* An array of objects that represent the add-ons to enable for the new disk.
*/
addOns?: AddOnRequestList;
/**
* The name of the source disk from which the source automatic snapshot was created. Constraints: This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive. Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
*/
sourceDiskName?: string;
/**
* The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
*/
restoreDate?: string;
/**
* A Boolean value to indicate whether to use the latest available automatic snapshot. Constraints: This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.
*/
useLatestRestorableAutoSnapshot?: boolean;
}
export interface CreateDiskFromSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateDiskRequest {
/**
* The unique Lightsail disk name (e.g., my-disk).
*/
diskName: ResourceName;
/**
* The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk. Use the get regions operation to list the Availability Zones where Lightsail is currently available.
*/
availabilityZone: NonEmptyString;
/**
* The size of the disk in GB (e.g., 32).
*/
sizeInGb: integer;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
/**
* An array of objects that represent the add-ons to enable for the new disk.
*/
addOns?: AddOnRequestList;
}
export interface CreateDiskResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateDiskSnapshotRequest {
/**
* The unique name of the source disk (e.g., Disk-Virginia-1). This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.
*/
diskName?: ResourceName;
/**
* The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.
*/
diskSnapshotName: ResourceName;
/**
* The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created. This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.
*/
instanceName?: ResourceName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateDiskSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateDistributionRequest {
/**
* The name for the distribution.
*/
distributionName: ResourceName;
/**
* An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer. The distribution pulls, caches, and serves content from the origin.
*/
origin: InputOrigin;
/**
* An object that describes the default cache behavior for the distribution.
*/
defaultCacheBehavior: CacheBehavior;
/**
* An object that describes the cache behavior settings for the distribution.
*/
cacheBehaviorSettings?: CacheSettings;
/**
* An array of objects that describe the per-path cache behavior for the distribution.
*/
cacheBehaviors?: CacheBehaviorList;
/**
* The bundle ID to use for the distribution. A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota. Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
*/
bundleId: string;
/**
* The tag keys and optional values to add to the distribution during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateDistributionResult {
/**
* An object that describes the distribution created.
*/
distribution?: LightsailDistribution;
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface CreateDomainEntryRequest {
/**
* The domain name (e.g., example.com) for which you want to create the domain entry.
*/
domainName: DomainName;
/**
* An array of key-value pairs containing information about the domain entry request.
*/
domainEntry: DomainEntry;
}
export interface CreateDomainEntryResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface CreateDomainRequest {
/**
* The domain name to manage (e.g., example.com). You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
*/
domainName: DomainName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateDomainResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface CreateInstanceSnapshotRequest {
/**
* The name for your new snapshot.
*/
instanceSnapshotName: ResourceName;
/**
* The Lightsail instance on which to base your snapshot.
*/
instanceName: ResourceName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateInstanceSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateInstancesFromSnapshotRequest {
/**
* The names for your new instances.
*/
instanceNames: StringList;
/**
* An object containing information about one or more disk mappings.
*/
attachedDiskMapping?: AttachedDiskMap;
/**
* The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
*/
availabilityZone: string;
/**
* The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots. Constraint: This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.
*/
instanceSnapshotName?: ResourceName;
/**
* The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
*/
bundleId: NonEmptyString;
/**
* You can create a launch script that configures a server with additional user data. For example, apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.
*/
userData?: string;
/**
* The name for your key pair.
*/
keyPairName?: ResourceName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
/**
* An array of objects representing the add-ons to enable for the new instance.
*/
addOns?: AddOnRequestList;
/**
* The name of the source instance from which the source automatic snapshot was created. Constraints: This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive. Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
*/
sourceInstanceName?: string;
/**
* The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: Must be specified in YYYY-MM-DD format. This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
*/
restoreDate?: string;
/**
* A Boolean value to indicate whether to use the latest available automatic snapshot. Constraints: This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.
*/
useLatestRestorableAutoSnapshot?: boolean;
}
export interface CreateInstancesFromSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateInstancesRequest {
/**
* The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]
*/
instanceNames: StringList;
/**
* The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.
*/
availabilityZone: string;
/**
* (Deprecated) The name for your custom image. In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
*/
customImageName?: ResourceName;
/**
* The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints). Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
*/
blueprintId: NonEmptyString;
/**
* The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).
*/
bundleId: NonEmptyString;
/**
* A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.
*/
userData?: string;
/**
* The name of your key pair.
*/
keyPairName?: ResourceName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
/**
* An array of objects representing the add-ons to enable for the new instance.
*/
addOns?: AddOnRequestList;
}
export interface CreateInstancesResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateKeyPairRequest {
/**
* The name for your new key pair.
*/
keyPairName: ResourceName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateKeyPairResult {
/**
* An array of key-value pairs containing information about the new key pair you just created.
*/
keyPair?: KeyPair;
/**
* A base64-encoded public key of the ssh-rsa type.
*/
publicKeyBase64?: Base64;
/**
* A base64-encoded RSA private key.
*/
privateKeyBase64?: Base64;
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface CreateLoadBalancerRequest {
/**
* The name of your load balancer.
*/
loadBalancerName: ResourceName;
/**
* The instance port where you're creating your load balancer.
*/
instancePort: Port;
/**
* The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., "/"). You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.
*/
healthCheckPath?: string;
/**
* The name of the SSL/TLS certificate. If you specify certificateName, then certificateDomainName is required (and vice-versa).
*/
certificateName?: ResourceName;
/**
* The domain name with which your certificate is associated (e.g., example.com). If you specify certificateDomainName, then certificateName is required (and vice-versa).
*/
certificateDomainName?: DomainName;
/**
* The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).
*/
certificateAlternativeNames?: DomainNameList;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateLoadBalancerResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateLoadBalancerTlsCertificateRequest {
/**
* The load balancer name where you want to create the SSL/TLS certificate.
*/
loadBalancerName: ResourceName;
/**
* The SSL/TLS certificate name. You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.
*/
certificateName: ResourceName;
/**
* The domain name (e.g., example.com) for your SSL/TLS certificate.
*/
certificateDomainName: DomainName;
/**
* An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com).
*/
certificateAlternativeNames?: DomainNameList;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateLoadBalancerTlsCertificateResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateRelationalDatabaseFromSnapshotRequest {
/**
* The name to use for your new database. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number.
*/
relationalDatabaseName: ResourceName;
/**
* The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.
*/
availabilityZone?: string;
/**
* Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
*/
publiclyAccessible?: boolean;
/**
* The name of the database snapshot from which to create your new database.
*/
relationalDatabaseSnapshotName?: ResourceName;
/**
* The bundle ID for your new database. A bundle describes the performance specifications for your database. You can get a list of database bundle IDs by using the get relational database bundles operation. When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.
*/
relationalDatabaseBundleId?: string;
/**
* The name of the source database.
*/
sourceRelationalDatabaseName?: ResourceName;
/**
* The date and time to restore your database from. Constraints: Must be before the latest restorable time for the database. Cannot be specified if the use latest restorable time parameter is true. Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.
*/
restoreTime?: IsoDate;
/**
* Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time. Default: false Constraints: Cannot be specified if the restore time parameter is provided.
*/
useLatestRestorableTime?: boolean;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateRelationalDatabaseFromSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateRelationalDatabaseRequest {
/**
* The name to use for your new database. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number.
*/
relationalDatabaseName: ResourceName;
/**
* The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.
*/
availabilityZone?: string;
/**
* The blueprint ID for your new database. A blueprint describes the major engine version of a database. You can get a list of database blueprints IDs by using the get relational database blueprints operation.
*/
relationalDatabaseBlueprintId: string;
/**
* The bundle ID for your new database. A bundle describes the performance specifications for your database. You can get a list of database bundle IDs by using the get relational database bundles operation.
*/
relationalDatabaseBundleId: string;
/**
* The name of the master database created when the Lightsail database resource is created. Constraints: Must contain from 1 to 64 alphanumeric characters. Cannot be a word reserved by the specified database engine
*/
masterDatabaseName: string;
/**
* The master user name for your new database. Constraints: Master user name is required. Must contain from 1 to 16 alphanumeric characters. The first character must be a letter. Cannot be a reserved word for the database engine you choose. For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.
*/
masterUsername: string;
/**
* The password for the master user of your new database. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain 8 to 41 characters.
*/
masterUserPassword?: SensitiveString;
/**
* The daily time range during which automated backups are created for your new database if automated backups are enabled. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation. Constraints: Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Coordinated Universal Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
preferredBackupWindow?: string;
/**
* The weekly time range during which system maintenance can occur on your new database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Coordinated Universal Time (UTC). Example: Tue:17:00-Tue:17:30
*/
preferredMaintenanceWindow?: string;
/**
* Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
*/
publiclyAccessible?: boolean;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateRelationalDatabaseResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface CreateRelationalDatabaseSnapshotRequest {
/**
* The name of the database on which to base your new snapshot.
*/
relationalDatabaseName: ResourceName;
/**
* The name for your new database snapshot. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number.
*/
relationalDatabaseSnapshotName: ResourceName;
/**
* The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created.
*/
tags?: TagList;
}
export interface CreateRelationalDatabaseSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteAlarmRequest {
/**
* The name of the alarm to delete.
*/
alarmName: ResourceName;
}
export interface DeleteAlarmResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteAutoSnapshotRequest {
/**
* The name of the source instance or disk from which to delete the automatic snapshot.
*/
resourceName: ResourceName;
/**
* The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get auto snapshots operation to get the available automatic snapshots for a resource.
*/
date: AutoSnapshotDate;
}
export interface DeleteAutoSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteCertificateRequest {
/**
* The name of the certificate to delete. Use the GetCertificates action to get a list of certificate names that you can specify.
*/
certificateName: CertificateName;
}
export interface DeleteCertificateResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteContactMethodRequest {
/**
* The protocol that will be deleted, such as Email or SMS (text messaging). To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.
*/
protocol: ContactProtocol;
}
export interface DeleteContactMethodResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteDiskRequest {
/**
* The unique name of the disk you want to delete (e.g., my-disk).
*/
diskName: ResourceName;
/**
* A Boolean value to indicate whether to delete the enabled add-ons for the disk.
*/
forceDeleteAddOns?: boolean;
}
export interface DeleteDiskResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteDiskSnapshotRequest {
/**
* The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
*/
diskSnapshotName: ResourceName;
}
export interface DeleteDiskSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteDistributionRequest {
/**
* The name of the distribution to delete. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName?: ResourceName;
}
export interface DeleteDistributionResult {
/**
* An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface DeleteDomainEntryRequest {
/**
* The name of the domain entry to delete.
*/
domainName: DomainName;
/**
* An array of key-value pairs containing information about your domain entries.
*/
domainEntry: DomainEntry;
}
export interface DeleteDomainEntryResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface DeleteDomainRequest {
/**
* The specific domain name to delete.
*/
domainName: DomainName;
}
export interface DeleteDomainResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface DeleteInstanceRequest {
/**
* The name of the instance to delete.
*/
instanceName: ResourceName;
/**
* A Boolean value to indicate whether to delete the enabled add-ons for the disk.
*/
forceDeleteAddOns?: boolean;
}
export interface DeleteInstanceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteInstanceSnapshotRequest {
/**
* The name of the snapshot to delete.
*/
instanceSnapshotName: ResourceName;
}
export interface DeleteInstanceSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteKeyPairRequest {
/**
* The name of the key pair to delete.
*/
keyPairName: ResourceName;
}
export interface DeleteKeyPairResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface DeleteKnownHostKeysRequest {
/**
* The name of the instance for which you want to reset the host key or certificate.
*/
instanceName: ResourceName;
}
export interface DeleteKnownHostKeysResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteLoadBalancerRequest {
/**
* The name of the load balancer you want to delete.
*/
loadBalancerName: ResourceName;
}
export interface DeleteLoadBalancerResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteLoadBalancerTlsCertificateRequest {
/**
* The load balancer name.
*/
loadBalancerName: ResourceName;
/**
* The SSL/TLS certificate name.
*/
certificateName: ResourceName;
/**
* When true, forces the deletion of an SSL/TLS certificate. There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.
*/
force?: boolean;
}
export interface DeleteLoadBalancerTlsCertificateResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteRelationalDatabaseRequest {
/**
* The name of the database that you are deleting.
*/
relationalDatabaseName: ResourceName;
/**
* Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false. Default: false
*/
skipFinalSnapshot?: boolean;
/**
* The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter. Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error. Constraints: Must contain from 2 to 255 alphanumeric characters, or hyphens. The first and last character must be a letter or number.
*/
finalRelationalDatabaseSnapshotName?: ResourceName;
}
export interface DeleteRelationalDatabaseResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DeleteRelationalDatabaseSnapshotRequest {
/**
* The name of the database snapshot that you are deleting.
*/
relationalDatabaseSnapshotName: ResourceName;
}
export interface DeleteRelationalDatabaseSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DestinationInfo {
/**
* The ID of the resource created at the destination.
*/
id?: NonEmptyString;
/**
* The destination service of the record.
*/
service?: NonEmptyString;
}
export interface DetachCertificateFromDistributionRequest {
/**
* The name of the distribution from which to detach the certificate. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName: ResourceName;
}
export interface DetachCertificateFromDistributionResult {
/**
* An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface DetachDiskRequest {
/**
* The unique name of the disk you want to detach from your instance (e.g., my-disk).
*/
diskName: ResourceName;
}
export interface DetachDiskResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DetachInstancesFromLoadBalancerRequest {
/**
* The name of the Lightsail load balancer.
*/
loadBalancerName: ResourceName;
/**
* An array of strings containing the names of the instances you want to detach from the load balancer.
*/
instanceNames: ResourceNameList;
}
export interface DetachInstancesFromLoadBalancerResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DetachStaticIpRequest {
/**
* The name of the static IP to detach from the instance.
*/
staticIpName: ResourceName;
}
export interface DetachStaticIpResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface DisableAddOnRequest {
/**
* The add-on type to disable.
*/
addOnType: AddOnType;
/**
* The name of the source resource for which to disable the add-on.
*/
resourceName: ResourceName;
}
export interface DisableAddOnResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface Disk {
/**
* The unique name of the disk.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the disk.
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The date when the disk was created.
*/
createdAt?: IsoDate;
/**
* The AWS Region and Availability Zone where the disk is located.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., Disk).
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* An array of objects representing the add-ons enabled on the disk.
*/
addOns?: AddOnList;
/**
* The size of the disk in GB.
*/
sizeInGb?: integer;
/**
* A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
*/
isSystemDisk?: boolean;
/**
* The input/output operations per second (IOPS) of the disk.
*/
iops?: integer;
/**
* The disk path.
*/
path?: string;
/**
* Describes the status of the disk.
*/
state?: DiskState;
/**
* The resources to which the disk is attached.
*/
attachedTo?: ResourceName;
/**
* A Boolean value indicating whether the disk is attached.
*/
isAttached?: boolean;
/**
* (Deprecated) The attachment state of the disk. In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.
*/
attachmentState?: string;
/**
* (Deprecated) The number of GB in use by the disk. In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.
*/
gbInUse?: integer;
}
export interface DiskInfo {
/**
* The disk name.
*/
name?: string;
/**
* The disk path.
*/
path?: NonEmptyString;
/**
* The size of the disk in GB (e.g., 32).
*/
sizeInGb?: integer;
/**
* A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
*/
isSystemDisk?: boolean;
}
export type DiskInfoList = DiskInfo[];
export type DiskList = Disk[];
export interface DiskMap {
/**
* The original disk path exposed to the instance (for example, /dev/sdh).
*/
originalDiskPath?: NonEmptyString;
/**
* The new disk name (e.g., my-new-disk).
*/
newDiskName?: ResourceName;
}
export type DiskMapList = DiskMap[];
export interface DiskSnapshot {
/**
* The name of the disk snapshot (e.g., my-disk-snapshot).
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the disk snapshot.
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The date when the disk snapshot was created.
*/
createdAt?: IsoDate;
/**
* The AWS Region and Availability Zone where the disk snapshot was created.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., DiskSnapshot).
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The size of the disk in GB.
*/
sizeInGb?: integer;
/**
* The status of the disk snapshot operation.
*/
state?: DiskSnapshotState;
/**
* The progress of the disk snapshot operation.
*/
progress?: string;
/**
* The unique name of the source disk from which the disk snapshot was created.
*/
fromDiskName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
*/
fromDiskArn?: NonEmptyString;
/**
* The unique name of the source instance from which the disk (system volume) snapshot was created.
*/
fromInstanceName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
*/
fromInstanceArn?: NonEmptyString;
/**
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*/
isFromAutoSnapshot?: boolean;
}
export interface DiskSnapshotInfo {
/**
* The size of the disk in GB (e.g., 32).
*/
sizeInGb?: integer;
}
export type DiskSnapshotList = DiskSnapshot[];
export type DiskSnapshotState = "pending"|"completed"|"error"|"unknown"|string;
export type DiskState = "pending"|"error"|"available"|"in-use"|"unknown"|string;
export interface DistributionBundle {
/**
* The ID of the bundle.
*/
bundleId?: string;
/**
* The name of the distribution bundle.
*/
name?: string;
/**
* The monthly price, in US dollars, of the bundle.
*/
price?: float;
/**
* The monthly network transfer quota of the bundle.
*/
transferPerMonthInGb?: integer;
/**
* Indicates whether the bundle is active, and can be specified for a new distribution.
*/
isActive?: boolean;
}
export type DistributionBundleList = DistributionBundle[];
export type DistributionList = LightsailDistribution[];
export type DistributionMetricName = "Requests"|"BytesDownloaded"|"BytesUploaded"|"TotalErrorRate"|"Http4xxErrorRate"|"Http5xxErrorRate"|string;
export interface Domain {
/**
* The name of the domain.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The date when the domain recordset was created.
*/
createdAt?: IsoDate;
/**
* The AWS Region and Availability Zones where the domain recordset was created.
*/
location?: ResourceLocation;
/**
* The resource type.
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* An array of key-value pairs containing information about the domain entries.
*/
domainEntries?: DomainEntryList;
}
export interface DomainEntry {
/**
* The ID of the domain recordset entry.
*/
id?: NonEmptyString;
/**
* The name of the domain.
*/
name?: DomainName;
/**
* The target AWS name server (e.g., ns-111.awsdns-22.com.). For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set isAlias to true when setting up an A record for a load balancer.
*/
target?: string;
/**
* When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer
*/
isAlias?: boolean;
/**
* The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT). The following domain entry types can be used: A CNAME MX NS SOA SRV TXT
*/
type?: DomainEntryType;
/**
* (Deprecated) The options for the domain entry. In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.
*/
options?: DomainEntryOptions;
}
export type DomainEntryList = DomainEntry[];
export type DomainEntryOptions = {[key: string]: string};
export type DomainEntryOptionsKeys = string;
export type DomainEntryType = string;
export type DomainList = Domain[];
export type DomainName = string;
export type DomainNameList = DomainName[];
export interface DomainValidationRecord {
/**
* The domain name of the certificate validation record. For example, example.com or www.example.com.
*/
domainName?: DomainName;
/**
* An object that describes the DNS records to add to your domain's DNS to validate it for the certificate.
*/
resourceRecord?: ResourceRecord;
}
export type DomainValidationRecordList = DomainValidationRecord[];
export interface DownloadDefaultKeyPairRequest {
}
export interface DownloadDefaultKeyPairResult {
/**
* A base64-encoded public key of the ssh-rsa type.
*/
publicKeyBase64?: Base64;
/**
* A base64-encoded RSA private key.
*/
privateKeyBase64?: Base64;
}
export type EligibleToRenew = string;
export interface EnableAddOnRequest {
/**
* The name of the source resource for which to enable or modify the add-on.
*/
resourceName: ResourceName;
/**
* An array of strings representing the add-on to enable or modify.
*/
addOnRequest: AddOnRequest;
}
export interface EnableAddOnResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface ExportSnapshotRecord {
/**
* The export snapshot record name.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the export snapshot record.
*/
arn?: NonEmptyString;
/**
* The date when the export snapshot record was created.
*/
createdAt?: IsoDate;
/**
* The AWS Region and Availability Zone where the export snapshot record is located.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., ExportSnapshotRecord).
*/
resourceType?: ResourceType;
/**
* The state of the export snapshot record.
*/
state?: RecordState;
/**
* A list of objects describing the source of the export snapshot record.
*/
sourceInfo?: ExportSnapshotRecordSourceInfo;
/**
* A list of objects describing the destination of the export snapshot record.
*/
destinationInfo?: DestinationInfo;
}
export type ExportSnapshotRecordList = ExportSnapshotRecord[];
export interface ExportSnapshotRecordSourceInfo {
/**
* The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).
*/
resourceType?: ExportSnapshotRecordSourceType;
/**
* The date when the source instance or disk snapshot was created.
*/
createdAt?: IsoDate;
/**
* The name of the source instance or disk snapshot.
*/
name?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the source instance or disk snapshot.
*/
arn?: NonEmptyString;
/**
* The name of the snapshot's source instance or disk.
*/
fromResourceName?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the snapshot's source instance or disk.
*/
fromResourceArn?: NonEmptyString;
/**
* A list of objects describing an instance snapshot.
*/
instanceSnapshotInfo?: InstanceSnapshotInfo;
/**
* A list of objects describing a disk snapshot.
*/
diskSnapshotInfo?: DiskSnapshotInfo;
}
export type ExportSnapshotRecordSourceType = "InstanceSnapshot"|"DiskSnapshot"|string;
export interface ExportSnapshotRequest {
/**
* The name of the instance or disk snapshot to be exported to Amazon EC2.
*/
sourceSnapshotName: ResourceName;
}
export interface ExportSnapshotResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type ForwardValues = "none"|"allow-list"|"all"|string;
export interface GetActiveNamesRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetActiveNamesResult {
/**
* The list of active names returned by the get active names request.
*/
activeNames?: StringList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetAlarmsRequest {
/**
* The name of the alarm. Specify an alarm name to return information about a specific alarm.
*/
alarmName?: ResourceName;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
/**
* The name of the Lightsail resource being monitored by the alarm. Specify a monitored resource name to return information about all alarms for a specific resource.
*/
monitoredResourceName?: ResourceName;
}
export interface GetAlarmsResult {
/**
* An array of objects that describe the alarms.
*/
alarms?: AlarmsList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetAutoSnapshotsRequest {
/**
* The name of the source instance or disk from which to get automatic snapshot information.
*/
resourceName: ResourceName;
}
export interface GetAutoSnapshotsResult {
/**
* The name of the source instance or disk for the automatic snapshots.
*/
resourceName?: ResourceName;
/**
* The resource type (e.g., Instance or Disk).
*/
resourceType?: ResourceType;
/**
* An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.
*/
autoSnapshots?: AutoSnapshotDetailsList;
}
export interface GetBlueprintsRequest {
/**
* A Boolean value indicating whether to include inactive results in your request.
*/
includeInactive?: boolean;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetBlueprintsResult {
/**
* An array of key-value pairs that contains information about the available blueprints.
*/
blueprints?: BlueprintList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBlueprints request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetBundlesRequest {
/**
* A Boolean value that indicates whether to include inactive bundle results in your request.
*/
includeInactive?: boolean;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetBundlesResult {
/**
* An array of key-value pairs that contains information about the available bundles.
*/
bundles?: BundleList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBundles request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetCertificatesRequest {
/**
* The status of the certificates for which to return information. For example, specify ISSUED to return only certificates with an ISSUED status. When omitted, the response includes all of your certificates in the AWS region where the request is made, regardless of their current status.
*/
certificateStatuses?: CertificateStatusList;
/**
* Indicates whether to include detailed information about the certificates in the response. When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.
*/
includeCertificateDetails?: IncludeCertificateDetails;
/**
* The name for the certificate for which to return information. When omitted, the response includes all of your certificates in the AWS region where the request is made.
*/
certificateName?: CertificateName;
}
export interface GetCertificatesResult {
/**
* An object that describes certificates.
*/
certificates?: CertificateSummaryList;
}
export interface GetCloudFormationStackRecordsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetClouFormationStackRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetCloudFormationStackRecordsResult {
/**
* A list of objects describing the CloudFormation stack records.
*/
cloudFormationStackRecords?: CloudFormationStackRecordList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetContactMethodsRequest {
/**
* The protocols used to send notifications, such as Email, or SMS (text messaging). Specify a protocol in your request to return information about a specific contact method protocol.
*/
protocols?: ContactProtocolsList;
}
export interface GetContactMethodsResult {
/**
* An array of objects that describe the contact methods.
*/
contactMethods?: ContactMethodsList;
}
export interface GetDiskRequest {
/**
* The name of the disk (e.g., my-disk).
*/
diskName: ResourceName;
}
export interface GetDiskResult {
/**
* An object containing information about the disk.
*/
disk?: Disk;
}
export interface GetDiskSnapshotRequest {
/**
* The name of the disk snapshot (e.g., my-disk-snapshot).
*/
diskSnapshotName: ResourceName;
}
export interface GetDiskSnapshotResult {
/**
* An object containing information about the disk snapshot.
*/
diskSnapshot?: DiskSnapshot;
}
export interface GetDiskSnapshotsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetDiskSnapshotsResult {
/**
* An array of objects containing information about all block storage disk snapshots.
*/
diskSnapshots?: DiskSnapshotList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetDisksRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetDisksResult {
/**
* An array of objects containing information about all block storage disks.
*/
disks?: DiskList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetDistributionBundlesRequest {
}
export interface GetDistributionBundlesResult {
/**
* An object that describes a distribution bundle.
*/
bundles?: DistributionBundleList;
}
export interface GetDistributionLatestCacheResetRequest {
/**
* The name of the distribution for which to return the timestamp of the last cache reset. Use the GetDistributions action to get a list of distribution names that you can specify. When omitted, the response includes the latest cache reset timestamp of all your distributions.
*/
distributionName?: ResourceName;
}
export interface GetDistributionLatestCacheResetResult {
/**
* The status of the last cache reset.
*/
status?: string;
/**
* The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time format.
*/
createTime?: IsoDate;
}
export interface GetDistributionMetricDataRequest {
/**
* The name of the distribution for which to get metric data. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName: ResourceName;
/**
* The metric for which you want to return information. Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx. Statistics: The most useful statistic is Average. Unit: The published unit is Percent. 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found. Statistics: The most useful statistic is Average. Unit: The published unit is Percent. 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
*/
metricName: DistributionMetricName;
/**
* The start of the time interval for which to get metric data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/
startTime: timestamp;
/**
* The end of the time interval for which to get metric data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/
endTime: timestamp;
/**
* The granularity, in seconds, for the metric data points that will be returned.
*/
period: MetricPeriod;
/**
* The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.
*/
unit: MetricUnit;
/**
* The statistic for the metric. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.
*/
statistics: MetricStatisticList;
}
export interface GetDistributionMetricDataResult {
/**
* The name of the metric returned.
*/
metricName?: DistributionMetricName;
/**
* An array of objects that describe the metric data returned.
*/
metricData?: MetricDatapointList;
}
export interface GetDistributionsRequest {
/**
* The name of the distribution for which to return information. Use the GetDistributions action to get a list of distribution names that you can specify. When omitted, the response includes all of your distributions in the AWS Region where the request is made.
*/
distributionName?: ResourceName;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetDistributionsResult {
/**
* An array of objects that describe your distributions.
*/
distributions?: DistributionList;
/**
* The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetDomainRequest {
/**
* The domain name for which your want to return information about.
*/
domainName: DomainName;
}
export interface GetDomainResult {
/**
* An array of key-value pairs containing information about your get domain request.
*/
domain?: Domain;
}
export interface GetDomainsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetDomainsResult {
/**
* An array of key-value pairs containing information about each of the domain entries in the user's account.
*/
domains?: DomainList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetExportSnapshotRecordsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetExportSnapshotRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetExportSnapshotRecordsResult {
/**
* A list of objects describing the export snapshot records.
*/
exportSnapshotRecords?: ExportSnapshotRecordList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetInstanceAccessDetailsRequest {
/**
* The name of the instance to access.
*/
instanceName: ResourceName;
/**
* The protocol to use to connect to your instance. Defaults to ssh.
*/
protocol?: InstanceAccessProtocol;
}
export interface GetInstanceAccessDetailsResult {
/**
* An array of key-value pairs containing information about a get instance access request.
*/
accessDetails?: InstanceAccessDetails;
}
export interface GetInstanceMetricDataRequest {
/**
* The name of the instance for which you want to get metrics data.
*/
instanceName: ResourceName;
/**
* The metric for which you want to return information. Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%. Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Seconds. CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count.
*/
metricName: InstanceMetricName;
/**
* The granularity, in seconds, of the returned data points. The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.
*/
period: MetricPeriod;
/**
* The start time of the time period.
*/
startTime: timestamp;
/**
* The end time of the time period.
*/
endTime: timestamp;
/**
* The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter.
*/
unit: MetricUnit;
/**
* The statistic for the metric. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.
*/
statistics: MetricStatisticList;
}
export interface GetInstanceMetricDataResult {
/**
* The name of the metric returned.
*/
metricName?: InstanceMetricName;
/**
* An array of objects that describe the metric data returned.
*/
metricData?: MetricDatapointList;
}
export interface GetInstancePortStatesRequest {
/**
* The name of the instance for which to return firewall port states.
*/
instanceName: ResourceName;
}
export interface GetInstancePortStatesResult {
/**
* An array of objects that describe the firewall port states for the specified instance.
*/
portStates?: InstancePortStateList;
}
export interface GetInstanceRequest {
/**
* The name of the instance.
*/
instanceName: ResourceName;
}
export interface GetInstanceResult {
/**
* An array of key-value pairs containing information about the specified instance.
*/
instance?: Instance;
}
export interface GetInstanceSnapshotRequest {
/**
* The name of the snapshot for which you are requesting information.
*/
instanceSnapshotName: ResourceName;
}
export interface GetInstanceSnapshotResult {
/**
* An array of key-value pairs containing information about the results of your get instance snapshot request.
*/
instanceSnapshot?: InstanceSnapshot;
}
export interface GetInstanceSnapshotsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetInstanceSnapshotsResult {
/**
* An array of key-value pairs containing information about the results of your get instance snapshots request.
*/
instanceSnapshots?: InstanceSnapshotList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetInstanceStateRequest {
/**
* The name of the instance to get state information about.
*/
instanceName: ResourceName;
}
export interface GetInstanceStateResult {
/**
* The state of the instance.
*/
state?: InstanceState;
}
export interface GetInstancesRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetInstancesResult {
/**
* An array of key-value pairs containing information about your instances.
*/
instances?: InstanceList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetKeyPairRequest {
/**
* The name of the key pair for which you are requesting information.
*/
keyPairName: ResourceName;
}
export interface GetKeyPairResult {
/**
* An array of key-value pairs containing information about the key pair.
*/
keyPair?: KeyPair;
}
export interface GetKeyPairsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetKeyPairsResult {
/**
* An array of key-value pairs containing information about the key pairs.
*/
keyPairs?: KeyPairList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetLoadBalancerMetricDataRequest {
/**
* The name of the load balancer.
*/
loadBalancerName: ResourceName;
/**
* The metric for which you want to return information. Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count. HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics: The most useful statistic is Average. Unit: The published unit is Seconds. RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. UnhealthyHostCount - The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count.
*/
metricName: LoadBalancerMetricName;
/**
* The granularity, in seconds, of the returned data points.
*/
period: MetricPeriod;
/**
* The start time of the period.
*/
startTime: timestamp;
/**
* The end time of the period.
*/
endTime: timestamp;
/**
* The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.
*/
unit: MetricUnit;
/**
* The statistic for the metric. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.
*/
statistics: MetricStatisticList;
}
export interface GetLoadBalancerMetricDataResult {
/**
* The name of the metric returned.
*/
metricName?: LoadBalancerMetricName;
/**
* An array of objects that describe the metric data returned.
*/
metricData?: MetricDatapointList;
}
export interface GetLoadBalancerRequest {
/**
* The name of the load balancer.
*/
loadBalancerName: ResourceName;
}
export interface GetLoadBalancerResult {
/**
* An object containing information about your load balancer.
*/
loadBalancer?: LoadBalancer;
}
export interface GetLoadBalancerTlsCertificatesRequest {
/**
* The name of the load balancer you associated with your SSL/TLS certificate.
*/
loadBalancerName: ResourceName;
}
export interface GetLoadBalancerTlsCertificatesResult {
/**
* An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
*/
tlsCertificates?: LoadBalancerTlsCertificateList;
}
export interface GetLoadBalancersRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetLoadBalancersResult {
/**
* An array of LoadBalancer objects describing your load balancers.
*/
loadBalancers?: LoadBalancerList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetOperationRequest {
/**
* A GUID used to identify the operation.
*/
operationId: NonEmptyString;
}
export interface GetOperationResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface GetOperationsForResourceRequest {
/**
* The name of the resource for which you are requesting information.
*/
resourceName: ResourceName;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetOperationsForResourceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
/**
* (Deprecated) Returns the number of pages of results that remain. In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead.
*/
nextPageCount?: string;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetOperationsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetOperationsResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetRegionsRequest {
/**
* A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-2a.
*/
includeAvailabilityZones?: boolean;
/**
* >A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).
*/
includeRelationalDatabaseAvailabilityZones?: boolean;
}
export interface GetRegionsResult {
/**
* An array of key-value pairs containing information about your get regions request.
*/
regions?: RegionList;
}
export interface GetRelationalDatabaseBlueprintsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabaseBlueprintsResult {
/**
* An object describing the result of your get relational database blueprints request.
*/
blueprints?: RelationalDatabaseBlueprintList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetRelationalDatabaseBundlesRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabaseBundlesResult {
/**
* An object describing the result of your get relational database bundles request.
*/
bundles?: RelationalDatabaseBundleList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetRelationalDatabaseEventsRequest {
/**
* The name of the database from which to get events.
*/
relationalDatabaseName: ResourceName;
/**
* The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120. Default: 60 The minimum is 1 and the maximum is 14 days (20160 minutes).
*/
durationInMinutes?: integer;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseEvents request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabaseEventsResult {
/**
* An object describing the result of your get relational database events request.
*/
relationalDatabaseEvents?: RelationalDatabaseEventList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetRelationalDatabaseLogEventsRequest {
/**
* The name of your database for which to get log events.
*/
relationalDatabaseName: ResourceName;
/**
* The name of the log stream. Use the get relational database log streams operation to get a list of available log streams.
*/
logStreamName: string;
/**
* The start of the time interval from which to get log events. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.
*/
startTime?: IsoDate;
/**
* The end of the time interval from which to get log events. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.
*/
endTime?: IsoDate;
/**
* Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log. For PostgreSQL, the default value of false is the only option available.
*/
startFromHead?: boolean;
/**
* The token to advance to the next or previous page of results from your request. To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabaseLogEventsResult {
/**
* An object describing the result of your get relational database log events request.
*/
resourceLogEvents?: LogEventList;
/**
* A token used for advancing to the previous page of results from your get relational database log events request.
*/
nextBackwardToken?: string;
/**
* A token used for advancing to the next page of results from your get relational database log events request.
*/
nextForwardToken?: string;
}
export interface GetRelationalDatabaseLogStreamsRequest {
/**
* The name of your database for which to get log streams.
*/
relationalDatabaseName: ResourceName;
}
export interface GetRelationalDatabaseLogStreamsResult {
/**
* An object describing the result of your get relational database log streams request.
*/
logStreams?: StringList;
}
export interface GetRelationalDatabaseMasterUserPasswordRequest {
/**
* The name of your database for which to get the master user password.
*/
relationalDatabaseName: ResourceName;
/**
* The password version to return. Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available. Default: CURRENT
*/
passwordVersion?: RelationalDatabasePasswordVersion;
}
export interface GetRelationalDatabaseMasterUserPasswordResult {
/**
* The master user password for the password version specified.
*/
masterUserPassword?: SensitiveString;
/**
* The timestamp when the specified version of the master user password was created.
*/
createdAt?: IsoDate;
}
export interface GetRelationalDatabaseMetricDataRequest {
/**
* The name of your database from which to get metric data.
*/
relationalDatabaseName: ResourceName;
/**
* The metric for which you want to return information. Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity. CPUUtilization - The percentage of CPU utilization currently in use on the database. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. DatabaseConnections - The number of database connections in use. Statistics: The most useful statistics are Maximum and Sum. Unit: The published unit is Count. DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. FreeStorageSpace - The amount of available storage space. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second. NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second.
*/
metricName: RelationalDatabaseMetricName;
/**
* The granularity, in seconds, of the returned data points. All relational database metric data is available in 1-minute (60 seconds) granularity.
*/
period: MetricPeriod;
/**
* The start of the time interval from which to get metric data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.
*/
startTime: IsoDate;
/**
* The end of the time interval from which to get metric data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.
*/
endTime: IsoDate;
/**
* The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.
*/
unit: MetricUnit;
/**
* The statistic for the metric. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.
*/
statistics: MetricStatisticList;
}
export interface GetRelationalDatabaseMetricDataResult {
/**
* The name of the metric returned.
*/
metricName?: RelationalDatabaseMetricName;
/**
* An array of objects that describe the metric data returned.
*/
metricData?: MetricDatapointList;
}
export interface GetRelationalDatabaseParametersRequest {
/**
* The name of your database for which to get parameters.
*/
relationalDatabaseName: ResourceName;
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseParameters request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabaseParametersResult {
/**
* An object describing the result of your get relational database parameters request.
*/
parameters?: RelationalDatabaseParameterList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetRelationalDatabaseRequest {
/**
* The name of the database that you are looking up.
*/
relationalDatabaseName: ResourceName;
}
export interface GetRelationalDatabaseResult {
/**
* An object describing the specified database.
*/
relationalDatabase?: RelationalDatabase;
}
export interface GetRelationalDatabaseSnapshotRequest {
/**
* The name of the database snapshot for which to get information.
*/
relationalDatabaseSnapshotName: ResourceName;
}
export interface GetRelationalDatabaseSnapshotResult {
/**
* An object describing the specified database snapshot.
*/
relationalDatabaseSnapshot?: RelationalDatabaseSnapshot;
}
export interface GetRelationalDatabaseSnapshotsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabaseSnapshotsResult {
/**
* An object describing the result of your get relational database snapshots request.
*/
relationalDatabaseSnapshots?: RelationalDatabaseSnapshotList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetRelationalDatabasesRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetRelationalDatabasesResult {
/**
* An object describing the result of your get relational databases request.
*/
relationalDatabases?: RelationalDatabaseList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export interface GetStaticIpRequest {
/**
* The name of the static IP in Lightsail.
*/
staticIpName: ResourceName;
}
export interface GetStaticIpResult {
/**
* An array of key-value pairs containing information about the requested static IP.
*/
staticIp?: StaticIp;
}
export interface GetStaticIpsRequest {
/**
* The token to advance to the next page of results from your request. To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
*/
pageToken?: string;
}
export interface GetStaticIpsResult {
/**
* An array of key-value pairs containing information about your get static IPs request.
*/
staticIps?: StaticIpList;
/**
* The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.
*/
nextPageToken?: string;
}
export type HeaderEnum = "Accept"|"Accept-Charset"|"Accept-Datetime"|"Accept-Encoding"|"Accept-Language"|"Authorization"|"CloudFront-Forwarded-Proto"|"CloudFront-Is-Desktop-Viewer"|"CloudFront-Is-Mobile-Viewer"|"CloudFront-Is-SmartTV-Viewer"|"CloudFront-Is-Tablet-Viewer"|"CloudFront-Viewer-Country"|"Host"|"Origin"|"Referer"|string;
export type HeaderForwardList = HeaderEnum[];
export interface HeaderObject {
/**
* The headers that you want your distribution to forward to your origin and base caching on. You can configure your distribution to do one of the following: all - Forward all headers to your origin. none - Forward only the default headers. allow-list - Forward only the headers you specify using the headersAllowList parameter.
*/
option?: ForwardValues;
/**
* The specific headers to forward to your distribution's origin.
*/
headersAllowList?: HeaderForwardList;
}
export interface HostKeyAttributes {
/**
* The SSH host key algorithm or the RDP certificate format. For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.
*/
algorithm?: string;
/**
* The public SSH host key or the RDP certificate.
*/
publicKey?: string;
/**
* The time that the SSH host key or RDP certificate was recorded by Lightsail.
*/
witnessedAt?: IsoDate;
/**
* The SHA-1 fingerprint of the returned SSH host key or RDP certificate. Example of an SHA-1 SSH fingerprint: SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0 Example of an SHA-1 RDP fingerprint: af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45
*/
fingerprintSHA1?: string;
/**
* The SHA-256 fingerprint of the returned SSH host key or RDP certificate. Example of an SHA-256 SSH fingerprint: SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o Example of an SHA-256 RDP fingerprint: 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68
*/
fingerprintSHA256?: string;
/**
* The returned RDP certificate is valid after this point in time. This value is listed only for RDP certificates.
*/
notValidBefore?: IsoDate;
/**
* The returned RDP certificate is not valid after this point in time. This value is listed only for RDP certificates.
*/
notValidAfter?: IsoDate;
}
export type HostKeysList = HostKeyAttributes[];
export interface ImportKeyPairRequest {
/**
* The name of the key pair for which you want to import the public key.
*/
keyPairName: ResourceName;
/**
* A base64-encoded public key of the ssh-rsa type.
*/
publicKeyBase64: Base64;
}
export interface ImportKeyPairResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export type InUseResourceCount = number;
export type IncludeCertificateDetails = boolean;
export interface InputOrigin {
/**
* The name of the origin resource.
*/
name?: ResourceName;
/**
* The AWS Region name of the origin resource.
*/
regionName?: RegionName;
/**
* The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
*/
protocolPolicy?: OriginProtocolPolicyEnum;
}
export interface Instance {
/**
* The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the instance was created (e.g., 1479734909.17) in Unix time format.
*/
createdAt?: IsoDate;
/**
* The region name and Availability Zone where the instance is located.
*/
location?: ResourceLocation;
/**
* The type of resource (usually Instance).
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The blueprint ID (e.g., os_amlinux_2016_03).
*/
blueprintId?: NonEmptyString;
/**
* The friendly name of the blueprint (e.g., Amazon Linux).
*/
blueprintName?: NonEmptyString;
/**
* The bundle for the instance (e.g., micro_1_0).
*/
bundleId?: NonEmptyString;
/**
* An array of objects representing the add-ons enabled on the instance.
*/
addOns?: AddOnList;
/**
* A Boolean value indicating whether this instance has a static IP assigned to it.
*/
isStaticIp?: boolean;
/**
* The private IP address of the instance.
*/
privateIpAddress?: IpAddress;
/**
* The public IP address of the instance.
*/
publicIpAddress?: IpAddress;
/**
* The IPv6 address of the instance.
*/
ipv6Address?: IpV6Address;
/**
* The size of the vCPU and the amount of RAM for the instance.
*/
hardware?: InstanceHardware;
/**
* Information about the public ports and monthly data transfer rates for the instance.
*/
networking?: InstanceNetworking;
/**
* The status code and the state (e.g., running) for the instance.
*/
state?: InstanceState;
/**
* The user name for connecting to the instance (e.g., ec2-user).
*/
username?: NonEmptyString;
/**
* The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
*/
sshKeyName?: ResourceName;
}
export interface InstanceAccessDetails {
/**
* For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.
*/
certKey?: string;
/**
* For SSH access, the date on which the temporary keys expire.
*/
expiresAt?: IsoDate;
/**
* The public IP address of the Amazon Lightsail instance.
*/
ipAddress?: IpAddress;
/**
* For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string. If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
*/
password?: string;
/**
* For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
*/
passwordData?: PasswordData;
/**
* For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).
*/
privateKey?: string;
/**
* The protocol for these Amazon Lightsail instance access details.
*/
protocol?: InstanceAccessProtocol;
/**
* The name of this Amazon Lightsail instance.
*/
instanceName?: ResourceName;
/**
* The user name to use when logging in to the Amazon Lightsail instance.
*/
username?: string;
/**
* Describes the public SSH host keys or the RDP certificate.
*/
hostKeys?: HostKeysList;
}
export type InstanceAccessProtocol = "ssh"|"rdp"|string;
export interface InstanceEntry {
/**
* The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance. Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.
*/
sourceName: ResourceName;
/**
* The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.
*/
instanceType: NonEmptyString;
/**
* The port configuration to use for the new Amazon EC2 instance. The following configuration options are available: DEFAULT - Use the default firewall settings from the Lightsail instance blueprint. INSTANCE - Use the configured firewall settings from the source Lightsail instance. NONE - Use the default Amazon EC2 security group. CLOSED - All ports closed. If you configured lightsail-connect as a cidrListAliases on your instance, or if you chose to allow the Lightsail browser-based SSH or RDP clients to connect to your instance, that configuration is not carried over to your new Amazon EC2 instance.
*/
portInfoSource: PortInfoSourceType;
/**
* A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.
*/
userData?: string;
/**
* The Availability Zone for the new Amazon EC2 instance.
*/
availabilityZone: string;
}
export type InstanceEntryList = InstanceEntry[];
export interface InstanceHardware {
/**
* The number of vCPUs the instance has.
*/
cpuCount?: integer;
/**
* The disks attached to the instance.
*/
disks?: DiskList;
/**
* The amount of RAM in GB on the instance (e.g., 1.0).
*/
ramSizeInGb?: float;
}
export type InstanceHealthReason = "Lb.RegistrationInProgress"|"Lb.InitialHealthChecking"|"Lb.InternalError"|"Instance.ResponseCodeMismatch"|"Instance.Timeout"|"Instance.FailedHealthChecks"|"Instance.NotRegistered"|"Instance.NotInUse"|"Instance.DeregistrationInProgress"|"Instance.InvalidState"|"Instance.IpUnusable"|string;
export type InstanceHealthState = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string;
export interface InstanceHealthSummary {
/**
* The name of the Lightsail instance for which you are requesting health check data.
*/
instanceName?: ResourceName;
/**
* Describes the overall instance health. Valid values are below.
*/
instanceHealth?: InstanceHealthState;
/**
* More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided. If instanceHealth is initial, the instanceHealthReason value can be one of the following: Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer. Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status. If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following: Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Instance.Timeout - The health check requests timed out. Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason. Lb.InternalError - The health checks failed due to an internal error. If instanceHealth is unused, the instanceHealthReason value can be one of the following: Instance.NotRegistered - The target instance is not registered with the target group. Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer. Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer. Instance.InvalidState - The target is in the stopped or terminated state. If instanceHealth is draining, the instanceHealthReason value can be one of the following: Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.
*/
instanceHealthReason?: InstanceHealthReason;
}
export type InstanceHealthSummaryList = InstanceHealthSummary[];
export type InstanceList = Instance[];
export type InstanceMetricName = "CPUUtilization"|"NetworkIn"|"NetworkOut"|"StatusCheckFailed"|"StatusCheckFailed_Instance"|"StatusCheckFailed_System"|"BurstCapacityTime"|"BurstCapacityPercentage"|string;
export interface InstanceNetworking {
/**
* The amount of data in GB allocated for monthly data transfers.
*/
monthlyTransfer?: MonthlyTransfer;
/**
* An array of key-value pairs containing information about the ports on the instance.
*/
ports?: InstancePortInfoList;
}
export type InstancePlatform = "LINUX_UNIX"|"WINDOWS"|string;
export type InstancePlatformList = InstancePlatform[];
export interface InstancePortInfo {
/**
* The first port in a range of open ports on an instance. Allowed ports: TCP and UDP - 0 to 65535 ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
*/
fromPort?: Port;
/**
* The last port in a range of open ports on an instance. Allowed ports: TCP and UDP - 0 to 65535 ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
*/
toPort?: Port;
/**
* The IP protocol name. The name can be one of the following: tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
*/
protocol?: NetworkProtocol;
/**
* The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.
*/
accessFrom?: string;
/**
* The type of access (Public or Private).
*/
accessType?: PortAccessType;
/**
* The common name of the port information.
*/
commonName?: string;
/**
* The access direction (inbound or outbound). Lightsail currently supports only inbound access direction.
*/
accessDirection?: AccessDirection;
/**
* The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
*/
cidrs?: StringList;
/**
* An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
*/
cidrListAliases?: StringList;
}
export type InstancePortInfoList = InstancePortInfo[];
export interface InstancePortState {
/**
* The first port in a range of open ports on an instance. Allowed ports: TCP and UDP - 0 to 65535 ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
*/
fromPort?: Port;
/**
* The last port in a range of open ports on an instance. Allowed ports: TCP and UDP - 0 to 65535 ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
*/
toPort?: Port;
/**
* The IP protocol name. The name can be one of the following: tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
*/
protocol?: NetworkProtocol;
/**
* Specifies whether the instance port is open or closed. The port state for Lightsail instances is always open.
*/
state?: PortState;
/**
* The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
*/
cidrs?: StringList;
/**
* An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
*/
cidrListAliases?: StringList;
}
export type InstancePortStateList = InstancePortState[];
export interface InstanceSnapshot {
/**
* The name of the snapshot.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the snapshot was created (e.g., 1479907467.024).
*/
createdAt?: IsoDate;
/**
* The region name and Availability Zone where you created the snapshot.
*/
location?: ResourceLocation;
/**
* The type of resource (usually InstanceSnapshot).
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The state the snapshot is in.
*/
state?: InstanceSnapshotState;
/**
* The progress of the snapshot.
*/
progress?: string;
/**
* An array of disk objects containing information about all block storage disks.
*/
fromAttachedDisks?: DiskList;
/**
* The instance from which the snapshot was created.
*/
fromInstanceName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
*/
fromInstanceArn?: NonEmptyString;
/**
* The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.
*/
fromBlueprintId?: string;
/**
* The bundle ID from which you created the snapshot (e.g., micro_1_0).
*/
fromBundleId?: string;
/**
* A Boolean value indicating whether the snapshot was created from an automatic snapshot.
*/
isFromAutoSnapshot?: boolean;
/**
* The size in GB of the SSD.
*/
sizeInGb?: integer;
}
export interface InstanceSnapshotInfo {
/**
* The bundle ID from which the source instance was created (e.g., micro_1_0).
*/
fromBundleId?: NonEmptyString;
/**
* The blueprint ID from which the source instance (e.g., os_debian_8_3).
*/
fromBlueprintId?: NonEmptyString;
/**
* A list of objects describing the disks that were attached to the source instance.
*/
fromDiskInfo?: DiskInfoList;
}
export type InstanceSnapshotList = InstanceSnapshot[];
export type InstanceSnapshotState = "pending"|"error"|"available"|string;
export interface InstanceState {
/**
* The status code for the instance.
*/
code?: integer;
/**
* The state of the instance (e.g., running or pending).
*/
name?: string;
}
export type IpAddress = string;
export type IpV6Address = string;
export interface IsVpcPeeredRequest {
}
export interface IsVpcPeeredResult {
/**
* Returns true if the Lightsail VPC is peered; otherwise, false.
*/
isPeered?: boolean;
}
export type IsoDate = Date;
export type IssuerCA = string;
export type KeyAlgorithm = string;
export interface KeyPair {
/**
* The friendly name of the SSH key pair.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the key pair was created (e.g., 1479816991.349).
*/
createdAt?: IsoDate;
/**
* The region name and Availability Zone where the key pair was created.
*/
location?: ResourceLocation;
/**
* The resource type (usually KeyPair).
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The RSA fingerprint of the key pair.
*/
fingerprint?: Base64;
}
export type KeyPairList = KeyPair[];
export interface LightsailDistribution {
/**
* The name of the distribution.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the distribution.
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about your Lightsail distribution. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the distribution was created.
*/
createdAt?: IsoDate;
/**
* An object that describes the location of the distribution, such as the AWS Region and Availability Zone. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type (e.g., Distribution).
*/
resourceType?: ResourceType;
/**
* The alternate domain names of the distribution.
*/
alternativeDomainNames?: StringList;
/**
* The status of the distribution.
*/
status?: string;
/**
* Indicates whether the distribution is enabled.
*/
isEnabled?: boolean;
/**
* The domain name of the distribution.
*/
domainName?: string;
/**
* The ID of the bundle currently applied to the distribution.
*/
bundleId?: string;
/**
* The name of the SSL/TLS certificate attached to the distribution, if any.
*/
certificateName?: ResourceName;
/**
* An object that describes the origin resource of the distribution, such as a Lightsail instance or load balancer. The distribution pulls, caches, and serves content from the origin.
*/
origin?: Origin;
/**
* The public DNS of the origin.
*/
originPublicDNS?: string;
/**
* An object that describes the default cache behavior of the distribution.
*/
defaultCacheBehavior?: CacheBehavior;
/**
* An object that describes the cache behavior settings of the distribution.
*/
cacheBehaviorSettings?: CacheSettings;
/**
* An array of objects that describe the per-path cache behavior of the distribution.
*/
cacheBehaviors?: CacheBehaviorList;
/**
* Indicates whether the bundle that is currently applied to your distribution, specified using the distributionName parameter, can be changed to another bundle. Use the UpdateDistributionBundle action to change your distribution's bundle.
*/
ableToUpdateBundle?: boolean;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
}
export interface LoadBalancer {
/**
* The name of the load balancer (e.g., my-load-balancer).
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The date when your load balancer was created.
*/
createdAt?: IsoDate;
/**
* The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.
*/
location?: ResourceLocation;
/**
* The resource type (e.g., LoadBalancer.
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The DNS name of your Lightsail load balancer.
*/
dnsName?: NonEmptyString;
/**
* The status of your load balancer. Valid values are below.
*/
state?: LoadBalancerState;
/**
* The protocol you have enabled for your load balancer. Valid values are below. You can't just have HTTP_HTTPS, but you can have just HTTP.
*/
protocol?: LoadBalancerProtocol;
/**
* An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
*/
publicPorts?: PortList;
/**
* The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.
*/
healthCheckPath?: NonEmptyString;
/**
* The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.
*/
instancePort?: integer;
/**
* An array of InstanceHealthSummary objects describing the health of the load balancer.
*/
instanceHealthSummary?: InstanceHealthSummaryList;
/**
* An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.
*/
tlsCertificateSummaries?: LoadBalancerTlsCertificateSummaryList;
/**
* A string to string map of the configuration options for your load balancer. Valid values are listed below.
*/
configurationOptions?: LoadBalancerConfigurationOptions;
}
export type LoadBalancerAttributeName = "HealthCheckPath"|"SessionStickinessEnabled"|"SessionStickiness_LB_CookieDurationSeconds"|string;
export type LoadBalancerConfigurationOptions = {[key: string]: string};
export type LoadBalancerList = LoadBalancer[];
export type LoadBalancerMetricName = "ClientTLSNegotiationErrorCount"|"HealthyHostCount"|"UnhealthyHostCount"|"HTTPCode_LB_4XX_Count"|"HTTPCode_LB_5XX_Count"|"HTTPCode_Instance_2XX_Count"|"HTTPCode_Instance_3XX_Count"|"HTTPCode_Instance_4XX_Count"|"HTTPCode_Instance_5XX_Count"|"InstanceResponseTime"|"RejectedConnectionCount"|"RequestCount"|string;
export type LoadBalancerProtocol = "HTTP_HTTPS"|"HTTP"|string;
export type LoadBalancerState = "active"|"provisioning"|"active_impaired"|"failed"|"unknown"|string;
export interface LoadBalancerTlsCertificate {
/**
* The name of the SSL/TLS certificate (e.g., my-certificate).
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the SSL/TLS certificate.
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The time when you created your SSL/TLS certificate.
*/
createdAt?: IsoDate;
/**
* The AWS Region and Availability Zone where you created your certificate.
*/
location?: ResourceLocation;
/**
* The resource type (e.g., LoadBalancerTlsCertificate). Instance - A Lightsail instance (a virtual private server) StaticIp - A static IP address KeyPair - The key pair used to connect to a Lightsail instance InstanceSnapshot - A Lightsail instance snapshot Domain - A DNS zone PeeredVpc - A peered VPC LoadBalancer - A Lightsail load balancer LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer Disk - A Lightsail block storage disk DiskSnapshot - A block storage disk snapshot
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The load balancer name where your SSL/TLS certificate is attached.
*/
loadBalancerName?: ResourceName;
/**
* When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
*/
isAttached?: boolean;
/**
* The validation status of the SSL/TLS certificate. Valid values are below.
*/
status?: LoadBalancerTlsCertificateStatus;
/**
* The domain name for your SSL/TLS certificate.
*/
domainName?: DomainName;
/**
* An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
*/
domainValidationRecords?: LoadBalancerTlsCertificateDomainValidationRecordList;
/**
* The validation failure reason, if any, of the certificate. The following failure reasons are possible: NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates. ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support. You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do. If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate. If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case. INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain. OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.
*/
failureReason?: LoadBalancerTlsCertificateFailureReason;
/**
* The time when the SSL/TLS certificate was issued.
*/
issuedAt?: IsoDate;
/**
* The issuer of the certificate.
*/
issuer?: NonEmptyString;
/**
* The algorithm used to generate the key pair (the public and private key).
*/
keyAlgorithm?: NonEmptyString;
/**
* The timestamp when the SSL/TLS certificate expires.
*/
notAfter?: IsoDate;
/**
* The timestamp when the SSL/TLS certificate is first valid.
*/
notBefore?: IsoDate;
/**
* An object that describes the status of the certificate renewal managed by Lightsail.
*/
renewalSummary?: LoadBalancerTlsCertificateRenewalSummary;
/**
* The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.
*/
revocationReason?: LoadBalancerTlsCertificateRevocationReason;
/**
* The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.
*/
revokedAt?: IsoDate;
/**
* The serial number of the certificate.
*/
serial?: NonEmptyString;
/**
* The algorithm that was used to sign the certificate.
*/
signatureAlgorithm?: NonEmptyString;
/**
* The name of the entity that is associated with the public key contained in the certificate.
*/
subject?: NonEmptyString;
/**
* An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.
*/
subjectAlternativeNames?: StringList;
}
export type LoadBalancerTlsCertificateDomainStatus = "PENDING_VALIDATION"|"FAILED"|"SUCCESS"|string;
export interface LoadBalancerTlsCertificateDomainValidationOption {
/**
* The fully qualified domain name in the certificate request.
*/
domainName?: DomainName;
/**
* The status of the domain validation. Valid values are listed below.
*/
validationStatus?: LoadBalancerTlsCertificateDomainStatus;
}
export type LoadBalancerTlsCertificateDomainValidationOptionList = LoadBalancerTlsCertificateDomainValidationOption[];
export interface LoadBalancerTlsCertificateDomainValidationRecord {
/**
* A fully qualified domain name in the certificate. For example, example.com.
*/
name?: NonEmptyString;
/**
* The type of validation record. For example, CNAME for domain validation.
*/
type?: NonEmptyString;
/**
* The value for that type.
*/
value?: NonEmptyString;
/**
* The validation status. Valid values are listed below.
*/
validationStatus?: LoadBalancerTlsCertificateDomainStatus;
/**
* The domain name against which your SSL/TLS certificate was validated.
*/
domainName?: DomainName;
}
export type LoadBalancerTlsCertificateDomainValidationRecordList = LoadBalancerTlsCertificateDomainValidationRecord[];
export type LoadBalancerTlsCertificateFailureReason = "NO_AVAILABLE_CONTACTS"|"ADDITIONAL_VERIFICATION_REQUIRED"|"DOMAIN_NOT_ALLOWED"|"INVALID_PUBLIC_DOMAIN"|"OTHER"|string;
export type LoadBalancerTlsCertificateList = LoadBalancerTlsCertificate[];
export type LoadBalancerTlsCertificateRenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED"|string;
export interface LoadBalancerTlsCertificateRenewalSummary {
/**
* The renewal status of the certificate. The following renewal status are possible: PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required. PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use. Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required. Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.
*/
renewalStatus?: LoadBalancerTlsCertificateRenewalStatus;
/**
* Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.
*/
domainValidationOptions?: LoadBalancerTlsCertificateDomainValidationOptionList;
}
export type LoadBalancerTlsCertificateRevocationReason = "UNSPECIFIED"|"KEY_COMPROMISE"|"CA_COMPROMISE"|"AFFILIATION_CHANGED"|"SUPERCEDED"|"CESSATION_OF_OPERATION"|"CERTIFICATE_HOLD"|"REMOVE_FROM_CRL"|"PRIVILEGE_WITHDRAWN"|"A_A_COMPROMISE"|string;
export type LoadBalancerTlsCertificateStatus = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"|"UNKNOWN"|string;
export interface LoadBalancerTlsCertificateSummary {
/**
* The name of the SSL/TLS certificate.
*/
name?: ResourceName;
/**
* When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
*/
isAttached?: boolean;
}
export type LoadBalancerTlsCertificateSummaryList = LoadBalancerTlsCertificateSummary[];
export interface LogEvent {
/**
* The timestamp when the database log event was created.
*/
createdAt?: IsoDate;
/**
* The message of the database log event.
*/
message?: string;
}
export type LogEventList = LogEvent[];
export interface MetricDatapoint {
/**
* The average.
*/
average?: double;
/**
* The maximum.
*/
maximum?: double;
/**
* The minimum.
*/
minimum?: double;
/**
* The sample count.
*/
sampleCount?: double;
/**
* The sum.
*/
sum?: double;
/**
* The timestamp (e.g., 1479816991.349).
*/
timestamp?: timestamp;
/**
* The unit.
*/
unit?: MetricUnit;
}
export type MetricDatapointList = MetricDatapoint[];
export type MetricName = "CPUUtilization"|"NetworkIn"|"NetworkOut"|"StatusCheckFailed"|"StatusCheckFailed_Instance"|"StatusCheckFailed_System"|"ClientTLSNegotiationErrorCount"|"HealthyHostCount"|"UnhealthyHostCount"|"HTTPCode_LB_4XX_Count"|"HTTPCode_LB_5XX_Count"|"HTTPCode_Instance_2XX_Count"|"HTTPCode_Instance_3XX_Count"|"HTTPCode_Instance_4XX_Count"|"HTTPCode_Instance_5XX_Count"|"InstanceResponseTime"|"RejectedConnectionCount"|"RequestCount"|"DatabaseConnections"|"DiskQueueDepth"|"FreeStorageSpace"|"NetworkReceiveThroughput"|"NetworkTransmitThroughput"|"BurstCapacityTime"|"BurstCapacityPercentage"|string;
export type MetricPeriod = number;
export type MetricStatistic = "Minimum"|"Maximum"|"Sum"|"Average"|"SampleCount"|string;
export type MetricStatisticList = MetricStatistic[];
export type MetricUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string;
export interface MonitoredResourceInfo {
/**
* The Amazon Resource Name (ARN) of the resource being monitored.
*/
arn?: ResourceArn;
/**
* The name of the Lightsail resource being monitored.
*/
name?: ResourceName;
/**
* The Lightsail resource type of the resource being monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
*/
resourceType?: ResourceType;
}
export interface MonthlyTransfer {
/**
* The amount allocated per month (in GB).
*/
gbPerMonthAllocated?: integer;
}
export type NetworkProtocol = "tcp"|"all"|"udp"|"icmp"|string;
export type NonEmptyString = string;
export type NotificationTriggerList = AlarmState[];
export interface OpenInstancePublicPortsRequest {
/**
* An object to describe the ports to open for the specified instance.
*/
portInfo: PortInfo;
/**
* The name of the instance for which to open ports.
*/
instanceName: ResourceName;
}
export interface OpenInstancePublicPortsResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface Operation {
/**
* The ID of the operation.
*/
id?: NonEmptyString;
/**
* The resource name.
*/
resourceName?: ResourceName;
/**
* The resource type.
*/
resourceType?: ResourceType;
/**
* The timestamp when the operation was initialized (e.g., 1479816991.349).
*/
createdAt?: IsoDate;
/**
* The AWS Region and Availability Zone.
*/
location?: ResourceLocation;
/**
* A Boolean value indicating whether the operation is terminal.
*/
isTerminal?: boolean;
/**
* Details about the operation (e.g., Debian-1GB-Ohio-1).
*/
operationDetails?: string;
/**
* The type of operation.
*/
operationType?: OperationType;
/**
* The status of the operation.
*/
status?: OperationStatus;
/**
* The timestamp when the status was changed (e.g., 1479816991.349).
*/
statusChangedAt?: IsoDate;
/**
* The error code.
*/
errorCode?: string;
/**
* The error details.
*/
errorDetails?: string;
}
export type OperationList = Operation[];
export type OperationStatus = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded"|string;
export type OperationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|"CreateDistribution"|"UpdateDistribution"|"DeleteDistribution"|"ResetDistributionCache"|"AttachCertificateToDistribution"|"DetachCertificateFromDistribution"|"UpdateDistributionBundle"|"CreateCertificate"|"DeleteCertificate"|string;
export interface Origin {
/**
* The name of the origin resource.
*/
name?: ResourceName;
/**
* The resource type of the origin resource (e.g., Instance).
*/
resourceType?: ResourceType;
/**
* The AWS Region name of the origin resource.
*/
regionName?: RegionName;
/**
* The protocol that your Amazon Lightsail distribution uses when establishing a connection with your origin to pull content.
*/
protocolPolicy?: OriginProtocolPolicyEnum;
}
export type OriginProtocolPolicyEnum = "http-only"|"https-only"|string;
export interface PasswordData {
/**
* The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field. If you are using a custom key pair, you need to use your own means of decryption. If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
*/
ciphertext?: string;
/**
* The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair). If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.
*/
keyPairName?: ResourceName;
}
export interface PeerVpcRequest {
}
export interface PeerVpcResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface PendingMaintenanceAction {
/**
* The type of pending database maintenance action.
*/
action?: NonEmptyString;
/**
* Additional detail about the pending database maintenance action.
*/
description?: NonEmptyString;
/**
* The effective date of the pending database maintenance action.
*/
currentApplyDate?: IsoDate;
}
export type PendingMaintenanceActionList = PendingMaintenanceAction[];
export interface PendingModifiedRelationalDatabaseValues {
/**
* The password for the master user of the database.
*/
masterUserPassword?: string;
/**
* The database engine version.
*/
engineVersion?: string;
/**
* A Boolean value indicating whether automated backup retention is enabled.
*/
backupRetentionEnabled?: boolean;
}
export type Port = number;
export type PortAccessType = "Public"|"Private"|string;
export interface PortInfo {
/**
* The first port in a range of open ports on an instance. Allowed ports: TCP and UDP - 0 to 65535 ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
*/
fromPort?: Port;
/**
* The last port in a range of open ports on an instance. Allowed ports: TCP and UDP - 0 to 65535 ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
*/
toPort?: Port;
/**
* The IP protocol name. The name can be one of the following: tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead. all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia. udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead. icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
*/
protocol?: NetworkProtocol;
/**
* The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses. Examples: To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32. To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
*/
cidrs?: StringList;
/**
* An alias that defines access for a preconfigured range of IP addresses. The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
*/
cidrListAliases?: StringList;
}
export type PortInfoList = PortInfo[];
export type PortInfoSourceType = "DEFAULT"|"INSTANCE"|"NONE"|"CLOSED"|string;
export type PortList = Port[];
export type PortState = "open"|"closed"|string;
export interface PutAlarmRequest {
/**
* The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
*/
alarmName: ResourceName;
/**
* The name of the metric to associate with the alarm. You can configure up to two alarms per metric. The following metrics are available for each resource type: Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System. Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount. Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput. For more information about these metrics, see Metrics available in Lightsail.
*/
metricName: MetricName;
/**
* The name of the Lightsail resource that will be monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
*/
monitoredResourceName: ResourceName;
/**
* The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
*/
comparisonOperator: ComparisonOperator;
/**
* The value against which the specified statistic is compared.
*/
threshold: double;
/**
* The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated. Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours. You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).
*/
evaluationPeriods: integer;
/**
* The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
*/
datapointsToAlarm?: integer;
/**
* Sets how this alarm will handle missing data points. An alarm can treat missing data in the following ways: breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. ignore - Ignore the missing data. Maintains the current alarm state. missing - Missing data is treated as missing. If treatMissingData is not specified, the default behavior of missing is used.
*/
treatMissingData?: TreatMissingData;
/**
* The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both. A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered. A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater. Use the CreateContactMethod action to configure a contact protocol in an AWS Region.
*/
contactProtocols?: ContactProtocolsList;
/**
* The alarm states that trigger a notification. An alarm has the following possible states: ALARM - The metric is outside of the defined threshold. INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK - The metric is within the defined threshold. When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state. If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification. If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state. The notification trigger defaults to ALARM if you don't specify this parameter.
*/
notificationTriggers?: NotificationTriggerList;
/**
* Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
*/
notificationEnabled?: boolean;
}
export interface PutAlarmResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface PutInstancePublicPortsRequest {
/**
* An array of objects to describe the ports to open for the specified instance.
*/
portInfos: PortInfoList;
/**
* The name of the instance for which to open ports.
*/
instanceName: ResourceName;
}
export interface PutInstancePublicPortsResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface QueryStringObject {
/**
* Indicates whether the distribution forwards and caches based on query strings.
*/
option?: boolean;
/**
* The specific query strings that the distribution forwards to the origin. Your distribution will cache content based on the specified query strings. If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.
*/
queryStringsAllowList?: StringList;
}
export interface RebootInstanceRequest {
/**
* The name of the instance to reboot.
*/
instanceName: ResourceName;
}
export interface RebootInstanceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface RebootRelationalDatabaseRequest {
/**
* The name of your database to reboot.
*/
relationalDatabaseName: ResourceName;
}
export interface RebootRelationalDatabaseResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type RecordState = "Started"|"Succeeded"|"Failed"|string;
export interface Region {
/**
* The continent code (e.g., NA, meaning North America).
*/
continentCode?: string;
/**
* The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).
*/
description?: string;
/**
* The display name (e.g., Ohio).
*/
displayName?: string;
/**
* The region name (e.g., us-east-2).
*/
name?: RegionName;
/**
* The Availability Zones. Follows the format us-east-2a (case-sensitive).
*/
availabilityZones?: AvailabilityZoneList;
/**
* The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).
*/
relationalDatabaseAvailabilityZones?: AvailabilityZoneList;
}
export type RegionList = Region[];
export type RegionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|string;
export interface RelationalDatabase {
/**
* The unique name of the database resource in Lightsail.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the database.
*/
arn?: NonEmptyString;
/**
* The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the database was created. Formatted in Unix time.
*/
createdAt?: IsoDate;
/**
* The Region name and Availability Zone where the database is located.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type for the database (for example, RelationalDatabase).
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The blueprint ID for the database. A blueprint describes the major engine version of a database.
*/
relationalDatabaseBlueprintId?: NonEmptyString;
/**
* The bundle ID for the database. A bundle describes the performance specifications for your database.
*/
relationalDatabaseBundleId?: NonEmptyString;
/**
* The name of the master database created when the Lightsail database resource is created.
*/
masterDatabaseName?: string;
/**
* Describes the hardware of the database.
*/
hardware?: RelationalDatabaseHardware;
/**
* Describes the current state of the database.
*/
state?: NonEmptyString;
/**
* Describes the secondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database.
*/
secondaryAvailabilityZone?: string;
/**
* A Boolean value indicating whether automated backup retention is enabled for the database.
*/
backupRetentionEnabled?: boolean;
/**
* Describes pending database value modifications.
*/
pendingModifiedValues?: PendingModifiedRelationalDatabaseValues;
/**
* The database software (for example, MySQL).
*/
engine?: NonEmptyString;
/**
* The database engine version (for example, 5.7.23).
*/
engineVersion?: NonEmptyString;
/**
* The latest point in time to which the database can be restored. Formatted in Unix time.
*/
latestRestorableTime?: IsoDate;
/**
* The master user name of the database.
*/
masterUsername?: NonEmptyString;
/**
* The status of parameter updates for the database.
*/
parameterApplyStatus?: NonEmptyString;
/**
* The daily time range during which automated backups are created for the database (for example, 16:00-16:30).
*/
preferredBackupWindow?: NonEmptyString;
/**
* The weekly time range during which system maintenance can occur on the database. In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.
*/
preferredMaintenanceWindow?: NonEmptyString;
/**
* A Boolean value indicating whether the database is publicly accessible.
*/
publiclyAccessible?: boolean;
/**
* The master endpoint for the database.
*/
masterEndpoint?: RelationalDatabaseEndpoint;
/**
* Describes the pending maintenance actions for the database.
*/
pendingMaintenanceActions?: PendingMaintenanceActionList;
/**
* The certificate associated with the database.
*/
caCertificateIdentifier?: string;
}
export interface RelationalDatabaseBlueprint {
/**
* The ID for the database blueprint.
*/
blueprintId?: string;
/**
* The database software of the database blueprint (for example, MySQL).
*/
engine?: RelationalDatabaseEngine;
/**
* The database engine version for the database blueprint (for example, 5.7.23).
*/
engineVersion?: string;
/**
* The description of the database engine for the database blueprint.
*/
engineDescription?: string;
/**
* The description of the database engine version for the database blueprint.
*/
engineVersionDescription?: string;
/**
* A Boolean value indicating whether the engine version is the default for the database blueprint.
*/
isEngineDefault?: boolean;
}
export type RelationalDatabaseBlueprintList = RelationalDatabaseBlueprint[];
export interface RelationalDatabaseBundle {
/**
* The ID for the database bundle.
*/
bundleId?: string;
/**
* The name for the database bundle.
*/
name?: string;
/**
* The cost of the database bundle in US currency.
*/
price?: float;
/**
* The amount of RAM in GB (for example, 2.0) for the database bundle.
*/
ramSizeInGb?: float;
/**
* The size of the disk for the database bundle.
*/
diskSizeInGb?: integer;
/**
* The data transfer rate per month in GB for the database bundle.
*/
transferPerMonthInGb?: integer;
/**
* The number of virtual CPUs (vCPUs) for the database bundle.
*/
cpuCount?: integer;
/**
* A Boolean value indicating whether the database bundle is encrypted.
*/
isEncrypted?: boolean;
/**
* A Boolean value indicating whether the database bundle is active.
*/
isActive?: boolean;
}
export type RelationalDatabaseBundleList = RelationalDatabaseBundle[];
export interface RelationalDatabaseEndpoint {
/**
* Specifies the port that the database is listening on.
*/
port?: integer;
/**
* Specifies the DNS address of the database.
*/
address?: NonEmptyString;
}
export type RelationalDatabaseEngine = "mysql"|string;
export interface RelationalDatabaseEvent {
/**
* The database that the database event relates to.
*/
resource?: ResourceName;
/**
* The timestamp when the database event was created.
*/
createdAt?: IsoDate;
/**
* The message of the database event.
*/
message?: string;
/**
* The category that the database event belongs to.
*/
eventCategories?: StringList;
}
export type RelationalDatabaseEventList = RelationalDatabaseEvent[];
export interface RelationalDatabaseHardware {
/**
* The number of vCPUs for the database.
*/
cpuCount?: integer;
/**
* The size of the disk for the database.
*/
diskSizeInGb?: integer;
/**
* The amount of RAM in GB for the database.
*/
ramSizeInGb?: float;
}
export type RelationalDatabaseList = RelationalDatabase[];
export type RelationalDatabaseMetricName = "CPUUtilization"|"DatabaseConnections"|"DiskQueueDepth"|"FreeStorageSpace"|"NetworkReceiveThroughput"|"NetworkTransmitThroughput"|string;
export interface RelationalDatabaseParameter {
/**
* Specifies the valid range of values for the parameter.
*/
allowedValues?: string;
/**
* Indicates when parameter updates are applied. Can be immediate or pending-reboot.
*/
applyMethod?: string;
/**
* Specifies the engine-specific parameter type.
*/
applyType?: string;
/**
* Specifies the valid data type for the parameter.
*/
dataType?: string;
/**
* Provides a description of the parameter.
*/
description?: string;
/**
* A Boolean value indicating whether the parameter can be modified.
*/
isModifiable?: boolean;
/**
* Specifies the name of the parameter.
*/
parameterName?: string;
/**
* Specifies the value of the parameter.
*/
parameterValue?: string;
}
export type RelationalDatabaseParameterList = RelationalDatabaseParameter[];
export type RelationalDatabasePasswordVersion = "CURRENT"|"PREVIOUS"|"PENDING"|string;
export interface RelationalDatabaseSnapshot {
/**
* The name of the database snapshot.
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the database snapshot.
*/
arn?: NonEmptyString;
/**
* The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the database snapshot was created.
*/
createdAt?: IsoDate;
/**
* The Region name and Availability Zone where the database snapshot is located.
*/
location?: ResourceLocation;
/**
* The Lightsail resource type.
*/
resourceType?: ResourceType;
/**
* The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
*/
tags?: TagList;
/**
* The software of the database snapshot (for example, MySQL)
*/
engine?: NonEmptyString;
/**
* The database engine version for the database snapshot (for example, 5.7.23).
*/
engineVersion?: NonEmptyString;
/**
* The size of the disk in GB (for example, 32) for the database snapshot.
*/
sizeInGb?: integer;
/**
* The state of the database snapshot.
*/
state?: NonEmptyString;
/**
* The name of the source database from which the database snapshot was created.
*/
fromRelationalDatabaseName?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
*/
fromRelationalDatabaseArn?: NonEmptyString;
/**
* The bundle ID of the database from which the database snapshot was created.
*/
fromRelationalDatabaseBundleId?: string;
/**
* The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
*/
fromRelationalDatabaseBlueprintId?: string;
}
export type RelationalDatabaseSnapshotList = RelationalDatabaseSnapshot[];
export interface ReleaseStaticIpRequest {
/**
* The name of the static IP to delete.
*/
staticIpName: ResourceName;
}
export interface ReleaseStaticIpResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type RenewalStatus = "PendingAutoRenewal"|"PendingValidation"|"Success"|"Failed"|string;
export type RenewalStatusReason = string;
export interface RenewalSummary {
/**
* An array of objects that describe the domain validation records of the certificate.
*/
domainValidationRecords?: DomainValidationRecordList;
/**
* The renewal status of the certificate. The following renewal status are possible: PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names of the certificate. No further action is required. PendingValidation - Lightsail couldn't automatically validate one or more domain names of the certificate. You must take action to validate these domain names or the certificate won't be renewed. Check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use. Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required. Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.
*/
renewalStatus?: RenewalStatus;
/**
* The reason for the renewal status of the certificate.
*/
renewalStatusReason?: RenewalStatusReason;
/**
* The timestamp when the certificate was last updated.
*/
updatedAt?: IsoDate;
}
export type RequestFailureReason = string;
export interface ResetDistributionCacheRequest {
/**
* The name of the distribution for which to reset cache. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName?: ResourceName;
}
export interface ResetDistributionCacheResult {
/**
* The status of the reset cache request.
*/
status?: string;
/**
* The timestamp of the reset cache request (e.g., 1479734909.17) in Unix time format.
*/
createTime?: IsoDate;
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export type ResourceArn = string;
export interface ResourceLocation {
/**
* The Availability Zone. Follows the format us-east-2a (case-sensitive).
*/
availabilityZone?: string;
/**
* The AWS Region name.
*/
regionName?: RegionName;
}
export type ResourceName = string;
export type ResourceNameList = ResourceName[];
export interface ResourceRecord {
/**
* The name of the record.
*/
name?: string;
/**
* The DNS record type.
*/
type?: string;
/**
* The value for the DNS record.
*/
value?: string;
}
export type ResourceType = "Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|string;
export type RevocationReason = string;
export interface SendContactMethodVerificationRequest {
/**
* The protocol to verify, such as Email or SMS (text messaging).
*/
protocol: ContactMethodVerificationProtocol;
}
export interface SendContactMethodVerificationResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type SensitiveString = string;
export type SerialNumber = string;
export interface StartInstanceRequest {
/**
* The name of the instance (a virtual private server) to start.
*/
instanceName: ResourceName;
}
export interface StartInstanceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface StartRelationalDatabaseRequest {
/**
* The name of your database to start.
*/
relationalDatabaseName: ResourceName;
}
export interface StartRelationalDatabaseResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface StaticIp {
/**
* The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
*/
name?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
*/
arn?: NonEmptyString;
/**
* The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
*/
supportCode?: string;
/**
* The timestamp when the static IP was created (e.g., 1479735304.222).
*/
createdAt?: IsoDate;
/**
* The region and Availability Zone where the static IP was created.
*/
location?: ResourceLocation;
/**
* The resource type (usually StaticIp).
*/
resourceType?: ResourceType;
/**
* The static IP address.
*/
ipAddress?: IpAddress;
/**
* The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
*/
attachedTo?: ResourceName;
/**
* A Boolean value indicating whether the static IP is attached.
*/
isAttached?: boolean;
}
export type StaticIpList = StaticIp[];
export interface StopInstanceRequest {
/**
* The name of the instance (a virtual private server) to stop.
*/
instanceName: ResourceName;
/**
* When set to True, forces a Lightsail instance that is stuck in a stopping state to stop. Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.
*/
force?: boolean;
}
export interface StopInstanceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface StopRelationalDatabaseRequest {
/**
* The name of your database to stop.
*/
relationalDatabaseName: ResourceName;
/**
* The name of your new database snapshot to be created before stopping your database.
*/
relationalDatabaseSnapshotName?: ResourceName;
}
export interface StopRelationalDatabaseResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type StringList = string[];
export type StringMax256 = string;
export type SubjectAlternativeNameList = DomainName[];
export interface Tag {
/**
* The key of the tag. Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
*/
key?: TagKey;
/**
* The value of the tag. Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @
*/
value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The name of the resource to which you are adding tags.
*/
resourceName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the resource to which you want to add a tag.
*/
resourceArn?: ResourceArn;
/**
* The tag key and optional value.
*/
tags: TagList;
}
export interface TagResourceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type TagValue = string;
export interface TestAlarmRequest {
/**
* The name of the alarm to test.
*/
alarmName: ResourceName;
/**
* The alarm state to test. An alarm has the following possible states that can be tested: ALARM - The metric is outside of the defined threshold. INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK - The metric is within the defined threshold.
*/
state: AlarmState;
}
export interface TestAlarmResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type TimeOfDay = string;
export type TreatMissingData = "breaching"|"notBreaching"|"ignore"|"missing"|string;
export interface UnpeerVpcRequest {
}
export interface UnpeerVpcResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface UntagResourceRequest {
/**
* The name of the resource from which you are removing a tag.
*/
resourceName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.
*/
resourceArn?: ResourceArn;
/**
* The tag keys to delete from the specified resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface UpdateDistributionBundleRequest {
/**
* The name of the distribution for which to update the bundle. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName?: ResourceName;
/**
* The bundle ID of the new bundle to apply to your distribution. Use the GetDistributionBundles action to get a list of distribution bundle IDs that you can specify.
*/
bundleId?: string;
}
export interface UpdateDistributionBundleResult {
operation?: Operation;
}
export interface UpdateDistributionRequest {
/**
* The name of the distribution to update. Use the GetDistributions action to get a list of distribution names that you can specify.
*/
distributionName: ResourceName;
/**
* An object that describes the origin resource for the distribution, such as a Lightsail instance or load balancer. The distribution pulls, caches, and serves content from the origin.
*/
origin?: InputOrigin;
/**
* An object that describes the default cache behavior for the distribution.
*/
defaultCacheBehavior?: CacheBehavior;
/**
* An object that describes the cache behavior settings for the distribution. The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.
*/
cacheBehaviorSettings?: CacheSettings;
/**
* An array of objects that describe the per-path cache behavior for the distribution.
*/
cacheBehaviors?: CacheBehaviorList;
/**
* Indicates whether to enable the distribution.
*/
isEnabled?: boolean;
}
export interface UpdateDistributionResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operation?: Operation;
}
export interface UpdateDomainEntryRequest {
/**
* The name of the domain recordset to update.
*/
domainName: DomainName;
/**
* An array of key-value pairs containing information about the domain entry.
*/
domainEntry: DomainEntry;
}
export interface UpdateDomainEntryResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface UpdateLoadBalancerAttributeRequest {
/**
* The name of the load balancer that you want to modify (e.g., my-load-balancer.
*/
loadBalancerName: ResourceName;
/**
* The name of the attribute you want to update. Valid values are below.
*/
attributeName: LoadBalancerAttributeName;
/**
* The value that you want to specify for the attribute name.
*/
attributeValue: StringMax256;
}
export interface UpdateLoadBalancerAttributeResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface UpdateRelationalDatabaseParametersRequest {
/**
* The name of your database for which to update parameters.
*/
relationalDatabaseName: ResourceName;
/**
* The database parameters to update.
*/
parameters: RelationalDatabaseParameterList;
}
export interface UpdateRelationalDatabaseParametersResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export interface UpdateRelationalDatabaseRequest {
/**
* The name of your database to update.
*/
relationalDatabaseName: ResourceName;
/**
* The password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@". Constraints: Must contain 8 to 41 characters.
*/
masterUserPassword?: SensitiveString;
/**
* When true, the master user password is changed to a new strong password generated by Lightsail. Use the get relational database master user password operation to get the new password.
*/
rotateMasterUserPassword?: boolean;
/**
* The daily time range during which automated backups are created for your database if automated backups are enabled. Constraints: Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 Specified in Coordinated Universal Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
*/
preferredBackupWindow?: string;
/**
* The weekly time range during which system maintenance can occur on your database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: Must be in the ddd:hh24:mi-ddd:hh24:mi format. Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Must be at least 30 minutes. Specified in Coordinated Universal Time (UTC). Example: Tue:17:00-Tue:17:30
*/
preferredMaintenanceWindow?: string;
/**
* When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
*/
enableBackupRetention?: boolean;
/**
* When true, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation. Updates are applied during the next maintenance window because this can result in an outage.
*/
disableBackupRetention?: boolean;
/**
* Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
*/
publiclyAccessible?: boolean;
/**
* When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage. Default: false
*/
applyImmediately?: boolean;
/**
* Indicates the certificate that needs to be associated with the database.
*/
caCertificateIdentifier?: string;
}
export interface UpdateRelationalDatabaseResult {
/**
* An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
*/
operations?: OperationList;
}
export type double = number;
export type float = number;
export type integer = number;
export type long = number;
export type timestamp = Date;
/**
* 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 = "2016-11-28"|"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 Lightsail client.
*/
export import Types = Lightsail;
}
export = Lightsail;