elbv2.d.ts
106 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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class ELBv2 extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ELBv2.Types.ClientConfiguration)
config: Config & ELBv2.Types.ClientConfiguration;
/**
* Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener. For more information, see SSL Certificates in the Application Load Balancers Guide.
*/
addListenerCertificates(params: ELBv2.Types.AddListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.AddListenerCertificatesOutput) => void): Request<ELBv2.Types.AddListenerCertificatesOutput, AWSError>;
/**
* Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener. If the certificate in already in the certificate list, the call is successful but the certificate is not added again. To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener. For more information, see SSL Certificates in the Application Load Balancers Guide.
*/
addListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.AddListenerCertificatesOutput) => void): Request<ELBv2.Types.AddListenerCertificatesOutput, AWSError>;
/**
* Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
*/
addTags(params: ELBv2.Types.AddTagsInput, callback?: (err: AWSError, data: ELBv2.Types.AddTagsOutput) => void): Request<ELBv2.Types.AddTagsOutput, AWSError>;
/**
* Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
*/
addTags(callback?: (err: AWSError, data: ELBv2.Types.AddTagsOutput) => void): Request<ELBv2.Types.AddTagsOutput, AWSError>;
/**
* Creates a listener for the specified Application Load Balancer or Network Load Balancer. To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
*/
createListener(params: ELBv2.Types.CreateListenerInput, callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request<ELBv2.Types.CreateListenerOutput, AWSError>;
/**
* Creates a listener for the specified Application Load Balancer or Network Load Balancer. To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds. For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
*/
createListener(callback?: (err: AWSError, data: ELBv2.Types.CreateListenerOutput) => void): Request<ELBv2.Types.CreateListenerOutput, AWSError>;
/**
* Creates an Application Load Balancer or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
*/
createLoadBalancer(params: ELBv2.Types.CreateLoadBalancerInput, callback?: (err: AWSError, data: ELBv2.Types.CreateLoadBalancerOutput) => void): Request<ELBv2.Types.CreateLoadBalancerOutput, AWSError>;
/**
* Creates an Application Load Balancer or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
*/
createLoadBalancer(callback?: (err: AWSError, data: ELBv2.Types.CreateLoadBalancerOutput) => void): Request<ELBv2.Types.CreateLoadBalancerOutput, AWSError>;
/**
* Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide. To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
*/
createRule(params: ELBv2.Types.CreateRuleInput, callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request<ELBv2.Types.CreateRuleOutput, AWSError>;
/**
* Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide. To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
*/
createRule(callback?: (err: AWSError, data: ELBv2.Types.CreateRuleOutput) => void): Request<ELBv2.Types.CreateRuleOutput, AWSError>;
/**
* Creates a target group. To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth. To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule. To delete a target group, use DeleteTargetGroup. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
*/
createTargetGroup(params: ELBv2.Types.CreateTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.CreateTargetGroupOutput) => void): Request<ELBv2.Types.CreateTargetGroupOutput, AWSError>;
/**
* Creates a target group. To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth. To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule. To delete a target group, use DeleteTargetGroup. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds. For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
*/
createTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.CreateTargetGroupOutput) => void): Request<ELBv2.Types.CreateTargetGroupOutput, AWSError>;
/**
* Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.
*/
deleteListener(params: ELBv2.Types.DeleteListenerInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request<ELBv2.Types.DeleteListenerOutput, AWSError>;
/**
* Deletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.
*/
deleteListener(callback?: (err: AWSError, data: ELBv2.Types.DeleteListenerOutput) => void): Request<ELBv2.Types.DeleteListenerOutput, AWSError>;
/**
* Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
*/
deleteLoadBalancer(params: ELBv2.Types.DeleteLoadBalancerInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteLoadBalancerOutput) => void): Request<ELBv2.Types.DeleteLoadBalancerOutput, AWSError>;
/**
* Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
*/
deleteLoadBalancer(callback?: (err: AWSError, data: ELBv2.Types.DeleteLoadBalancerOutput) => void): Request<ELBv2.Types.DeleteLoadBalancerOutput, AWSError>;
/**
* Deletes the specified rule.
*/
deleteRule(params: ELBv2.Types.DeleteRuleInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteRuleOutput) => void): Request<ELBv2.Types.DeleteRuleOutput, AWSError>;
/**
* Deletes the specified rule.
*/
deleteRule(callback?: (err: AWSError, data: ELBv2.Types.DeleteRuleOutput) => void): Request<ELBv2.Types.DeleteRuleOutput, AWSError>;
/**
* Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
*/
deleteTargetGroup(params: ELBv2.Types.DeleteTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.DeleteTargetGroupOutput) => void): Request<ELBv2.Types.DeleteTargetGroupOutput, AWSError>;
/**
* Deletes the specified target group. You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
*/
deleteTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.DeleteTargetGroupOutput) => void): Request<ELBv2.Types.DeleteTargetGroupOutput, AWSError>;
/**
* Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
*/
deregisterTargets(params: ELBv2.Types.DeregisterTargetsInput, callback?: (err: AWSError, data: ELBv2.Types.DeregisterTargetsOutput) => void): Request<ELBv2.Types.DeregisterTargetsOutput, AWSError>;
/**
* Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
*/
deregisterTargets(callback?: (err: AWSError, data: ELBv2.Types.DeregisterTargetsOutput) => void): Request<ELBv2.Types.DeregisterTargetsOutput, AWSError>;
/**
* Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
*/
describeAccountLimits(params: ELBv2.Types.DescribeAccountLimitsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeAccountLimitsOutput) => void): Request<ELBv2.Types.DescribeAccountLimitsOutput, AWSError>;
/**
* Describes the current Elastic Load Balancing resource limits for your AWS account. For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
*/
describeAccountLimits(callback?: (err: AWSError, data: ELBv2.Types.DescribeAccountLimitsOutput) => void): Request<ELBv2.Types.DescribeAccountLimitsOutput, AWSError>;
/**
* Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL Certificates in the Application Load Balancers Guide.
*/
describeListenerCertificates(params: ELBv2.Types.DescribeListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeListenerCertificatesOutput) => void): Request<ELBv2.Types.DescribeListenerCertificatesOutput, AWSError>;
/**
* Describes the default certificate and the certificate list for the specified HTTPS or TLS listener. If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false). For more information, see SSL Certificates in the Application Load Balancers Guide.
*/
describeListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.DescribeListenerCertificatesOutput) => void): Request<ELBv2.Types.DescribeListenerCertificatesOutput, AWSError>;
/**
* Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners. For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.
*/
describeListeners(params: ELBv2.Types.DescribeListenersInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeListenersOutput) => void): Request<ELBv2.Types.DescribeListenersOutput, AWSError>;
/**
* Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners. For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.
*/
describeListeners(callback?: (err: AWSError, data: ELBv2.Types.DescribeListenersOutput) => void): Request<ELBv2.Types.DescribeListenersOutput, AWSError>;
/**
* Describes the attributes for the specified Application Load Balancer or Network Load Balancer. For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.
*/
describeLoadBalancerAttributes(params: ELBv2.Types.DescribeLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.DescribeLoadBalancerAttributesOutput, AWSError>;
/**
* Describes the attributes for the specified Application Load Balancer or Network Load Balancer. For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.
*/
describeLoadBalancerAttributes(callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.DescribeLoadBalancerAttributesOutput, AWSError>;
/**
* Describes the specified load balancers or all of your load balancers. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
*/
describeLoadBalancers(params: ELBv2.Types.DescribeLoadBalancersInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Describes the specified load balancers or all of your load balancers. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
*/
describeLoadBalancers(callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
*/
describeRules(params: ELBv2.Types.DescribeRulesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeRulesOutput) => void): Request<ELBv2.Types.DescribeRulesOutput, AWSError>;
/**
* Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.
*/
describeRules(callback?: (err: AWSError, data: ELBv2.Types.DescribeRulesOutput) => void): Request<ELBv2.Types.DescribeRulesOutput, AWSError>;
/**
* Describes the specified policies or all policies used for SSL negotiation. For more information, see Security Policies in the Application Load Balancers Guide.
*/
describeSSLPolicies(params: ELBv2.Types.DescribeSSLPoliciesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request<ELBv2.Types.DescribeSSLPoliciesOutput, AWSError>;
/**
* Describes the specified policies or all policies used for SSL negotiation. For more information, see Security Policies in the Application Load Balancers Guide.
*/
describeSSLPolicies(callback?: (err: AWSError, data: ELBv2.Types.DescribeSSLPoliciesOutput) => void): Request<ELBv2.Types.DescribeSSLPoliciesOutput, AWSError>;
/**
* Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
*/
describeTags(params: ELBv2.Types.DescribeTagsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTagsOutput) => void): Request<ELBv2.Types.DescribeTagsOutput, AWSError>;
/**
* Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.
*/
describeTags(callback?: (err: AWSError, data: ELBv2.Types.DescribeTagsOutput) => void): Request<ELBv2.Types.DescribeTagsOutput, AWSError>;
/**
* Describes the attributes for the specified target group. For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide.
*/
describeTargetGroupAttributes(params: ELBv2.Types.DescribeTargetGroupAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupAttributesOutput) => void): Request<ELBv2.Types.DescribeTargetGroupAttributesOutput, AWSError>;
/**
* Describes the attributes for the specified target group. For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide.
*/
describeTargetGroupAttributes(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupAttributesOutput) => void): Request<ELBv2.Types.DescribeTargetGroupAttributesOutput, AWSError>;
/**
* Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
*/
describeTargetGroups(params: ELBv2.Types.DescribeTargetGroupsInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupsOutput) => void): Request<ELBv2.Types.DescribeTargetGroupsOutput, AWSError>;
/**
* Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups. To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.
*/
describeTargetGroups(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetGroupsOutput) => void): Request<ELBv2.Types.DescribeTargetGroupsOutput, AWSError>;
/**
* Describes the health of the specified targets or all of your targets.
*/
describeTargetHealth(params: ELBv2.Types.DescribeTargetHealthInput, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>;
/**
* Describes the health of the specified targets or all of your targets.
*/
describeTargetHealth(callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>;
/**
* Modifies the specified properties of the specified listener. Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
*/
modifyListener(params: ELBv2.Types.ModifyListenerInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyListenerOutput) => void): Request<ELBv2.Types.ModifyListenerOutput, AWSError>;
/**
* Modifies the specified properties of the specified listener. Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.
*/
modifyListener(callback?: (err: AWSError, data: ELBv2.Types.ModifyListenerOutput) => void): Request<ELBv2.Types.ModifyListenerOutput, AWSError>;
/**
* Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
*/
modifyLoadBalancerAttributes(params: ELBv2.Types.ModifyLoadBalancerAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.ModifyLoadBalancerAttributesOutput, AWSError>;
/**
* Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer. If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.
*/
modifyLoadBalancerAttributes(callback?: (err: AWSError, data: ELBv2.Types.ModifyLoadBalancerAttributesOutput) => void): Request<ELBv2.Types.ModifyLoadBalancerAttributesOutput, AWSError>;
/**
* Modifies the specified rule. Any existing properties that you do not modify retain their current values. To modify the actions for the default rule, use ModifyListener.
*/
modifyRule(params: ELBv2.Types.ModifyRuleInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyRuleOutput) => void): Request<ELBv2.Types.ModifyRuleOutput, AWSError>;
/**
* Modifies the specified rule. Any existing properties that you do not modify retain their current values. To modify the actions for the default rule, use ModifyListener.
*/
modifyRule(callback?: (err: AWSError, data: ELBv2.Types.ModifyRuleOutput) => void): Request<ELBv2.Types.ModifyRuleOutput, AWSError>;
/**
* Modifies the health checks used when evaluating the health state of the targets in the specified target group. To monitor the health of the targets, use DescribeTargetHealth.
*/
modifyTargetGroup(params: ELBv2.Types.ModifyTargetGroupInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupOutput) => void): Request<ELBv2.Types.ModifyTargetGroupOutput, AWSError>;
/**
* Modifies the health checks used when evaluating the health state of the targets in the specified target group. To monitor the health of the targets, use DescribeTargetHealth.
*/
modifyTargetGroup(callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupOutput) => void): Request<ELBv2.Types.ModifyTargetGroupOutput, AWSError>;
/**
* Modifies the specified attributes of the specified target group.
*/
modifyTargetGroupAttributes(params: ELBv2.Types.ModifyTargetGroupAttributesInput, callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupAttributesOutput) => void): Request<ELBv2.Types.ModifyTargetGroupAttributesOutput, AWSError>;
/**
* Modifies the specified attributes of the specified target group.
*/
modifyTargetGroupAttributes(callback?: (err: AWSError, data: ELBv2.Types.ModifyTargetGroupAttributesOutput) => void): Request<ELBv2.Types.ModifyTargetGroupAttributesOutput, AWSError>;
/**
* Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. To remove a target from a target group, use DeregisterTargets.
*/
registerTargets(params: ELBv2.Types.RegisterTargetsInput, callback?: (err: AWSError, data: ELBv2.Types.RegisterTargetsOutput) => void): Request<ELBv2.Types.RegisterTargetsOutput, AWSError>;
/**
* Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address. To remove a target from a target group, use DeregisterTargets.
*/
registerTargets(callback?: (err: AWSError, data: ELBv2.Types.RegisterTargetsOutput) => void): Request<ELBv2.Types.RegisterTargetsOutput, AWSError>;
/**
* Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener. You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener. To list the certificates for your listener, use DescribeListenerCertificates.
*/
removeListenerCertificates(params: ELBv2.Types.RemoveListenerCertificatesInput, callback?: (err: AWSError, data: ELBv2.Types.RemoveListenerCertificatesOutput) => void): Request<ELBv2.Types.RemoveListenerCertificatesOutput, AWSError>;
/**
* Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener. You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener. To list the certificates for your listener, use DescribeListenerCertificates.
*/
removeListenerCertificates(callback?: (err: AWSError, data: ELBv2.Types.RemoveListenerCertificatesOutput) => void): Request<ELBv2.Types.RemoveListenerCertificatesOutput, AWSError>;
/**
* Removes the specified tags from the specified Elastic Load Balancing resource. To list the current tags for your resources, use DescribeTags.
*/
removeTags(params: ELBv2.Types.RemoveTagsInput, callback?: (err: AWSError, data: ELBv2.Types.RemoveTagsOutput) => void): Request<ELBv2.Types.RemoveTagsOutput, AWSError>;
/**
* Removes the specified tags from the specified Elastic Load Balancing resource. To list the current tags for your resources, use DescribeTags.
*/
removeTags(callback?: (err: AWSError, data: ELBv2.Types.RemoveTagsOutput) => void): Request<ELBv2.Types.RemoveTagsOutput, AWSError>;
/**
* Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.
*/
setIpAddressType(params: ELBv2.Types.SetIpAddressTypeInput, callback?: (err: AWSError, data: ELBv2.Types.SetIpAddressTypeOutput) => void): Request<ELBv2.Types.SetIpAddressTypeOutput, AWSError>;
/**
* Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.
*/
setIpAddressType(callback?: (err: AWSError, data: ELBv2.Types.SetIpAddressTypeOutput) => void): Request<ELBv2.Types.SetIpAddressTypeOutput, AWSError>;
/**
* Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
*/
setRulePriorities(params: ELBv2.Types.SetRulePrioritiesInput, callback?: (err: AWSError, data: ELBv2.Types.SetRulePrioritiesOutput) => void): Request<ELBv2.Types.SetRulePrioritiesOutput, AWSError>;
/**
* Sets the priorities of the specified rules. You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.
*/
setRulePriorities(callback?: (err: AWSError, data: ELBv2.Types.SetRulePrioritiesOutput) => void): Request<ELBv2.Types.SetRulePrioritiesOutput, AWSError>;
/**
* Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer.
*/
setSecurityGroups(params: ELBv2.Types.SetSecurityGroupsInput, callback?: (err: AWSError, data: ELBv2.Types.SetSecurityGroupsOutput) => void): Request<ELBv2.Types.SetSecurityGroupsOutput, AWSError>;
/**
* Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups. You can't specify a security group for a Network Load Balancer.
*/
setSecurityGroups(callback?: (err: AWSError, data: ELBv2.Types.SetSecurityGroupsOutput) => void): Request<ELBv2.Types.SetSecurityGroupsOutput, AWSError>;
/**
* Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets. You can't change the subnets for a Network Load Balancer.
*/
setSubnets(params: ELBv2.Types.SetSubnetsInput, callback?: (err: AWSError, data: ELBv2.Types.SetSubnetsOutput) => void): Request<ELBv2.Types.SetSubnetsOutput, AWSError>;
/**
* Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets. You can't change the subnets for a Network Load Balancer.
*/
setSubnets(callback?: (err: AWSError, data: ELBv2.Types.SetSubnetsOutput) => void): Request<ELBv2.Types.SetSubnetsOutput, AWSError>;
/**
* Waits for the loadBalancerExists state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "loadBalancerExists", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Waits for the loadBalancerExists state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "loadBalancerExists", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Waits for the loadBalancerAvailable state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "loadBalancerAvailable", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Waits for the loadBalancerAvailable state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "loadBalancerAvailable", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Waits for the loadBalancersDeleted state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "loadBalancersDeleted", params: ELBv2.Types.DescribeLoadBalancersInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Waits for the loadBalancersDeleted state by periodically calling the underlying ELBv2.describeLoadBalancersoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "loadBalancersDeleted", callback?: (err: AWSError, data: ELBv2.Types.DescribeLoadBalancersOutput) => void): Request<ELBv2.Types.DescribeLoadBalancersOutput, AWSError>;
/**
* Waits for the targetInService state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "targetInService", params: ELBv2.Types.DescribeTargetHealthInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>;
/**
* Waits for the targetInService state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "targetInService", callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>;
/**
* Waits for the targetDeregistered state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "targetDeregistered", params: ELBv2.Types.DescribeTargetHealthInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>;
/**
* Waits for the targetDeregistered state by periodically calling the underlying ELBv2.describeTargetHealthoperation every 15 seconds (at most 40 times).
*/
waitFor(state: "targetDeregistered", callback?: (err: AWSError, data: ELBv2.Types.DescribeTargetHealthOutput) => void): Request<ELBv2.Types.DescribeTargetHealthOutput, AWSError>;
}
declare namespace ELBv2 {
export interface Action {
/**
* The type of action.
*/
Type: ActionTypeEnum;
/**
* The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.
*/
TargetGroupArn?: TargetGroupArn;
/**
* [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.
*/
AuthenticateOidcConfig?: AuthenticateOidcActionConfig;
/**
* [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.
*/
AuthenticateCognitoConfig?: AuthenticateCognitoActionConfig;
/**
* The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The last action to be performed must be one of the following types of actions: a forward, fixed-response, or redirect.
*/
Order?: ActionOrder;
/**
* [Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.
*/
RedirectConfig?: RedirectActionConfig;
/**
* [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.
*/
FixedResponseConfig?: FixedResponseActionConfig;
}
export type ActionOrder = number;
export type ActionTypeEnum = "forward"|"authenticate-oidc"|"authenticate-cognito"|"redirect"|"fixed-response"|string;
export type Actions = Action[];
export interface AddListenerCertificatesInput {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn: ListenerArn;
/**
* The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.
*/
Certificates: CertificateList;
}
export interface AddListenerCertificatesOutput {
/**
* Information about the certificates in the certificate list.
*/
Certificates?: CertificateList;
}
export interface AddTagsInput {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArns: ResourceArns;
/**
* The tags. Each resource can have a maximum of 10 tags.
*/
Tags: TagList;
}
export interface AddTagsOutput {
}
export type AllocationId = string;
export type AuthenticateCognitoActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateCognitoActionAuthenticationRequestParamValue};
export type AuthenticateCognitoActionAuthenticationRequestParamName = string;
export type AuthenticateCognitoActionAuthenticationRequestParamValue = string;
export type AuthenticateCognitoActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string;
export interface AuthenticateCognitoActionConfig {
/**
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*/
UserPoolArn: AuthenticateCognitoActionUserPoolArn;
/**
* The ID of the Amazon Cognito user pool client.
*/
UserPoolClientId: AuthenticateCognitoActionUserPoolClientId;
/**
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*/
UserPoolDomain: AuthenticateCognitoActionUserPoolDomain;
/**
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*/
SessionCookieName?: AuthenticateCognitoActionSessionCookieName;
/**
* The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
*/
Scope?: AuthenticateCognitoActionScope;
/**
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*/
SessionTimeout?: AuthenticateCognitoActionSessionTimeout;
/**
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*/
AuthenticationRequestExtraParams?: AuthenticateCognitoActionAuthenticationRequestExtraParams;
/**
* The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
*/
OnUnauthenticatedRequest?: AuthenticateCognitoActionConditionalBehaviorEnum;
}
export type AuthenticateCognitoActionScope = string;
export type AuthenticateCognitoActionSessionCookieName = string;
export type AuthenticateCognitoActionSessionTimeout = number;
export type AuthenticateCognitoActionUserPoolArn = string;
export type AuthenticateCognitoActionUserPoolClientId = string;
export type AuthenticateCognitoActionUserPoolDomain = string;
export type AuthenticateOidcActionAuthenticationRequestExtraParams = {[key: string]: AuthenticateOidcActionAuthenticationRequestParamValue};
export type AuthenticateOidcActionAuthenticationRequestParamName = string;
export type AuthenticateOidcActionAuthenticationRequestParamValue = string;
export type AuthenticateOidcActionAuthorizationEndpoint = string;
export type AuthenticateOidcActionClientId = string;
export type AuthenticateOidcActionClientSecret = string;
export type AuthenticateOidcActionConditionalBehaviorEnum = "deny"|"allow"|"authenticate"|string;
export interface AuthenticateOidcActionConfig {
/**
* The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*/
Issuer: AuthenticateOidcActionIssuer;
/**
* The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*/
AuthorizationEndpoint: AuthenticateOidcActionAuthorizationEndpoint;
/**
* The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*/
TokenEndpoint: AuthenticateOidcActionTokenEndpoint;
/**
* The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
*/
UserInfoEndpoint: AuthenticateOidcActionUserInfoEndpoint;
/**
* The OAuth 2.0 client identifier.
*/
ClientId: AuthenticateOidcActionClientId;
/**
* The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
*/
ClientSecret?: AuthenticateOidcActionClientSecret;
/**
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*/
SessionCookieName?: AuthenticateOidcActionSessionCookieName;
/**
* The set of user claims to be requested from the IdP. The default is openid. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
*/
Scope?: AuthenticateOidcActionScope;
/**
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*/
SessionTimeout?: AuthenticateOidcActionSessionTimeout;
/**
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*/
AuthenticationRequestExtraParams?: AuthenticateOidcActionAuthenticationRequestExtraParams;
/**
* The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
*/
OnUnauthenticatedRequest?: AuthenticateOidcActionConditionalBehaviorEnum;
/**
* Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
*/
UseExistingClientSecret?: AuthenticateOidcActionUseExistingClientSecret;
}
export type AuthenticateOidcActionIssuer = string;
export type AuthenticateOidcActionScope = string;
export type AuthenticateOidcActionSessionCookieName = string;
export type AuthenticateOidcActionSessionTimeout = number;
export type AuthenticateOidcActionTokenEndpoint = string;
export type AuthenticateOidcActionUseExistingClientSecret = boolean;
export type AuthenticateOidcActionUserInfoEndpoint = string;
export interface AvailabilityZone {
/**
* The name of the Availability Zone.
*/
ZoneName?: ZoneName;
/**
* The ID of the subnet. You can specify one subnet per Availability Zone.
*/
SubnetId?: SubnetId;
/**
* [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create the load balancer.
*/
LoadBalancerAddresses?: LoadBalancerAddresses;
}
export type AvailabilityZones = AvailabilityZone[];
export type CanonicalHostedZoneId = string;
export interface Certificate {
/**
* The Amazon Resource Name (ARN) of the certificate.
*/
CertificateArn?: CertificateArn;
/**
* Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.
*/
IsDefault?: Default;
}
export type CertificateArn = string;
export type CertificateList = Certificate[];
export interface Cipher {
/**
* The name of the cipher.
*/
Name?: CipherName;
/**
* The priority of the cipher.
*/
Priority?: CipherPriority;
}
export type CipherName = string;
export type CipherPriority = number;
export type Ciphers = Cipher[];
export type ConditionFieldName = string;
export interface CreateListenerInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
/**
* The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP.
*/
Protocol: ProtocolEnum;
/**
* The port on which the load balancer is listening.
*/
Port: Port;
/**
* [HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
*/
SslPolicy?: SslPolicyName;
/**
* [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault. To create a certificate list for the listener, use AddListenerCertificates.
*/
Certificates?: CertificateList;
/**
* The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
*/
DefaultActions: Actions;
}
export interface CreateListenerOutput {
/**
* Information about the listener.
*/
Listeners?: Listeners;
}
export interface CreateLoadBalancerInput {
/**
* The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
*/
Name: LoadBalancerName;
/**
* The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones.
*/
Subnets?: Subnets;
/**
* The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer.
*/
SubnetMappings?: SubnetMappings;
/**
* [Application Load Balancers] The IDs of the security groups for the load balancer.
*/
SecurityGroups?: SecurityGroups;
/**
* The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer.
*/
Scheme?: LoadBalancerSchemeEnum;
/**
* One or more tags to assign to the load balancer.
*/
Tags?: TagList;
/**
* The type of load balancer. The default is application.
*/
Type?: LoadBalancerTypeEnum;
/**
* [Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.
*/
IpAddressType?: IpAddressType;
}
export interface CreateLoadBalancerOutput {
/**
* Information about the load balancer.
*/
LoadBalancers?: LoadBalancers;
}
export interface CreateRuleInput {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn: ListenerArn;
/**
* The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
*/
Conditions: RuleConditionList;
/**
* The rule priority. A listener can't have multiple rules with the same priority.
*/
Priority: RulePriority;
/**
* The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
*/
Actions: Actions;
}
export interface CreateRuleOutput {
/**
* Information about the rule.
*/
Rules?: Rules;
}
export interface CreateTargetGroupInput {
/**
* The name of the target group. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
*/
Name: TargetGroupName;
/**
* The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.
*/
Protocol?: ProtocolEnum;
/**
* The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply.
*/
Port?: Port;
/**
* The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.
*/
VpcId?: VpcId;
/**
* The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.
*/
HealthCheckProtocol?: ProtocolEnum;
/**
* The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.
*/
HealthCheckPort?: HealthCheckPort;
/**
* Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled.
*/
HealthCheckEnabled?: HealthCheckEnabled;
/**
* [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.
*/
HealthCheckPath?: Path;
/**
* The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.
*/
HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
/**
* The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.
*/
HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds;
/**
* The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5.
*/
HealthyThresholdCount?: HealthCheckThresholdCount;
/**
* The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.
*/
UnhealthyThresholdCount?: HealthCheckThresholdCount;
/**
* [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
*/
Matcher?: Matcher;
/**
* The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. instance - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance. ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses. lambda - The target groups contains a single Lambda function.
*/
TargetType?: TargetTypeEnum;
}
export interface CreateTargetGroupOutput {
/**
* Information about the target group.
*/
TargetGroups?: TargetGroups;
}
export type CreatedTime = Date;
export type DNSName = string;
export type Default = boolean;
export interface DeleteListenerInput {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn: ListenerArn;
}
export interface DeleteListenerOutput {
}
export interface DeleteLoadBalancerInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
}
export interface DeleteLoadBalancerOutput {
}
export interface DeleteRuleInput {
/**
* The Amazon Resource Name (ARN) of the rule.
*/
RuleArn: RuleArn;
}
export interface DeleteRuleOutput {
}
export interface DeleteTargetGroupInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
}
export interface DeleteTargetGroupOutput {
}
export interface DeregisterTargetsInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
/**
* The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.
*/
Targets: TargetDescriptions;
}
export interface DeregisterTargetsOutput {
}
export interface DescribeAccountLimitsInput {
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeAccountLimitsOutput {
/**
* Information about the limits.
*/
Limits?: Limits;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeListenerCertificatesInput {
/**
* The Amazon Resource Names (ARN) of the listener.
*/
ListenerArn: ListenerArn;
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeListenerCertificatesOutput {
/**
* Information about the certificates.
*/
Certificates?: CertificateList;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeListenersInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn?: LoadBalancerArn;
/**
* The Amazon Resource Names (ARN) of the listeners.
*/
ListenerArns?: ListenerArns;
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeListenersOutput {
/**
* Information about the listeners.
*/
Listeners?: Listeners;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeLoadBalancerAttributesInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
}
export interface DescribeLoadBalancerAttributesOutput {
/**
* Information about the load balancer attributes.
*/
Attributes?: LoadBalancerAttributes;
}
export interface DescribeLoadBalancersInput {
/**
* The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
*/
LoadBalancerArns?: LoadBalancerArns;
/**
* The names of the load balancers.
*/
Names?: LoadBalancerNames;
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeLoadBalancersOutput {
/**
* Information about the load balancers.
*/
LoadBalancers?: LoadBalancers;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeRulesInput {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn?: ListenerArn;
/**
* The Amazon Resource Names (ARN) of the rules.
*/
RuleArns?: RuleArns;
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeRulesOutput {
/**
* Information about the rules.
*/
Rules?: Rules;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeSSLPoliciesInput {
/**
* The names of the policies.
*/
Names?: SslPolicyNames;
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeSSLPoliciesOutput {
/**
* Information about the policies.
*/
SslPolicies?: SslPolicies;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeTagsInput {
/**
* The Amazon Resource Names (ARN) of the resources.
*/
ResourceArns: ResourceArns;
}
export interface DescribeTagsOutput {
/**
* Information about the tags.
*/
TagDescriptions?: TagDescriptions;
}
export interface DescribeTargetGroupAttributesInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
}
export interface DescribeTargetGroupAttributesOutput {
/**
* Information about the target group attributes
*/
Attributes?: TargetGroupAttributes;
}
export interface DescribeTargetGroupsInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn?: LoadBalancerArn;
/**
* The Amazon Resource Names (ARN) of the target groups.
*/
TargetGroupArns?: TargetGroupArns;
/**
* The names of the target groups.
*/
Names?: TargetGroupNames;
/**
* The marker for the next set of results. (You received this marker from a previous call.)
*/
Marker?: Marker;
/**
* The maximum number of results to return with this call.
*/
PageSize?: PageSize;
}
export interface DescribeTargetGroupsOutput {
/**
* Information about the target groups.
*/
TargetGroups?: TargetGroups;
/**
* If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
*/
NextMarker?: Marker;
}
export interface DescribeTargetHealthInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
/**
* The targets.
*/
Targets?: TargetDescriptions;
}
export interface DescribeTargetHealthOutput {
/**
* Information about the health of the targets.
*/
TargetHealthDescriptions?: TargetHealthDescriptions;
}
export type Description = string;
export interface FixedResponseActionConfig {
/**
* The message.
*/
MessageBody?: FixedResponseActionMessage;
/**
* The HTTP response code (2XX, 4XX, or 5XX).
*/
StatusCode: FixedResponseActionStatusCode;
/**
* The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json
*/
ContentType?: FixedResponseActionContentType;
}
export type FixedResponseActionContentType = string;
export type FixedResponseActionMessage = string;
export type FixedResponseActionStatusCode = string;
export type HealthCheckEnabled = boolean;
export type HealthCheckIntervalSeconds = number;
export type HealthCheckPort = string;
export type HealthCheckThresholdCount = number;
export type HealthCheckTimeoutSeconds = number;
export interface HostHeaderConditionConfig {
/**
* One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
*/
Values?: ListOfString;
}
export type HttpCode = string;
export interface HttpHeaderConditionConfig {
/**
* The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported. You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.
*/
HttpHeaderName?: HttpHeaderConditionName;
/**
* One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If the same header appears multiple times in the request, we search them in order until a match is found. If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
*/
Values?: ListOfString;
}
export type HttpHeaderConditionName = string;
export interface HttpRequestMethodConditionConfig {
/**
* The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match. If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
*/
Values?: ListOfString;
}
export type IpAddress = string;
export type IpAddressType = "ipv4"|"dualstack"|string;
export type IsDefault = boolean;
export interface Limit {
/**
* The name of the limit. The possible values are: application-load-balancers listeners-per-application-load-balancer listeners-per-network-load-balancer network-load-balancers rules-per-application-load-balancer target-groups targets-per-application-load-balancer targets-per-availability-zone-per-network-load-balancer targets-per-network-load-balancer
*/
Name?: Name;
/**
* The maximum value of the limit.
*/
Max?: Max;
}
export type Limits = Limit[];
export type ListOfString = StringValue[];
export interface Listener {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn?: ListenerArn;
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn?: LoadBalancerArn;
/**
* The port on which the load balancer is listening.
*/
Port?: Port;
/**
* The protocol for connections from clients to the load balancer.
*/
Protocol?: ProtocolEnum;
/**
* [HTTPS or TLS listener] The default certificate for the listener.
*/
Certificates?: CertificateList;
/**
* [HTTPS or TLS listener] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
*/
SslPolicy?: SslPolicyName;
/**
* The default actions for the listener.
*/
DefaultActions?: Actions;
}
export type ListenerArn = string;
export type ListenerArns = ListenerArn[];
export type Listeners = Listener[];
export interface LoadBalancer {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn?: LoadBalancerArn;
/**
* The public DNS name of the load balancer.
*/
DNSName?: DNSName;
/**
* The ID of the Amazon Route 53 hosted zone associated with the load balancer.
*/
CanonicalHostedZoneId?: CanonicalHostedZoneId;
/**
* The date and time the load balancer was created.
*/
CreatedTime?: CreatedTime;
/**
* The name of the load balancer.
*/
LoadBalancerName?: LoadBalancerName;
/**
* The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
*/
Scheme?: LoadBalancerSchemeEnum;
/**
* The ID of the VPC for the load balancer.
*/
VpcId?: VpcId;
/**
* The state of the load balancer.
*/
State?: LoadBalancerState;
/**
* The type of load balancer.
*/
Type?: LoadBalancerTypeEnum;
/**
* The Availability Zones for the load balancer.
*/
AvailabilityZones?: AvailabilityZones;
/**
* The IDs of the security groups for the load balancer.
*/
SecurityGroups?: SecurityGroups;
/**
* The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
*/
IpAddressType?: IpAddressType;
}
export interface LoadBalancerAddress {
/**
* The static IP address.
*/
IpAddress?: IpAddress;
/**
* [Network Load Balancers] The allocation ID of the Elastic IP address.
*/
AllocationId?: AllocationId;
}
export type LoadBalancerAddresses = LoadBalancerAddress[];
export type LoadBalancerArn = string;
export type LoadBalancerArns = LoadBalancerArn[];
export interface LoadBalancerAttribute {
/**
* The name of the attribute. The following attributes are supported by both Application Load Balancers and Network Load Balancers: access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false. access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs. deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false. The following attributes are supported by only Application Load Balancers: idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false. routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. The following attributes are supported by only Network Load Balancers: load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false.
*/
Key?: LoadBalancerAttributeKey;
/**
* The value of the attribute.
*/
Value?: LoadBalancerAttributeValue;
}
export type LoadBalancerAttributeKey = string;
export type LoadBalancerAttributeValue = string;
export type LoadBalancerAttributes = LoadBalancerAttribute[];
export type LoadBalancerName = string;
export type LoadBalancerNames = LoadBalancerName[];
export type LoadBalancerSchemeEnum = "internet-facing"|"internal"|string;
export interface LoadBalancerState {
/**
* The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If the load balancer could not be set up, its state is failed.
*/
Code?: LoadBalancerStateEnum;
/**
* A description of the state.
*/
Reason?: StateReason;
}
export type LoadBalancerStateEnum = "active"|"provisioning"|"active_impaired"|"failed"|string;
export type LoadBalancerTypeEnum = "application"|"network"|string;
export type LoadBalancers = LoadBalancer[];
export type Marker = string;
export interface Matcher {
/**
* The HTTP codes. For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299"). For Network Load Balancers, this is 200–399.
*/
HttpCode: HttpCode;
}
export type Max = string;
export interface ModifyListenerInput {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn: ListenerArn;
/**
* The port for connections from clients to the load balancer.
*/
Port?: Port;
/**
* The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols.
*/
Protocol?: ProtocolEnum;
/**
* [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.
*/
SslPolicy?: SslPolicyName;
/**
* [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault. To create a certificate list, use AddListenerCertificates.
*/
Certificates?: CertificateList;
/**
* The actions for the default rule. The rule must include one forward action or one or more fixed-response actions. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
*/
DefaultActions?: Actions;
}
export interface ModifyListenerOutput {
/**
* Information about the modified listener.
*/
Listeners?: Listeners;
}
export interface ModifyLoadBalancerAttributesInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
/**
* The load balancer attributes.
*/
Attributes: LoadBalancerAttributes;
}
export interface ModifyLoadBalancerAttributesOutput {
/**
* Information about the load balancer attributes.
*/
Attributes?: LoadBalancerAttributes;
}
export interface ModifyRuleInput {
/**
* The Amazon Resource Name (ARN) of the rule.
*/
RuleArn: RuleArn;
/**
* The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
*/
Conditions?: RuleConditionList;
/**
* The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed. If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer. [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant. [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito. [Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another. [Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.
*/
Actions?: Actions;
}
export interface ModifyRuleOutput {
/**
* Information about the modified rule.
*/
Rules?: Rules;
}
export interface ModifyTargetGroupAttributesInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
/**
* The attributes.
*/
Attributes: TargetGroupAttributes;
}
export interface ModifyTargetGroupAttributesOutput {
/**
* Information about the attributes.
*/
Attributes?: TargetGroupAttributes;
}
export interface ModifyTargetGroupInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
/**
* The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks. With Network Load Balancers, you can't modify this setting.
*/
HealthCheckProtocol?: ProtocolEnum;
/**
* The port the load balancer uses when performing health checks on targets.
*/
HealthCheckPort?: HealthCheckPort;
/**
* [HTTP/HTTPS health checks] The ping path that is the destination for the health check request.
*/
HealthCheckPath?: Path;
/**
* Indicates whether health checks are enabled.
*/
HealthCheckEnabled?: HealthCheckEnabled;
/**
* The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. With Network Load Balancers, you can't modify this setting.
*/
HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
/**
* [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check. With Network Load Balancers, you can't modify this setting.
*/
HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds;
/**
* The number of consecutive health checks successes required before considering an unhealthy target healthy.
*/
HealthyThresholdCount?: HealthCheckThresholdCount;
/**
* The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.
*/
UnhealthyThresholdCount?: HealthCheckThresholdCount;
/**
* [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. With Network Load Balancers, you can't modify this setting.
*/
Matcher?: Matcher;
}
export interface ModifyTargetGroupOutput {
/**
* Information about the modified target group.
*/
TargetGroups?: TargetGroups;
}
export type Name = string;
export type PageSize = number;
export type Path = string;
export interface PathPatternConditionConfig {
/**
* One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.
*/
Values?: ListOfString;
}
export type Port = number;
export type ProtocolEnum = "HTTP"|"HTTPS"|"TCP"|"TLS"|"UDP"|"TCP_UDP"|string;
export interface QueryStringConditionConfig {
/**
* One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '\' character. If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.
*/
Values?: QueryStringKeyValuePairList;
}
export interface QueryStringKeyValuePair {
/**
* The key. You can omit the key.
*/
Key?: StringValue;
/**
* The value.
*/
Value?: StringValue;
}
export type QueryStringKeyValuePairList = QueryStringKeyValuePair[];
export interface RedirectActionConfig {
/**
* The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
*/
Protocol?: RedirectActionProtocol;
/**
* The port. You can specify a value from 1 to 65535 or #{port}.
*/
Port?: RedirectActionPort;
/**
* The hostname. This component is not percent-encoded. The hostname can contain #{host}.
*/
Host?: RedirectActionHost;
/**
* The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.
*/
Path?: RedirectActionPath;
/**
* The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it is automatically added. You can specify any of the reserved keywords.
*/
Query?: RedirectActionQuery;
/**
* The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
*/
StatusCode: RedirectActionStatusCodeEnum;
}
export type RedirectActionHost = string;
export type RedirectActionPath = string;
export type RedirectActionPort = string;
export type RedirectActionProtocol = string;
export type RedirectActionQuery = string;
export type RedirectActionStatusCodeEnum = "HTTP_301"|"HTTP_302"|string;
export interface RegisterTargetsInput {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn: TargetGroupArn;
/**
* The targets. To register a target by instance ID, specify the instance ID. To register a target by IP address, specify the IP address. To register a Lambda function, specify the ARN of the Lambda function.
*/
Targets: TargetDescriptions;
}
export interface RegisterTargetsOutput {
}
export interface RemoveListenerCertificatesInput {
/**
* The Amazon Resource Name (ARN) of the listener.
*/
ListenerArn: ListenerArn;
/**
* The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.
*/
Certificates: CertificateList;
}
export interface RemoveListenerCertificatesOutput {
}
export interface RemoveTagsInput {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArns: ResourceArns;
/**
* The tag keys for the tags to remove.
*/
TagKeys: TagKeys;
}
export interface RemoveTagsOutput {
}
export type ResourceArn = string;
export type ResourceArns = ResourceArn[];
export interface Rule {
/**
* The Amazon Resource Name (ARN) of the rule.
*/
RuleArn?: RuleArn;
/**
* The priority.
*/
Priority?: String;
/**
* The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
*/
Conditions?: RuleConditionList;
/**
* The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.
*/
Actions?: Actions;
/**
* Indicates whether this is the default rule.
*/
IsDefault?: IsDefault;
}
export type RuleArn = string;
export type RuleArns = RuleArn[];
export interface RuleCondition {
/**
* The field in the HTTP request. The following are the possible values: http-header http-request-method host-header path-pattern query-string source-ip
*/
Field?: ConditionFieldName;
/**
* The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions. If Field is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. A-Z, a-z, 0-9 - . * (matches 0 or more characters) ? (matches exactly 1 character) If Field is path-pattern, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. A-Z, a-z, 0-9 _ - . $ / ~ " ' @ : + & (using &amp;) * (matches 0 or more characters) ? (matches exactly 1 character)
*/
Values?: ListOfString;
/**
* Information for a host header condition. Specify only when Field is host-header.
*/
HostHeaderConfig?: HostHeaderConditionConfig;
/**
* Information for a path pattern condition. Specify only when Field is path-pattern.
*/
PathPatternConfig?: PathPatternConditionConfig;
/**
* Information for an HTTP header condition. Specify only when Field is http-header.
*/
HttpHeaderConfig?: HttpHeaderConditionConfig;
/**
* Information for a query string condition. Specify only when Field is query-string.
*/
QueryStringConfig?: QueryStringConditionConfig;
/**
* Information for an HTTP method condition. Specify only when Field is http-request-method.
*/
HttpRequestMethodConfig?: HttpRequestMethodConditionConfig;
/**
* Information for a source IP condition. Specify only when Field is source-ip.
*/
SourceIpConfig?: SourceIpConditionConfig;
}
export type RuleConditionList = RuleCondition[];
export type RulePriority = number;
export type RulePriorityList = RulePriorityPair[];
export interface RulePriorityPair {
/**
* The Amazon Resource Name (ARN) of the rule.
*/
RuleArn?: RuleArn;
/**
* The rule priority.
*/
Priority?: RulePriority;
}
export type Rules = Rule[];
export type SecurityGroupId = string;
export type SecurityGroups = SecurityGroupId[];
export interface SetIpAddressTypeInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
/**
* The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. Network Load Balancers must use ipv4.
*/
IpAddressType: IpAddressType;
}
export interface SetIpAddressTypeOutput {
/**
* The IP address type.
*/
IpAddressType?: IpAddressType;
}
export interface SetRulePrioritiesInput {
/**
* The rule priorities.
*/
RulePriorities: RulePriorityList;
}
export interface SetRulePrioritiesOutput {
/**
* Information about the rules.
*/
Rules?: Rules;
}
export interface SetSecurityGroupsInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
/**
* The IDs of the security groups.
*/
SecurityGroups: SecurityGroups;
}
export interface SetSecurityGroupsOutput {
/**
* The IDs of the security groups associated with the load balancer.
*/
SecurityGroupIds?: SecurityGroups;
}
export interface SetSubnetsInput {
/**
* The Amazon Resource Name (ARN) of the load balancer.
*/
LoadBalancerArn: LoadBalancerArn;
/**
* The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
*/
Subnets?: Subnets;
/**
* The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings. You cannot specify Elastic IP addresses for your subnets.
*/
SubnetMappings?: SubnetMappings;
}
export interface SetSubnetsOutput {
/**
* Information about the subnet and Availability Zone.
*/
AvailabilityZones?: AvailabilityZones;
}
export interface SourceIpConditionConfig {
/**
* One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
*/
Values?: ListOfString;
}
export type SslPolicies = SslPolicy[];
export interface SslPolicy {
/**
* The protocols.
*/
SslProtocols?: SslProtocols;
/**
* The ciphers.
*/
Ciphers?: Ciphers;
/**
* The name of the policy.
*/
Name?: SslPolicyName;
}
export type SslPolicyName = string;
export type SslPolicyNames = SslPolicyName[];
export type SslProtocol = string;
export type SslProtocols = SslProtocol[];
export type StateReason = string;
export type String = string;
export type StringValue = string;
export type SubnetId = string;
export interface SubnetMapping {
/**
* The ID of the subnet.
*/
SubnetId?: SubnetId;
/**
* [Network Load Balancers] The allocation ID of the Elastic IP address.
*/
AllocationId?: AllocationId;
}
export type SubnetMappings = SubnetMapping[];
export type Subnets = SubnetId[];
export interface Tag {
/**
* The key of the tag.
*/
Key: TagKey;
/**
* The value of the tag.
*/
Value?: TagValue;
}
export interface TagDescription {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn?: ResourceArn;
/**
* Information about the tags.
*/
Tags?: TagList;
}
export type TagDescriptions = TagDescription[];
export type TagKey = string;
export type TagKeys = TagKey[];
export type TagList = Tag[];
export type TagValue = string;
export interface TargetDescription {
/**
* The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.
*/
Id: TargetId;
/**
* The port on which the target is listening. Not used if the target is a Lambda function.
*/
Port?: Port;
/**
* An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. This parameter is not supported if the target type of the target group is instance. If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required. With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all. If the target type is lambda, this parameter is optional and the only supported value is all.
*/
AvailabilityZone?: ZoneName;
}
export type TargetDescriptions = TargetDescription[];
export interface TargetGroup {
/**
* The Amazon Resource Name (ARN) of the target group.
*/
TargetGroupArn?: TargetGroupArn;
/**
* The name of the target group.
*/
TargetGroupName?: TargetGroupName;
/**
* The protocol to use for routing traffic to the targets.
*/
Protocol?: ProtocolEnum;
/**
* The port on which the targets are listening. Not used if the target is a Lambda function.
*/
Port?: Port;
/**
* The ID of the VPC for the targets.
*/
VpcId?: VpcId;
/**
* The protocol to use to connect with the target.
*/
HealthCheckProtocol?: ProtocolEnum;
/**
* The port to use to connect with the target.
*/
HealthCheckPort?: HealthCheckPort;
/**
* Indicates whether health checks are enabled.
*/
HealthCheckEnabled?: HealthCheckEnabled;
/**
* The approximate amount of time, in seconds, between health checks of an individual target.
*/
HealthCheckIntervalSeconds?: HealthCheckIntervalSeconds;
/**
* The amount of time, in seconds, during which no response means a failed health check.
*/
HealthCheckTimeoutSeconds?: HealthCheckTimeoutSeconds;
/**
* The number of consecutive health checks successes required before considering an unhealthy target healthy.
*/
HealthyThresholdCount?: HealthCheckThresholdCount;
/**
* The number of consecutive health check failures required before considering the target unhealthy.
*/
UnhealthyThresholdCount?: HealthCheckThresholdCount;
/**
* The destination for the health check request.
*/
HealthCheckPath?: Path;
/**
* The HTTP codes to use when checking for a successful response from a target.
*/
Matcher?: Matcher;
/**
* The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
*/
LoadBalancerArns?: LoadBalancerArns;
/**
* The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
*/
TargetType?: TargetTypeEnum;
}
export type TargetGroupArn = string;
export type TargetGroupArns = TargetGroupArn[];
export interface TargetGroupAttribute {
/**
* The name of the attribute. The following attribute is supported by both Application Load Balancers and Network Load Balancers: deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. The following attributes are supported by Application Load Balancers if the target is not a Lambda function: slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default. stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false. stickiness.type - The type of sticky sessions. The possible value is lb_cookie. stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the target is a Lambda function. lambda.multi_value_headers.enabled - Indicates whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. The following attribute is supported only by Network Load Balancers: proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
*/
Key?: TargetGroupAttributeKey;
/**
* The value of the attribute.
*/
Value?: TargetGroupAttributeValue;
}
export type TargetGroupAttributeKey = string;
export type TargetGroupAttributeValue = string;
export type TargetGroupAttributes = TargetGroupAttribute[];
export type TargetGroupName = string;
export type TargetGroupNames = TargetGroupName[];
export type TargetGroups = TargetGroup[];
export interface TargetHealth {
/**
* The state of the target.
*/
State?: TargetHealthStateEnum;
/**
* The reason code. If the target state is healthy, a reason code is not provided. If the target state is initial, the reason code can be one of the following values: Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer. Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status. If the target state is unhealthy, the reason code can be one of the following values: Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers. Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers. Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed. Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers. If the target state is unused, the reason code can be one of the following values: Target.NotRegistered - The target is not registered with the target group. Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer. Target.InvalidState - The target is in the stopped or terminated state. Target.IpUnusable - The target IP address is reserved for use by a load balancer. If the target state is draining, the reason code can be the following value: Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired. If the target state is unavailable, the reason code can be the following value: Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers. Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.
*/
Reason?: TargetHealthReasonEnum;
/**
* A description of the target health that provides additional details. If the state is healthy, a description is not provided.
*/
Description?: Description;
}
export interface TargetHealthDescription {
/**
* The description of the target.
*/
Target?: TargetDescription;
/**
* The port to use to connect with the target.
*/
HealthCheckPort?: HealthCheckPort;
/**
* The health information for the target.
*/
TargetHealth?: TargetHealth;
}
export type TargetHealthDescriptions = TargetHealthDescription[];
export type TargetHealthReasonEnum = "Elb.RegistrationInProgress"|"Elb.InitialHealthChecking"|"Target.ResponseCodeMismatch"|"Target.Timeout"|"Target.FailedHealthChecks"|"Target.NotRegistered"|"Target.NotInUse"|"Target.DeregistrationInProgress"|"Target.InvalidState"|"Target.IpUnusable"|"Target.HealthCheckDisabled"|"Elb.InternalError"|string;
export type TargetHealthStateEnum = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string;
export type TargetId = string;
export type TargetTypeEnum = "instance"|"ip"|"lambda"|string;
export type VpcId = string;
export type ZoneName = 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 = "2015-12-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 ELBv2 client.
*/
export import Types = ELBv2;
}
export = ELBv2;