autoscaling.d.ts
156 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
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';
interface Blob {}
declare class AutoScaling extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AutoScaling.Types.ClientConfiguration)
config: Config & AutoScaling.Types.ClientConfiguration;
/**
* Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachInstances(params: AutoScaling.Types.AttachInstancesQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups. For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachInstances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancerTargetGroups(params: AutoScaling.Types.AttachLoadBalancerTargetGroupsType, callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.AttachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Attaches one or more Classic Load Balancers to the specified Auto Scaling group. To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups. To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancers(params: AutoScaling.Types.AttachLoadBalancersType, callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancersResultType) => void): Request<AutoScaling.Types.AttachLoadBalancersResultType, AWSError>;
/**
* Attaches one or more Classic Load Balancers to the specified Auto Scaling group. To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups. To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
attachLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.AttachLoadBalancersResultType) => void): Request<AutoScaling.Types.AttachLoadBalancersResultType, AWSError>;
/**
* Deletes one or more scheduled actions for the specified Auto Scaling group.
*/
batchDeleteScheduledAction(params: AutoScaling.Types.BatchDeleteScheduledActionType, callback?: (err: AWSError, data: AutoScaling.Types.BatchDeleteScheduledActionAnswer) => void): Request<AutoScaling.Types.BatchDeleteScheduledActionAnswer, AWSError>;
/**
* Deletes one or more scheduled actions for the specified Auto Scaling group.
*/
batchDeleteScheduledAction(callback?: (err: AWSError, data: AutoScaling.Types.BatchDeleteScheduledActionAnswer) => void): Request<AutoScaling.Types.BatchDeleteScheduledActionAnswer, AWSError>;
/**
* Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
*/
batchPutScheduledUpdateGroupAction(params: AutoScaling.Types.BatchPutScheduledUpdateGroupActionType, callback?: (err: AWSError, data: AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer) => void): Request<AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer, AWSError>;
/**
* Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
*/
batchPutScheduledUpdateGroupAction(callback?: (err: AWSError, data: AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer) => void): Request<AutoScaling.Types.BatchPutScheduledUpdateGroupActionAnswer, AWSError>;
/**
* Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.
*/
completeLifecycleAction(params: AutoScaling.Types.CompleteLifecycleActionType, callback?: (err: AWSError, data: AutoScaling.Types.CompleteLifecycleActionAnswer) => void): Request<AutoScaling.Types.CompleteLifecycleActionAnswer, AWSError>;
/**
* Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.
*/
completeLifecycleAction(callback?: (err: AWSError, data: AutoScaling.Types.CompleteLifecycleActionAnswer) => void): Request<AutoScaling.Types.CompleteLifecycleActionAnswer, AWSError>;
/**
* Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.
*/
createAutoScalingGroup(params: AutoScaling.Types.CreateAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an Auto Scaling group with the specified name and attributes. If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.
*/
createAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.
*/
createLaunchConfiguration(params: AutoScaling.Types.CreateLaunchConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide. For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.
*/
createLaunchConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
createOrUpdateTags(params: AutoScaling.Types.CreateOrUpdateTagsType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
createOrUpdateTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
*/
deleteAutoScalingGroup(params: AutoScaling.Types.DeleteAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances. To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
*/
deleteAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
*/
deleteLaunchConfiguration(params: AutoScaling.Types.LaunchConfigurationNameType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
*/
deleteLaunchConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
*/
deleteLifecycleHook(params: AutoScaling.Types.DeleteLifecycleHookType, callback?: (err: AWSError, data: AutoScaling.Types.DeleteLifecycleHookAnswer) => void): Request<AutoScaling.Types.DeleteLifecycleHookAnswer, AWSError>;
/**
* Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
*/
deleteLifecycleHook(callback?: (err: AWSError, data: AutoScaling.Types.DeleteLifecycleHookAnswer) => void): Request<AutoScaling.Types.DeleteLifecycleHookAnswer, AWSError>;
/**
* Deletes the specified notification.
*/
deleteNotificationConfiguration(params: AutoScaling.Types.DeleteNotificationConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified notification.
*/
deleteNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scaling policy. Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. For more information, see Deleting a Scaling Policy in the Amazon EC2 Auto Scaling User Guide.
*/
deletePolicy(params: AutoScaling.Types.DeletePolicyType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scaling policy. Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. For more information, see Deleting a Scaling Policy in the Amazon EC2 Auto Scaling User Guide.
*/
deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scheduled action.
*/
deleteScheduledAction(params: AutoScaling.Types.DeleteScheduledActionType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified scheduled action.
*/
deleteScheduledAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified tags.
*/
deleteTags(params: AutoScaling.Types.DeleteTagsType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified tags.
*/
deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account. For information about requesting an increase, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.
*/
describeAccountLimits(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAccountLimitsAnswer) => void): Request<AutoScaling.Types.DescribeAccountLimitsAnswer, AWSError>;
/**
* Describes the policy adjustment types for use with PutScalingPolicy.
*/
describeAdjustmentTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAdjustmentTypesAnswer) => void): Request<AutoScaling.Types.DescribeAdjustmentTypesAnswer, AWSError>;
/**
* Describes one or more Auto Scaling groups.
*/
describeAutoScalingGroups(params: AutoScaling.Types.AutoScalingGroupNamesType, callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingGroupsType) => void): Request<AutoScaling.Types.AutoScalingGroupsType, AWSError>;
/**
* Describes one or more Auto Scaling groups.
*/
describeAutoScalingGroups(callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingGroupsType) => void): Request<AutoScaling.Types.AutoScalingGroupsType, AWSError>;
/**
* Describes one or more Auto Scaling instances.
*/
describeAutoScalingInstances(params: AutoScaling.Types.DescribeAutoScalingInstancesType, callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingInstancesType) => void): Request<AutoScaling.Types.AutoScalingInstancesType, AWSError>;
/**
* Describes one or more Auto Scaling instances.
*/
describeAutoScalingInstances(callback?: (err: AWSError, data: AutoScaling.Types.AutoScalingInstancesType) => void): Request<AutoScaling.Types.AutoScalingInstancesType, AWSError>;
/**
* Describes the notification types that are supported by Amazon EC2 Auto Scaling.
*/
describeAutoScalingNotificationTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeAutoScalingNotificationTypesAnswer) => void): Request<AutoScaling.Types.DescribeAutoScalingNotificationTypesAnswer, AWSError>;
/**
* Describes one or more launch configurations.
*/
describeLaunchConfigurations(params: AutoScaling.Types.LaunchConfigurationNamesType, callback?: (err: AWSError, data: AutoScaling.Types.LaunchConfigurationsType) => void): Request<AutoScaling.Types.LaunchConfigurationsType, AWSError>;
/**
* Describes one or more launch configurations.
*/
describeLaunchConfigurations(callback?: (err: AWSError, data: AutoScaling.Types.LaunchConfigurationsType) => void): Request<AutoScaling.Types.LaunchConfigurationsType, AWSError>;
/**
* Describes the available types of lifecycle hooks. The following hook types are supported: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
*/
describeLifecycleHookTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHookTypesAnswer) => void): Request<AutoScaling.Types.DescribeLifecycleHookTypesAnswer, AWSError>;
/**
* Describes the lifecycle hooks for the specified Auto Scaling group.
*/
describeLifecycleHooks(params: AutoScaling.Types.DescribeLifecycleHooksType, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHooksAnswer) => void): Request<AutoScaling.Types.DescribeLifecycleHooksAnswer, AWSError>;
/**
* Describes the lifecycle hooks for the specified Auto Scaling group.
*/
describeLifecycleHooks(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLifecycleHooksAnswer) => void): Request<AutoScaling.Types.DescribeLifecycleHooksAnswer, AWSError>;
/**
* Describes the target groups for the specified Auto Scaling group.
*/
describeLoadBalancerTargetGroups(params: AutoScaling.Types.DescribeLoadBalancerTargetGroupsRequest, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse, AWSError>;
/**
* Describes the target groups for the specified Auto Scaling group.
*/
describeLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancerTargetGroupsResponse, AWSError>;
/**
* Describes the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.
*/
describeLoadBalancers(params: AutoScaling.Types.DescribeLoadBalancersRequest, callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancersResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancersResponse, AWSError>;
/**
* Describes the load balancers for the specified Auto Scaling group. This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.
*/
describeLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.DescribeLoadBalancersResponse) => void): Request<AutoScaling.Types.DescribeLoadBalancersResponse, AWSError>;
/**
* Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling. The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.
*/
describeMetricCollectionTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeMetricCollectionTypesAnswer) => void): Request<AutoScaling.Types.DescribeMetricCollectionTypesAnswer, AWSError>;
/**
* Describes the notification actions associated with the specified Auto Scaling group.
*/
describeNotificationConfigurations(params: AutoScaling.Types.DescribeNotificationConfigurationsType, callback?: (err: AWSError, data: AutoScaling.Types.DescribeNotificationConfigurationsAnswer) => void): Request<AutoScaling.Types.DescribeNotificationConfigurationsAnswer, AWSError>;
/**
* Describes the notification actions associated with the specified Auto Scaling group.
*/
describeNotificationConfigurations(callback?: (err: AWSError, data: AutoScaling.Types.DescribeNotificationConfigurationsAnswer) => void): Request<AutoScaling.Types.DescribeNotificationConfigurationsAnswer, AWSError>;
/**
* Describes the policies for the specified Auto Scaling group.
*/
describePolicies(params: AutoScaling.Types.DescribePoliciesType, callback?: (err: AWSError, data: AutoScaling.Types.PoliciesType) => void): Request<AutoScaling.Types.PoliciesType, AWSError>;
/**
* Describes the policies for the specified Auto Scaling group.
*/
describePolicies(callback?: (err: AWSError, data: AutoScaling.Types.PoliciesType) => void): Request<AutoScaling.Types.PoliciesType, AWSError>;
/**
* Describes one or more scaling activities for the specified Auto Scaling group.
*/
describeScalingActivities(params: AutoScaling.Types.DescribeScalingActivitiesType, callback?: (err: AWSError, data: AutoScaling.Types.ActivitiesType) => void): Request<AutoScaling.Types.ActivitiesType, AWSError>;
/**
* Describes one or more scaling activities for the specified Auto Scaling group.
*/
describeScalingActivities(callback?: (err: AWSError, data: AutoScaling.Types.ActivitiesType) => void): Request<AutoScaling.Types.ActivitiesType, AWSError>;
/**
* Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
*/
describeScalingProcessTypes(callback?: (err: AWSError, data: AutoScaling.Types.ProcessesType) => void): Request<AutoScaling.Types.ProcessesType, AWSError>;
/**
* Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, use DescribeScalingActivities.
*/
describeScheduledActions(params: AutoScaling.Types.DescribeScheduledActionsType, callback?: (err: AWSError, data: AutoScaling.Types.ScheduledActionsType) => void): Request<AutoScaling.Types.ScheduledActionsType, AWSError>;
/**
* Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, use DescribeScalingActivities.
*/
describeScheduledActions(callback?: (err: AWSError, data: AutoScaling.Types.ScheduledActionsType) => void): Request<AutoScaling.Types.ScheduledActionsType, AWSError>;
/**
* Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
*/
describeTags(params: AutoScaling.Types.DescribeTagsType, callback?: (err: AWSError, data: AutoScaling.Types.TagsType) => void): Request<AutoScaling.Types.TagsType, AWSError>;
/**
* Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
*/
describeTags(callback?: (err: AWSError, data: AutoScaling.Types.TagsType) => void): Request<AutoScaling.Types.TagsType, AWSError>;
/**
* Describes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.
*/
describeTerminationPolicyTypes(callback?: (err: AWSError, data: AutoScaling.Types.DescribeTerminationPolicyTypesAnswer) => void): Request<AutoScaling.Types.DescribeTerminationPolicyTypesAnswer, AWSError>;
/**
* Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
detachInstances(params: AutoScaling.Types.DetachInstancesQuery, callback?: (err: AWSError, data: AutoScaling.Types.DetachInstancesAnswer) => void): Request<AutoScaling.Types.DetachInstancesAnswer, AWSError>;
/**
* Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling group. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached. If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups. For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
detachInstances(callback?: (err: AWSError, data: AutoScaling.Types.DetachInstancesAnswer) => void): Request<AutoScaling.Types.DetachInstancesAnswer, AWSError>;
/**
* Detaches one or more target groups from the specified Auto Scaling group.
*/
detachLoadBalancerTargetGroups(params: AutoScaling.Types.DetachLoadBalancerTargetGroupsType, callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Detaches one or more target groups from the specified Auto Scaling group.
*/
detachLoadBalancerTargetGroups(callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType) => void): Request<AutoScaling.Types.DetachLoadBalancerTargetGroupsResultType, AWSError>;
/**
* Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.
*/
detachLoadBalancers(params: AutoScaling.Types.DetachLoadBalancersType, callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancersResultType) => void): Request<AutoScaling.Types.DetachLoadBalancersResultType, AWSError>;
/**
* Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead. When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.
*/
detachLoadBalancers(callback?: (err: AWSError, data: AutoScaling.Types.DetachLoadBalancersResultType) => void): Request<AutoScaling.Types.DetachLoadBalancersResultType, AWSError>;
/**
* Disables group metrics for the specified Auto Scaling group.
*/
disableMetricsCollection(params: AutoScaling.Types.DisableMetricsCollectionQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disables group metrics for the specified Auto Scaling group.
*/
disableMetricsCollection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
enableMetricsCollection(params: AutoScaling.Types.EnableMetricsCollectionQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
enableMetricsCollection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Moves the specified instances into the standby state. If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group. If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
enterStandby(params: AutoScaling.Types.EnterStandbyQuery, callback?: (err: AWSError, data: AutoScaling.Types.EnterStandbyAnswer) => void): Request<AutoScaling.Types.EnterStandbyAnswer, AWSError>;
/**
* Moves the specified instances into the standby state. If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group. If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
enterStandby(callback?: (err: AWSError, data: AutoScaling.Types.EnterStandbyAnswer) => void): Request<AutoScaling.Types.EnterStandbyAnswer, AWSError>;
/**
* Executes the specified policy.
*/
executePolicy(params: AutoScaling.Types.ExecutePolicyType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Executes the specified policy.
*/
executePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Moves the specified instances out of the standby state. After you put the instances back in service, the desired capacity is incremented. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
exitStandby(params: AutoScaling.Types.ExitStandbyQuery, callback?: (err: AWSError, data: AutoScaling.Types.ExitStandbyAnswer) => void): Request<AutoScaling.Types.ExitStandbyAnswer, AWSError>;
/**
* Moves the specified instances out of the standby state. After you put the instances back in service, the desired capacity is incremented. For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
exitStandby(callback?: (err: AWSError, data: AutoScaling.Types.ExitStandbyAnswer) => void): Request<AutoScaling.Types.ExitStandbyAnswer, AWSError>;
/**
* Creates or updates a lifecycle hook for the specified Auto Scaling group. A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated). This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using RecordLifecycleActionHeartbeat. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.
*/
putLifecycleHook(params: AutoScaling.Types.PutLifecycleHookType, callback?: (err: AWSError, data: AutoScaling.Types.PutLifecycleHookAnswer) => void): Request<AutoScaling.Types.PutLifecycleHookAnswer, AWSError>;
/**
* Creates or updates a lifecycle hook for the specified Auto Scaling group. A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated). This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using RecordLifecycleActionHeartbeat. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction. For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide. If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.
*/
putLifecycleHook(callback?: (err: AWSError, data: AutoScaling.Types.PutLifecycleHookAnswer) => void): Request<AutoScaling.Types.PutLifecycleHookAnswer, AWSError>;
/**
* Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.
*/
putNotificationConfiguration(params: AutoScaling.Types.PutNotificationConfigurationType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address. This configuration overwrites any existing configuration. For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.
*/
putNotificationConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates a scaling policy for an Auto Scaling group. For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
putScalingPolicy(params: AutoScaling.Types.PutScalingPolicyType, callback?: (err: AWSError, data: AutoScaling.Types.PolicyARNType) => void): Request<AutoScaling.Types.PolicyARNType, AWSError>;
/**
* Creates or updates a scaling policy for an Auto Scaling group. For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
putScalingPolicy(callback?: (err: AWSError, data: AutoScaling.Types.PolicyARNType) => void): Request<AutoScaling.Types.PolicyARNType, AWSError>;
/**
* Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
putScheduledUpdateGroupAction(params: AutoScaling.Types.PutScheduledUpdateGroupActionType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.
*/
putScheduledUpdateGroupAction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.
*/
recordLifecycleActionHeartbeat(params: AutoScaling.Types.RecordLifecycleActionHeartbeatType, callback?: (err: AWSError, data: AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer) => void): Request<AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer, AWSError>;
/**
* Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook. This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state. If you finish before the timeout period ends, complete the lifecycle action. For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.
*/
recordLifecycleActionHeartbeat(callback?: (err: AWSError, data: AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer) => void): Request<AutoScaling.Types.RecordLifecycleActionHeartbeatAnswer, AWSError>;
/**
* Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
resumeProcesses(params: AutoScaling.Types.ScalingProcessQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
resumeProcesses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the size of the specified Auto Scaling group. For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.
*/
setDesiredCapacity(params: AutoScaling.Types.SetDesiredCapacityType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the size of the specified Auto Scaling group. For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.
*/
setDesiredCapacity(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the health status of the specified instance. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceHealth(params: AutoScaling.Types.SetInstanceHealthQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the health status of the specified instance. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceHealth(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the instance protection settings of the specified instances. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceProtection(params: AutoScaling.Types.SetInstanceProtectionQuery, callback?: (err: AWSError, data: AutoScaling.Types.SetInstanceProtectionAnswer) => void): Request<AutoScaling.Types.SetInstanceProtectionAnswer, AWSError>;
/**
* Updates the instance protection settings of the specified instances. For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
setInstanceProtection(callback?: (err: AWSError, data: AutoScaling.Types.SetInstanceProtectionAnswer) => void): Request<AutoScaling.Types.SetInstanceProtectionAnswer, AWSError>;
/**
* Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. To resume processes that have been suspended, use ResumeProcesses. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
suspendProcesses(params: AutoScaling.Types.ScalingProcessQuery, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. To resume processes that have been suspended, use ResumeProcesses. For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
*/
suspendProcesses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing Activities in the Amazon EC2 Auto Scaling User Guide.
*/
terminateInstanceInAutoScalingGroup(params: AutoScaling.Types.TerminateInstanceInAutoScalingGroupType, callback?: (err: AWSError, data: AutoScaling.Types.ActivityType) => void): Request<AutoScaling.Types.ActivityType, AWSError>;
/**
* Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it. If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing Activities in the Amazon EC2 Auto Scaling User Guide.
*/
terminateInstanceInAutoScalingGroup(callback?: (err: AWSError, data: AutoScaling.Types.ActivityType) => void): Request<AutoScaling.Types.ActivityType, AWSError>;
/**
* Updates the configuration for the specified Auto Scaling group. To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application. Note the following about changing DesiredCapacity, MaxSize, or MinSize: If a scale-in event occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value. To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.
*/
updateAutoScalingGroup(params: AutoScaling.Types.UpdateAutoScalingGroupType, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the configuration for the specified Auto Scaling group. To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application. Note the following about changing DesiredCapacity, MaxSize, or MinSize: If a scale-in event occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value. If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value. To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.
*/
updateAutoScalingGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace AutoScaling {
export type Activities = Activity[];
export interface ActivitiesType {
/**
* The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
*/
Activities: Activities;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface Activity {
/**
* The ID of the activity.
*/
ActivityId: XmlString;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* A friendly, more verbose description of the activity.
*/
Description?: XmlString;
/**
* The reason the activity began.
*/
Cause: XmlStringMaxLen1023;
/**
* The start time of the activity.
*/
StartTime: TimestampType;
/**
* The end time of the activity.
*/
EndTime?: TimestampType;
/**
* The current status of the activity.
*/
StatusCode: ScalingActivityStatusCode;
/**
* A friendly, more verbose description of the activity status.
*/
StatusMessage?: XmlStringMaxLen255;
/**
* A value between 0 and 100 that indicates the progress of the activity.
*/
Progress?: Progress;
/**
* The details about the activity.
*/
Details?: XmlString;
}
export type ActivityIds = XmlString[];
export interface ActivityType {
/**
* A scaling activity.
*/
Activity?: Activity;
}
export interface AdjustmentType {
/**
* The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
*/
AdjustmentType?: XmlStringMaxLen255;
}
export type AdjustmentTypes = AdjustmentType[];
export interface Alarm {
/**
* The name of the alarm.
*/
AlarmName?: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the alarm.
*/
AlarmARN?: ResourceName;
}
export type Alarms = Alarm[];
export type AsciiStringMaxLen255 = string;
export type AssociatePublicIpAddress = boolean;
export interface AttachInstancesQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
}
export interface AttachLoadBalancerTargetGroupsResultType {
}
export interface AttachLoadBalancerTargetGroupsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
*/
TargetGroupARNs: TargetGroupARNs;
}
export interface AttachLoadBalancersResultType {
}
export interface AttachLoadBalancersType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of the load balancers. You can specify up to 10 load balancers.
*/
LoadBalancerNames: LoadBalancerNames;
}
export interface AutoScalingGroup {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the Auto Scaling group.
*/
AutoScalingGroupARN?: ResourceName;
/**
* The name of the associated launch configuration.
*/
LaunchConfigurationName?: XmlStringMaxLen255;
/**
* The launch template for the group.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* The mixed instances policy for the group.
*/
MixedInstancesPolicy?: MixedInstancesPolicy;
/**
* The minimum size of the group.
*/
MinSize: AutoScalingGroupMinSize;
/**
* The maximum size of the group.
*/
MaxSize: AutoScalingGroupMaxSize;
/**
* The desired size of the group.
*/
DesiredCapacity: AutoScalingGroupDesiredCapacity;
/**
* The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
*/
DefaultCooldown: Cooldown;
/**
* One or more Availability Zones for the group.
*/
AvailabilityZones: AvailabilityZones;
/**
* One or more load balancers associated with the group.
*/
LoadBalancerNames?: LoadBalancerNames;
/**
* The Amazon Resource Names (ARN) of the target groups for your load balancer.
*/
TargetGroupARNs?: TargetGroupARNs;
/**
* The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
*/
HealthCheckType: XmlStringMaxLen32;
/**
* The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
*/
HealthCheckGracePeriod?: HealthCheckGracePeriod;
/**
* The EC2 instances associated with the group.
*/
Instances?: Instances;
/**
* The date and time the group was created.
*/
CreatedTime: TimestampType;
/**
* The suspended processes associated with the group.
*/
SuspendedProcesses?: SuspendedProcesses;
/**
* The name of the placement group into which to launch your instances, if any.
*/
PlacementGroup?: XmlStringMaxLen255;
/**
* One or more subnet IDs, if applicable, separated by commas.
*/
VPCZoneIdentifier?: XmlStringMaxLen2047;
/**
* The metrics enabled for the group.
*/
EnabledMetrics?: EnabledMetrics;
/**
* The current state of the group when DeleteAutoScalingGroup is in progress.
*/
Status?: XmlStringMaxLen255;
/**
* The tags for the group.
*/
Tags?: TagDescriptionList;
/**
* The termination policies for the group.
*/
TerminationPolicies?: TerminationPolicies;
/**
* Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
NewInstancesProtectedFromScaleIn?: InstanceProtected;
/**
* The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
*/
ServiceLinkedRoleARN?: ResourceName;
/**
* The maximum amount of time, in seconds, that an instance can be in service. Valid Range: Minimum value of 604800.
*/
MaxInstanceLifetime?: MaxInstanceLifetime;
}
export type AutoScalingGroupDesiredCapacity = number;
export type AutoScalingGroupMaxSize = number;
export type AutoScalingGroupMinSize = number;
export type AutoScalingGroupNames = ResourceName[];
export interface AutoScalingGroupNamesType {
/**
* The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter. If you omit this parameter, all Auto Scaling groups are described.
*/
AutoScalingGroupNames?: AutoScalingGroupNames;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export type AutoScalingGroups = AutoScalingGroup[];
export interface AutoScalingGroupsType {
/**
* The groups.
*/
AutoScalingGroups: AutoScalingGroups;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface AutoScalingInstanceDetails {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* The instance type of the EC2 instance.
*/
InstanceType?: XmlStringMaxLen255;
/**
* The name of the Auto Scaling group for the instance.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* The Availability Zone for the instance.
*/
AvailabilityZone: XmlStringMaxLen255;
/**
* The lifecycle state for the instance.
*/
LifecycleState: XmlStringMaxLen32;
/**
* The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
*/
HealthStatus: XmlStringMaxLen32;
/**
* The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
*/
LaunchConfigurationName?: XmlStringMaxLen255;
/**
* The launch template for the instance.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
ProtectedFromScaleIn: InstanceProtected;
/**
* The number of capacity units contributed by the instance based on its instance type. Valid Range: Minimum value of 1. Maximum value of 999.
*/
WeightedCapacity?: XmlStringMaxLen32;
}
export type AutoScalingInstances = AutoScalingInstanceDetails[];
export interface AutoScalingInstancesType {
/**
* The instances.
*/
AutoScalingInstances?: AutoScalingInstances;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export type AutoScalingNotificationTypes = XmlStringMaxLen255[];
export type AvailabilityZones = XmlStringMaxLen255[];
export interface BatchDeleteScheduledActionAnswer {
/**
* The names of the scheduled actions that could not be deleted, including an error message.
*/
FailedScheduledActions?: FailedScheduledUpdateGroupActionRequests;
}
export interface BatchDeleteScheduledActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of the scheduled actions to delete. The maximum number allowed is 50.
*/
ScheduledActionNames: ScheduledActionNames;
}
export interface BatchPutScheduledUpdateGroupActionAnswer {
/**
* The names of the scheduled actions that could not be created or updated, including an error message.
*/
FailedScheduledUpdateGroupActions?: FailedScheduledUpdateGroupActionRequests;
}
export interface BatchPutScheduledUpdateGroupActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more scheduled actions. The maximum number allowed is 50.
*/
ScheduledUpdateGroupActions: ScheduledUpdateGroupActionRequests;
}
export type BlockDeviceEbsDeleteOnTermination = boolean;
export type BlockDeviceEbsEncrypted = boolean;
export type BlockDeviceEbsIops = number;
export type BlockDeviceEbsVolumeSize = number;
export type BlockDeviceEbsVolumeType = string;
export interface BlockDeviceMapping {
/**
* The name of the virtual device (for example, ephemeral0).
*/
VirtualName?: XmlStringMaxLen255;
/**
* The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.
*/
DeviceName: XmlStringMaxLen255;
/**
* The information about the Amazon EBS volume.
*/
Ebs?: Ebs;
/**
* Suppresses a device mapping. If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
*/
NoDevice?: NoDevice;
}
export type BlockDeviceMappings = BlockDeviceMapping[];
export type ClassicLinkVPCSecurityGroups = XmlStringMaxLen255[];
export interface CompleteLifecycleActionAnswer {
}
export interface CompleteLifecycleActionType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
*/
LifecycleActionToken?: LifecycleActionToken;
/**
* The action for the group to take. This parameter can be either CONTINUE or ABANDON.
*/
LifecycleActionResult: LifecycleActionResult;
/**
* The ID of the instance.
*/
InstanceId?: XmlStringMaxLen19;
}
export type Cooldown = number;
export interface CreateAutoScalingGroupType {
/**
* The name of the Auto Scaling group. This name must be unique per Region per account.
*/
AutoScalingGroupName: XmlStringMaxLen255;
/**
* The name of the launch configuration. If you do not specify LaunchConfigurationName, you must specify one of the following parameters: InstanceId, LaunchTemplate, or MixedInstancesPolicy.
*/
LaunchConfigurationName?: ResourceName;
/**
* The launch template to use to launch instances. For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference. If you do not specify LaunchTemplate, you must specify one of the following parameters: InstanceId, LaunchConfigurationName, or MixedInstancesPolicy.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used. The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types. For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide. You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.
*/
MixedInstancesPolicy?: MixedInstancesPolicy;
/**
* The ID of the instance used to create a launch configuration for the group. When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping. For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide. You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.
*/
InstanceId?: XmlStringMaxLen19;
/**
* The minimum size of the group.
*/
MinSize: AutoScalingGroupMinSize;
/**
* The maximum size of the group.
*/
MaxSize: AutoScalingGroupMaxSize;
/**
* The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
/**
* The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
DefaultCooldown?: Cooldown;
/**
* One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier. Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
*/
AvailabilityZones?: AvailabilityZones;
/**
* A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead. For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
LoadBalancerNames?: LoadBalancerNames;
/**
* The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
TargetGroupARNs?: TargetGroupARNs;
/**
* The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
HealthCheckType?: XmlStringMaxLen32;
/**
* The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0. For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you are adding an ELB health check.
*/
HealthCheckGracePeriod?: HealthCheckGracePeriod;
/**
* The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
*/
PlacementGroup?: XmlStringMaxLen255;
/**
* A comma-separated list of subnet IDs for your virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones. Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
*/
VPCZoneIdentifier?: XmlStringMaxLen2047;
/**
* One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed. For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
*/
TerminationPolicies?: TerminationPolicies;
/**
* Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
NewInstancesProtectedFromScaleIn?: InstanceProtected;
/**
* One or more lifecycle hooks.
*/
LifecycleHookSpecificationList?: LifecycleHookSpecifications;
/**
* One or more tags. For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
*/
Tags?: Tags;
/**
* The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
*/
ServiceLinkedRoleARN?: ResourceName;
/**
* The maximum amount of time, in seconds, that an instance can be in service. For more information, see Replacing Auto Scaling Instances Based on Maximum Instance Lifetime in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 604800.
*/
MaxInstanceLifetime?: MaxInstanceLifetime;
}
export interface CreateLaunchConfigurationType {
/**
* The name of the launch configuration. This name must be unique per Region per account.
*/
LaunchConfigurationName: XmlStringMaxLen255;
/**
* The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances. If you do not specify InstanceId, you must specify ImageId.
*/
ImageId?: XmlStringMaxLen255;
/**
* The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
*/
KeyName?: XmlStringMaxLen255;
/**
* A list that contains the security groups to assign to the instances in the Auto Scaling group. [EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. [EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.
*/
SecurityGroups?: SecurityGroups;
/**
* The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. This parameter can only be used if you are launching EC2-Classic instances.
*/
ClassicLinkVPCId?: XmlStringMaxLen255;
/**
* The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. If you specify the ClassicLinkVPCId parameter, you must specify this parameter.
*/
ClassicLinkVPCSecurityGroups?: ClassicLinkVPCSecurityGroups;
/**
* The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
*/
UserData?: XmlStringUserData;
/**
* The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping. To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request. For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide. If you do not specify InstanceId, you must specify both ImageId and InstanceType.
*/
InstanceId?: XmlStringMaxLen19;
/**
* Specifies the instance type of the EC2 instance. For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances. If you do not specify InstanceId, you must specify InstanceType.
*/
InstanceType?: XmlStringMaxLen255;
/**
* The ID of the kernel associated with the AMI.
*/
KernelId?: XmlStringMaxLen255;
/**
* The ID of the RAM disk to select.
*/
RamdiskId?: XmlStringMaxLen255;
/**
* A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
*/
BlockDeviceMappings?: BlockDeviceMappings;
/**
* Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. The default value is true (enabled). When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
InstanceMonitoring?: InstanceMonitoring;
/**
* The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
*/
SpotPrice?: SpotPrice;
/**
* The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
*/
IamInstanceProfile?: XmlStringMaxLen1600;
/**
* Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances. The default value is false.
*/
EbsOptimized?: EbsOptimized;
/**
* For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide. If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group. If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.
*/
AssociatePublicIpAddress?: AssociatePublicIpAddress;
/**
* The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated. If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group. For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide. Valid Values: default | dedicated
*/
PlacementTenancy?: XmlStringMaxLen64;
}
export interface CreateOrUpdateTagsType {
/**
* One or more tags.
*/
Tags: Tags;
}
export interface CustomizedMetricSpecification {
/**
* The name of the metric.
*/
MetricName: MetricName;
/**
* The namespace of the metric.
*/
Namespace: MetricNamespace;
/**
* The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
*/
Dimensions?: MetricDimensions;
/**
* The statistic of the metric.
*/
Statistic: MetricStatistic;
/**
* The unit of the metric.
*/
Unit?: MetricUnit;
}
export interface DeleteAutoScalingGroupType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
*/
ForceDelete?: ForceDelete;
}
export interface DeleteLifecycleHookAnswer {
}
export interface DeleteLifecycleHookType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
}
export interface DeleteNotificationConfigurationType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
*/
TopicARN: ResourceName;
}
export interface DeletePolicyType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The name or Amazon Resource Name (ARN) of the policy.
*/
PolicyName: ResourceName;
}
export interface DeleteScheduledActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of the action to delete.
*/
ScheduledActionName: ResourceName;
}
export interface DeleteTagsType {
/**
* One or more tags.
*/
Tags: Tags;
}
export interface DescribeAccountLimitsAnswer {
/**
* The maximum number of groups allowed for your AWS account. The default is 200 groups per AWS Region.
*/
MaxNumberOfAutoScalingGroups?: MaxNumberOfAutoScalingGroups;
/**
* The maximum number of launch configurations allowed for your AWS account. The default is 200 launch configurations per AWS Region.
*/
MaxNumberOfLaunchConfigurations?: MaxNumberOfLaunchConfigurations;
/**
* The current number of groups for your AWS account.
*/
NumberOfAutoScalingGroups?: NumberOfAutoScalingGroups;
/**
* The current number of launch configurations for your AWS account.
*/
NumberOfLaunchConfigurations?: NumberOfLaunchConfigurations;
}
export interface DescribeAdjustmentTypesAnswer {
/**
* The policy adjustment types.
*/
AdjustmentTypes?: AdjustmentTypes;
}
export interface DescribeAutoScalingInstancesType {
/**
* The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
*/
InstanceIds?: InstanceIds;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.
*/
MaxRecords?: MaxRecords;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
}
export interface DescribeAutoScalingNotificationTypesAnswer {
/**
* The notification types.
*/
AutoScalingNotificationTypes?: AutoScalingNotificationTypes;
}
export interface DescribeLifecycleHookTypesAnswer {
/**
* The lifecycle hook types.
*/
LifecycleHookTypes?: AutoScalingNotificationTypes;
}
export interface DescribeLifecycleHooksAnswer {
/**
* The lifecycle hooks for the specified group.
*/
LifecycleHooks?: LifecycleHooks;
}
export interface DescribeLifecycleHooksType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
*/
LifecycleHookNames?: LifecycleHookNames;
}
export interface DescribeLoadBalancerTargetGroupsRequest {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeLoadBalancerTargetGroupsResponse {
/**
* Information about the target groups.
*/
LoadBalancerTargetGroups?: LoadBalancerTargetGroupStates;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface DescribeLoadBalancersRequest {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeLoadBalancersResponse {
/**
* The load balancers.
*/
LoadBalancers?: LoadBalancerStates;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface DescribeMetricCollectionTypesAnswer {
/**
* One or more metrics.
*/
Metrics?: MetricCollectionTypes;
/**
* The granularities for the metrics.
*/
Granularities?: MetricGranularityTypes;
}
export interface DescribeNotificationConfigurationsAnswer {
/**
* The notification configurations.
*/
NotificationConfigurations: NotificationConfigurations;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface DescribeNotificationConfigurationsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupNames?: AutoScalingGroupNames;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribePoliciesType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
*/
PolicyNames?: PolicyNames;
/**
* One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
*/
PolicyTypes?: PolicyTypes;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeScalingActivitiesType {
/**
* The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
*/
ActivityIds?: ActivityIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
}
export interface DescribeScheduledActionsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
*/
ScheduledActionNames?: ScheduledActionNames;
/**
* The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
*/
StartTime?: TimestampType;
/**
* The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
*/
EndTime?: TimestampType;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeTagsType {
/**
* One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.
*/
Filters?: Filters;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export interface DescribeTerminationPolicyTypesAnswer {
/**
* The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy.
*/
TerminationPolicyTypes?: TerminationPolicies;
}
export interface DetachInstancesAnswer {
/**
* The activities related to detaching the instances from the Auto Scaling group.
*/
Activities?: Activities;
}
export interface DetachInstancesQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.
*/
ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity;
}
export interface DetachLoadBalancerTargetGroupsResultType {
}
export interface DetachLoadBalancerTargetGroupsType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
*/
TargetGroupARNs: TargetGroupARNs;
}
export interface DetachLoadBalancersResultType {
}
export interface DetachLoadBalancersType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The names of the load balancers. You can specify up to 10 load balancers.
*/
LoadBalancerNames: LoadBalancerNames;
}
export interface DisableMetricsCollectionQuery {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more of the following metrics. If you omit this parameter, all metrics are disabled. GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metrics?: Metrics;
}
export type DisableScaleIn = boolean;
export interface Ebs {
/**
* The snapshot ID of the volume to use. Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot.
*/
SnapshotId?: XmlStringMaxLen255;
/**
* The volume size, in Gibibytes (GiB). This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size. At least one of VolumeSize or SnapshotId is required.
*/
VolumeSize?: BlockDeviceEbsVolumeSize;
/**
* The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Valid Values: standard | io1 | gp2 | st1 | sc1
*/
VolumeType?: BlockDeviceEbsVolumeType;
/**
* Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.
*/
DeleteOnTermination?: BlockDeviceEbsDeleteOnTermination;
/**
* The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances. Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)
*/
Iops?: BlockDeviceEbsIops;
/**
* Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types. If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK. Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted. For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide.
*/
Encrypted?: BlockDeviceEbsEncrypted;
}
export type EbsOptimized = boolean;
export interface EnableMetricsCollectionQuery {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more of the following metrics. If you omit this parameter, all metrics are enabled. GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metrics?: Metrics;
/**
* The granularity to associate with the metrics to collect. The only valid value is 1Minute.
*/
Granularity: XmlStringMaxLen255;
}
export interface EnabledMetric {
/**
* One of the following metrics: GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metric?: XmlStringMaxLen255;
/**
* The granularity of the metric. The only valid value is 1Minute.
*/
Granularity?: XmlStringMaxLen255;
}
export type EnabledMetrics = EnabledMetric[];
export interface EnterStandbyAnswer {
/**
* The activities related to moving instances into Standby mode.
*/
Activities?: Activities;
}
export interface EnterStandbyQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.
*/
ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity;
}
export type EstimatedInstanceWarmup = number;
export interface ExecutePolicyType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The name or ARN of the policy.
*/
PolicyName: ResourceName;
/**
* Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy. This parameter is not supported if the policy type is StepScaling or TargetTrackingScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
HonorCooldown?: HonorCooldown;
/**
* The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59. If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
*/
MetricValue?: MetricScale;
/**
* The breach threshold for the alarm. Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
*/
BreachThreshold?: MetricScale;
}
export interface ExitStandbyAnswer {
/**
* The activities related to moving instances out of Standby mode.
*/
Activities?: Activities;
}
export interface ExitStandbyQuery {
/**
* The IDs of the instances. You can specify up to 20 instances.
*/
InstanceIds?: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
}
export interface FailedScheduledUpdateGroupActionRequest {
/**
* The name of the scheduled action.
*/
ScheduledActionName: XmlStringMaxLen255;
/**
* The error code.
*/
ErrorCode?: XmlStringMaxLen64;
/**
* The error message accompanying the error code.
*/
ErrorMessage?: XmlString;
}
export type FailedScheduledUpdateGroupActionRequests = FailedScheduledUpdateGroupActionRequest[];
export interface Filter {
/**
* The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".
*/
Name?: XmlString;
/**
* The value of the filter.
*/
Values?: Values;
}
export type Filters = Filter[];
export type ForceDelete = boolean;
export type GlobalTimeout = number;
export type HealthCheckGracePeriod = number;
export type HeartbeatTimeout = number;
export type HonorCooldown = boolean;
export interface Instance {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* The instance type of the EC2 instance.
*/
InstanceType?: XmlStringMaxLen255;
/**
* The Availability Zone in which the instance is running.
*/
AvailabilityZone: XmlStringMaxLen255;
/**
* A description of the current lifecycle state. The Quarantined state is not used.
*/
LifecycleState: LifecycleState;
/**
* The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
*/
HealthStatus: XmlStringMaxLen32;
/**
* The launch configuration associated with the instance.
*/
LaunchConfigurationName?: XmlStringMaxLen255;
/**
* The launch template for the instance.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
ProtectedFromScaleIn: InstanceProtected;
/**
* The number of capacity units contributed by the instance based on its instance type. Valid Range: Minimum value of 1. Maximum value of 999.
*/
WeightedCapacity?: XmlStringMaxLen32;
}
export type InstanceIds = XmlStringMaxLen19[];
export interface InstanceMonitoring {
/**
* If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
*/
Enabled?: MonitoringEnabled;
}
export type InstanceProtected = boolean;
export type Instances = Instance[];
export interface InstancesDistribution {
/**
* Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
*/
OnDemandAllocationStrategy?: XmlString;
/**
* The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales. Default if not set is 0. If you leave it set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting. An update to this setting means a gradual replacement of instances to maintain the specified number of On-Demand Instances for your base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones.
*/
OnDemandBaseCapacity?: OnDemandBaseCapacity;
/**
* Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Default if not set is 100. If you leave it set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances. An update to this setting means a gradual replacement of instances to maintain the percentage of On-Demand Instances for your additional capacity above the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones. Valid Range: Minimum value of 0. Maximum value of 100.
*/
OnDemandPercentageAboveBaseCapacity?: OnDemandPercentageAboveBaseCapacity;
/**
* Indicates how to allocate instances across Spot Instance pools. If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized, the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price. The default Spot allocation strategy for the AWS Management Console is capacity-optimized. Valid values: lowest-price | capacity-optimized
*/
SpotAllocationStrategy?: XmlString;
/**
* The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate. Default if not set is 2. Used only when the Spot allocation strategy is lowest-price. Valid Range: Minimum value of 1. Maximum value of 20.
*/
SpotInstancePools?: SpotInstancePools;
/**
* The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price. To remove a value that you previously set, include the parameter but leave the value blank.
*/
SpotMaxPrice?: MixedInstanceSpotPrice;
}
export interface LaunchConfiguration {
/**
* The name of the launch configuration.
*/
LaunchConfigurationName: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the launch configuration.
*/
LaunchConfigurationARN?: ResourceName;
/**
* The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
*/
ImageId: XmlStringMaxLen255;
/**
* The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
*/
KeyName?: XmlStringMaxLen255;
/**
* A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
*/
SecurityGroups?: SecurityGroups;
/**
* The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
*/
ClassicLinkVPCId?: XmlStringMaxLen255;
/**
* The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
*/
ClassicLinkVPCSecurityGroups?: ClassicLinkVPCSecurityGroups;
/**
* The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
*/
UserData?: XmlStringUserData;
/**
* The instance type for the instances. For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
*/
InstanceType: XmlStringMaxLen255;
/**
* The ID of the kernel associated with the AMI.
*/
KernelId?: XmlStringMaxLen255;
/**
* The ID of the RAM disk associated with the AMI.
*/
RamdiskId?: XmlStringMaxLen255;
/**
* A block device mapping, which specifies the block devices for the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
*/
BlockDeviceMappings?: BlockDeviceMappings;
/**
* Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
*/
InstanceMonitoring?: InstanceMonitoring;
/**
* The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
SpotPrice?: SpotPrice;
/**
* The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
*/
IamInstanceProfile?: XmlStringMaxLen1600;
/**
* The creation date and time for the launch configuration.
*/
CreatedTime: TimestampType;
/**
* Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
*/
EbsOptimized?: EbsOptimized;
/**
* For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
*/
AssociatePublicIpAddress?: AssociatePublicIpAddress;
/**
* The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.
*/
PlacementTenancy?: XmlStringMaxLen64;
}
export interface LaunchConfigurationNameType {
/**
* The name of the launch configuration.
*/
LaunchConfigurationName: ResourceName;
}
export type LaunchConfigurationNames = ResourceName[];
export interface LaunchConfigurationNamesType {
/**
* The launch configuration names. If you omit this parameter, all launch configurations are described.
*/
LaunchConfigurationNames?: LaunchConfigurationNames;
/**
* The token for the next set of items to return. (You received this token from a previous call.)
*/
NextToken?: XmlString;
/**
* The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
*/
MaxRecords?: MaxRecords;
}
export type LaunchConfigurations = LaunchConfiguration[];
export interface LaunchConfigurationsType {
/**
* The launch configurations.
*/
LaunchConfigurations: LaunchConfigurations;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface LaunchTemplate {
/**
* The launch template to use. You must specify either the launch template ID or launch template name in the request.
*/
LaunchTemplateSpecification?: LaunchTemplateSpecification;
/**
* An optional setting. Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You can specify between 1 and 20 instance types.
*/
Overrides?: Overrides;
}
export type LaunchTemplateName = string;
export interface LaunchTemplateOverrides {
/**
* The instance type. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
*/
InstanceType?: XmlStringMaxLen255;
/**
* The number of capacity units, which gives the instance type a proportional weight to other instance types. For example, larger instance types are generally weighted more than smaller instance types. These are the same units that you chose to set the desired capacity in terms of instances, or a performance attribute such as vCPUs, memory, or I/O. For more information, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 1. Maximum value of 999.
*/
WeightedCapacity?: XmlStringMaxLen32;
}
export interface LaunchTemplateSpecification {
/**
* The ID of the launch template. You must specify either a template ID or a template name.
*/
LaunchTemplateId?: XmlStringMaxLen255;
/**
* The name of the launch template. You must specify either a template name or a template ID.
*/
LaunchTemplateName?: LaunchTemplateName;
/**
* The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
*/
Version?: XmlStringMaxLen255;
}
export type LifecycleActionResult = string;
export type LifecycleActionToken = string;
export interface LifecycleHook {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName?: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group for the lifecycle hook.
*/
AutoScalingGroupName?: ResourceName;
/**
* The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
*/
LifecycleTransition?: LifecycleTransition;
/**
* The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
*/
NotificationTargetARN?: ResourceName;
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
*/
RoleARN?: ResourceName;
/**
* Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
NotificationMetadata?: XmlStringMaxLen1023;
/**
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.
*/
HeartbeatTimeout?: HeartbeatTimeout;
/**
* The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.
*/
GlobalTimeout?: GlobalTimeout;
/**
* Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
*/
DefaultResult?: LifecycleActionResult;
}
export type LifecycleHookNames = AsciiStringMaxLen255[];
export interface LifecycleHookSpecification {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING
*/
LifecycleTransition: LifecycleTransition;
/**
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
NotificationMetadata?: XmlStringMaxLen1023;
/**
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
*/
HeartbeatTimeout?: HeartbeatTimeout;
/**
* Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is ABANDON.
*/
DefaultResult?: LifecycleActionResult;
/**
* The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
*/
NotificationTargetARN?: NotificationTargetResourceName;
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
*/
RoleARN?: ResourceName;
}
export type LifecycleHookSpecifications = LifecycleHookSpecification[];
export type LifecycleHooks = LifecycleHook[];
export type LifecycleState = "Pending"|"Pending:Wait"|"Pending:Proceed"|"Quarantined"|"InService"|"Terminating"|"Terminating:Wait"|"Terminating:Proceed"|"Terminated"|"Detaching"|"Detached"|"EnteringStandby"|"Standby"|string;
export type LifecycleTransition = string;
export type LoadBalancerNames = XmlStringMaxLen255[];
export interface LoadBalancerState {
/**
* The name of the load balancer.
*/
LoadBalancerName?: XmlStringMaxLen255;
/**
* One of the following load balancer states: Adding - The instances in the group are being registered with the load balancer. Added - All instances in the group are registered with the load balancer. InService - At least one instance in the group passed an ELB health check. Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. Removed - All instances in the group are deregistered from the load balancer.
*/
State?: XmlStringMaxLen255;
}
export type LoadBalancerStates = LoadBalancerState[];
export interface LoadBalancerTargetGroupState {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
LoadBalancerTargetGroupARN?: XmlStringMaxLen511;
/**
* The state of the target group. Adding - The Auto Scaling instances are being registered with the target group. Added - All Auto Scaling instances are registered with the target group. InService - At least one Auto Scaling instance passed an ELB health check. Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. Removed - All Auto Scaling instances are deregistered from the target group.
*/
State?: XmlStringMaxLen255;
}
export type LoadBalancerTargetGroupStates = LoadBalancerTargetGroupState[];
export type MaxInstanceLifetime = number;
export type MaxNumberOfAutoScalingGroups = number;
export type MaxNumberOfLaunchConfigurations = number;
export type MaxRecords = number;
export interface MetricCollectionType {
/**
* One of the following metrics: GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupStandbyInstances GroupTerminatingInstances GroupTotalInstances
*/
Metric?: XmlStringMaxLen255;
}
export type MetricCollectionTypes = MetricCollectionType[];
export interface MetricDimension {
/**
* The name of the dimension.
*/
Name: MetricDimensionName;
/**
* The value of the dimension.
*/
Value: MetricDimensionValue;
}
export type MetricDimensionName = string;
export type MetricDimensionValue = string;
export type MetricDimensions = MetricDimension[];
export interface MetricGranularityType {
/**
* The granularity. The only valid value is 1Minute.
*/
Granularity?: XmlStringMaxLen255;
}
export type MetricGranularityTypes = MetricGranularityType[];
export type MetricName = string;
export type MetricNamespace = string;
export type MetricScale = number;
export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string;
export type MetricType = "ASGAverageCPUUtilization"|"ASGAverageNetworkIn"|"ASGAverageNetworkOut"|"ALBRequestCountPerTarget"|string;
export type MetricUnit = string;
export type Metrics = XmlStringMaxLen255[];
export type MinAdjustmentMagnitude = number;
export type MinAdjustmentStep = number;
export type MixedInstanceSpotPrice = string;
export interface MixedInstancesPolicy {
/**
* The launch template and instance types (overrides). This parameter must be specified when creating a mixed instances policy.
*/
LaunchTemplate?: LaunchTemplate;
/**
* The instances distribution to use. If you leave this parameter unspecified, the value for each parameter in InstancesDistribution uses a default value.
*/
InstancesDistribution?: InstancesDistribution;
}
export type MonitoringEnabled = boolean;
export type NoDevice = boolean;
export interface NotificationConfiguration {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
*/
TopicARN?: ResourceName;
/**
* One of the following event notification types: autoscaling:EC2_INSTANCE_LAUNCH autoscaling:EC2_INSTANCE_LAUNCH_ERROR autoscaling:EC2_INSTANCE_TERMINATE autoscaling:EC2_INSTANCE_TERMINATE_ERROR autoscaling:TEST_NOTIFICATION
*/
NotificationType?: XmlStringMaxLen255;
}
export type NotificationConfigurations = NotificationConfiguration[];
export type NotificationTargetResourceName = string;
export type NumberOfAutoScalingGroups = number;
export type NumberOfLaunchConfigurations = number;
export type OnDemandBaseCapacity = number;
export type OnDemandPercentageAboveBaseCapacity = number;
export type Overrides = LaunchTemplateOverrides[];
export interface PoliciesType {
/**
* The scaling policies.
*/
ScalingPolicies?: ScalingPolicies;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface PolicyARNType {
/**
* The Amazon Resource Name (ARN) of the policy.
*/
PolicyARN?: ResourceName;
/**
* The CloudWatch alarms created for the target tracking scaling policy.
*/
Alarms?: Alarms;
}
export type PolicyIncrement = number;
export type PolicyNames = ResourceName[];
export type PolicyTypes = XmlStringMaxLen64[];
export interface PredefinedMetricSpecification {
/**
* The metric type. The following predefined metrics are available: ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group. ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group. ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group. ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.
*/
PredefinedMetricType: MetricType;
/**
* Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group. The format is app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN.
*/
ResourceLabel?: XmlStringMaxLen1023;
}
export type ProcessNames = XmlStringMaxLen255[];
export interface ProcessType {
/**
* One of the following processes: Launch Terminate AddToLoadBalancer AlarmNotification AZRebalance HealthCheck ReplaceUnhealthy ScheduledActions
*/
ProcessName: XmlStringMaxLen255;
}
export type Processes = ProcessType[];
export interface ProcessesType {
/**
* The names of the process types.
*/
Processes?: Processes;
}
export type Progress = number;
export type PropagateAtLaunch = boolean;
export type ProtectedFromScaleIn = boolean;
export interface PutLifecycleHookAnswer {
}
export interface PutLifecycleHookType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The instance state to which you want to attach the lifecycle hook. The valid values are: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATING Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
*/
LifecycleTransition?: LifecycleTransition;
/**
* The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue. Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
*/
RoleARN?: ResourceName;
/**
* The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN. This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic. When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
*/
NotificationTargetARN?: NotificationTargetResourceName;
/**
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
*/
NotificationMetadata?: XmlStringMaxLen1023;
/**
* The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour). If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
*/
HeartbeatTimeout?: HeartbeatTimeout;
/**
* Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.
*/
DefaultResult?: LifecycleActionResult;
}
export interface PutNotificationConfigurationType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
*/
TopicARN: ResourceName;
/**
* The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.
*/
NotificationTypes: AutoScalingNotificationTypes;
}
export interface PutScalingPolicyType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of the policy.
*/
PolicyName: XmlStringMaxLen255;
/**
* The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
*/
PolicyType?: XmlStringMaxLen64;
/**
* Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity. Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.
*/
AdjustmentType?: XmlStringMaxLen255;
/**
* Available for backward compatibility. Use MinAdjustmentMagnitude instead.
*/
MinAdjustmentStep?: MinAdjustmentStep;
/**
* The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError. This property replaces the MinAdjustmentStep property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. Valid only if the policy type is SimpleScaling or StepScaling.
*/
MinAdjustmentMagnitude?: MinAdjustmentMagnitude;
/**
* The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value. Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
*/
ScalingAdjustment?: PolicyIncrement;
/**
* The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies. Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
Cooldown?: Cooldown;
/**
* The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average. Valid only if the policy type is StepScaling.
*/
MetricAggregationType?: XmlStringMaxLen32;
/**
* A set of adjustments that enable you to scale based on the size of the alarm breach. Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
*/
StepAdjustments?: StepAdjustments;
/**
* The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group. Valid only if the policy type is StepScaling or TargetTrackingScaling.
*/
EstimatedInstanceWarmup?: EstimatedInstanceWarmup;
/**
* A target tracking scaling policy. Includes support for predefined or customized metrics. For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference. Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
*/
TargetTrackingConfiguration?: TargetTrackingConfiguration;
/**
* Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a Scaling Policy for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
*/
Enabled?: ScalingPolicyEnabled;
}
export interface PutScheduledUpdateGroupActionType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of this scaling action.
*/
ScheduledActionName: XmlStringMaxLen255;
/**
* This parameter is no longer used.
*/
Time?: TimestampType;
/**
* The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
*/
StartTime?: TimestampType;
/**
* The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
*/
EndTime?: TimestampType;
/**
* The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab. When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
*/
Recurrence?: XmlStringMaxLen255;
/**
* The minimum number of instances in the Auto Scaling group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum number of instances in the Auto Scaling group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the Auto Scaling group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
}
export interface RecordLifecycleActionHeartbeatAnswer {
}
export interface RecordLifecycleActionHeartbeatType {
/**
* The name of the lifecycle hook.
*/
LifecycleHookName: AsciiStringMaxLen255;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.
*/
LifecycleActionToken?: LifecycleActionToken;
/**
* The ID of the instance.
*/
InstanceId?: XmlStringMaxLen19;
}
export type ResourceName = string;
export type ScalingActivityStatusCode = "PendingSpotBidPlacement"|"WaitingForSpotInstanceRequestId"|"WaitingForSpotInstanceId"|"WaitingForInstanceId"|"PreInService"|"InProgress"|"WaitingForELBConnectionDraining"|"MidLifecycleAction"|"WaitingForInstanceWarmup"|"Successful"|"Failed"|"Cancelled"|string;
export type ScalingPolicies = ScalingPolicy[];
export interface ScalingPolicy {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: XmlStringMaxLen255;
/**
* The name of the scaling policy.
*/
PolicyName?: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the policy.
*/
PolicyARN?: ResourceName;
/**
* The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
*/
PolicyType?: XmlStringMaxLen64;
/**
* The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
*/
AdjustmentType?: XmlStringMaxLen255;
/**
* Available for backward compatibility. Use MinAdjustmentMagnitude instead.
*/
MinAdjustmentStep?: MinAdjustmentStep;
/**
* The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
*/
MinAdjustmentMagnitude?: MinAdjustmentMagnitude;
/**
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
*/
ScalingAdjustment?: PolicyIncrement;
/**
* The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
*/
Cooldown?: Cooldown;
/**
* A set of adjustments that enable you to scale based on the size of the alarm breach.
*/
StepAdjustments?: StepAdjustments;
/**
* The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
*/
MetricAggregationType?: XmlStringMaxLen32;
/**
* The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
*/
EstimatedInstanceWarmup?: EstimatedInstanceWarmup;
/**
* The CloudWatch alarms related to the policy.
*/
Alarms?: Alarms;
/**
* A target tracking scaling policy.
*/
TargetTrackingConfiguration?: TargetTrackingConfiguration;
/**
* Indicates whether the policy is enabled (true) or disabled (false).
*/
Enabled?: ScalingPolicyEnabled;
}
export type ScalingPolicyEnabled = boolean;
export interface ScalingProcessQuery {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* One or more of the following processes. If you omit this parameter, all processes are specified. Launch Terminate HealthCheck ReplaceUnhealthy AZRebalance AlarmNotification ScheduledActions AddToLoadBalancer
*/
ScalingProcesses?: ProcessNames;
}
export type ScheduledActionNames = ResourceName[];
export interface ScheduledActionsType {
/**
* The scheduled actions.
*/
ScheduledUpdateGroupActions?: ScheduledUpdateGroupActions;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export interface ScheduledUpdateGroupAction {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName?: XmlStringMaxLen255;
/**
* The name of the scheduled action.
*/
ScheduledActionName?: XmlStringMaxLen255;
/**
* The Amazon Resource Name (ARN) of the scheduled action.
*/
ScheduledActionARN?: ResourceName;
/**
* This parameter is no longer used.
*/
Time?: TimestampType;
/**
* The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".
*/
StartTime?: TimestampType;
/**
* The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".
*/
EndTime?: TimestampType;
/**
* The recurring schedule for the action, in Unix cron syntax format. When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
*/
Recurrence?: XmlStringMaxLen255;
/**
* The minimum number of instances in the Auto Scaling group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum number of instances in the Auto Scaling group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of instances you prefer to maintain in the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
}
export interface ScheduledUpdateGroupActionRequest {
/**
* The name of the scaling action.
*/
ScheduledActionName: XmlStringMaxLen255;
/**
* The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z"). If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence. If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
*/
StartTime?: TimestampType;
/**
* The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
*/
EndTime?: TimestampType;
/**
* The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab. When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
*/
Recurrence?: XmlStringMaxLen255;
/**
* The minimum number of instances in the Auto Scaling group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum number of instances in the Auto Scaling group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
}
export type ScheduledUpdateGroupActionRequests = ScheduledUpdateGroupActionRequest[];
export type ScheduledUpdateGroupActions = ScheduledUpdateGroupAction[];
export type SecurityGroups = XmlString[];
export interface SetDesiredCapacityType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The number of EC2 instances that should be running in the Auto Scaling group.
*/
DesiredCapacity: AutoScalingGroupDesiredCapacity;
/**
* Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.
*/
HonorCooldown?: HonorCooldown;
}
export interface SetInstanceHealthQuery {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
*/
HealthStatus: XmlStringMaxLen32;
/**
* If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group. For more information about the health check grace period, see CreateAutoScalingGroup.
*/
ShouldRespectGracePeriod?: ShouldRespectGracePeriod;
}
export interface SetInstanceProtectionAnswer {
}
export interface SetInstanceProtectionQuery {
/**
* One or more instance IDs.
*/
InstanceIds: InstanceIds;
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
*/
ProtectedFromScaleIn: ProtectedFromScaleIn;
}
export type ShouldDecrementDesiredCapacity = boolean;
export type ShouldRespectGracePeriod = boolean;
export type SpotInstancePools = number;
export type SpotPrice = string;
export interface StepAdjustment {
/**
* The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
*/
MetricIntervalLowerBound?: MetricScale;
/**
* The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. The upper bound must be greater than the lower bound.
*/
MetricIntervalUpperBound?: MetricScale;
/**
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
*/
ScalingAdjustment: PolicyIncrement;
}
export type StepAdjustments = StepAdjustment[];
export interface SuspendedProcess {
/**
* The name of the suspended process.
*/
ProcessName?: XmlStringMaxLen255;
/**
* The reason that the process was suspended.
*/
SuspensionReason?: XmlStringMaxLen255;
}
export type SuspendedProcesses = SuspendedProcess[];
export interface Tag {
/**
* The name of the group.
*/
ResourceId?: XmlString;
/**
* The type of resource. The only supported value is auto-scaling-group.
*/
ResourceType?: XmlString;
/**
* The tag key.
*/
Key: TagKey;
/**
* The tag value.
*/
Value?: TagValue;
/**
* Determines whether the tag is added to new instances as they are launched in the group.
*/
PropagateAtLaunch?: PropagateAtLaunch;
}
export interface TagDescription {
/**
* The name of the group.
*/
ResourceId?: XmlString;
/**
* The type of resource. The only supported value is auto-scaling-group.
*/
ResourceType?: XmlString;
/**
* The tag key.
*/
Key?: TagKey;
/**
* The tag value.
*/
Value?: TagValue;
/**
* Determines whether the tag is added to new instances as they are launched in the group.
*/
PropagateAtLaunch?: PropagateAtLaunch;
}
export type TagDescriptionList = TagDescription[];
export type TagKey = string;
export type TagValue = string;
export type Tags = Tag[];
export interface TagsType {
/**
* One or more tags.
*/
Tags?: TagDescriptionList;
/**
* A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
*/
NextToken?: XmlString;
}
export type TargetGroupARNs = XmlStringMaxLen511[];
export interface TargetTrackingConfiguration {
/**
* A predefined metric. You must specify either a predefined metric or a customized metric.
*/
PredefinedMetricSpecification?: PredefinedMetricSpecification;
/**
* A customized metric. You must specify either a predefined metric or a customized metric.
*/
CustomizedMetricSpecification?: CustomizedMetricSpecification;
/**
* The target value for the metric.
*/
TargetValue: MetricScale;
/**
* Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.
*/
DisableScaleIn?: DisableScaleIn;
}
export interface TerminateInstanceInAutoScalingGroupType {
/**
* The ID of the instance.
*/
InstanceId: XmlStringMaxLen19;
/**
* Indicates whether terminating the instance also decrements the size of the Auto Scaling group.
*/
ShouldDecrementDesiredCapacity: ShouldDecrementDesiredCapacity;
}
export type TerminationPolicies = XmlStringMaxLen1600[];
export type TimestampType = Date;
export interface UpdateAutoScalingGroupType {
/**
* The name of the Auto Scaling group.
*/
AutoScalingGroupName: ResourceName;
/**
* The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
*/
LaunchConfigurationName?: ResourceName;
/**
* The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy. For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.
*/
LaunchTemplate?: LaunchTemplateSpecification;
/**
* An embedded object that specifies a mixed instances policy. In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified. For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
*/
MixedInstancesPolicy?: MixedInstancesPolicy;
/**
* The minimum size of the Auto Scaling group.
*/
MinSize?: AutoScalingGroupMinSize;
/**
* The maximum size of the Auto Scaling group.
*/
MaxSize?: AutoScalingGroupMaxSize;
/**
* The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
*/
DesiredCapacity?: AutoScalingGroupDesiredCapacity;
/**
* The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This cooldown period is not used when a scaling-specific cooldown is specified. Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
*/
DefaultCooldown?: Cooldown;
/**
* One or more Availability Zones for the group.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
*/
HealthCheckType?: XmlStringMaxLen32;
/**
* The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0. For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide. Conditional: This parameter is required if you are adding an ELB health check.
*/
HealthCheckGracePeriod?: HealthCheckGracePeriod;
/**
* The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
*/
PlacementGroup?: XmlStringMaxLen255;
/**
* A comma-separated list of subnet IDs for virtual private cloud (VPC). If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.
*/
VPCZoneIdentifier?: XmlStringMaxLen2047;
/**
* A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed. For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
*/
TerminationPolicies?: TerminationPolicies;
/**
* Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
*/
NewInstancesProtectedFromScaleIn?: InstanceProtected;
/**
* The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
*/
ServiceLinkedRoleARN?: ResourceName;
/**
* The maximum amount of time, in seconds, that an instance can be in service. For more information, see Replacing Auto Scaling Instances Based on Maximum Instance Lifetime in the Amazon EC2 Auto Scaling User Guide. Valid Range: Minimum value of 604800.
*/
MaxInstanceLifetime?: MaxInstanceLifetime;
}
export type Values = XmlString[];
export type XmlString = string;
export type XmlStringMaxLen1023 = string;
export type XmlStringMaxLen1600 = string;
export type XmlStringMaxLen19 = string;
export type XmlStringMaxLen2047 = string;
export type XmlStringMaxLen255 = string;
export type XmlStringMaxLen32 = string;
export type XmlStringMaxLen511 = string;
export type XmlStringMaxLen64 = string;
export type XmlStringUserData = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2011-01-01"|"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 AutoScaling client.
*/
export import Types = AutoScaling;
}
export = AutoScaling;