appmesh.d.ts
67.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class AppMesh extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AppMesh.Types.ClientConfiguration)
config: Config & AppMesh.Types.ClientConfiguration;
/**
* Creates a service mesh. A service mesh is a logical boundary for network traffic between
the services that reside within it.
After you create your service mesh, you can create virtual services, virtual nodes,
virtual routers, and routes to distribute traffic between the applications in your
mesh.
*/
createMesh(params: AppMesh.Types.CreateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request<AppMesh.Types.CreateMeshOutput, AWSError>;
/**
* Creates a service mesh. A service mesh is a logical boundary for network traffic between
the services that reside within it.
After you create your service mesh, you can create virtual services, virtual nodes,
virtual routers, and routes to distribute traffic between the applications in your
mesh.
*/
createMesh(callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request<AppMesh.Types.CreateMeshOutput, AWSError>;
/**
* Creates a route that is associated with a virtual router.
You can use the prefix parameter in your route specification for path-based
routing of requests. For example, if your virtual service name is
my-service.local and you want the route to match requests to
my-service.local/metrics, your prefix should be
/metrics.
If your route matches a request, you can distribute traffic to one or more target
virtual nodes with relative weighting.
*/
createRoute(params: AppMesh.Types.CreateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request<AppMesh.Types.CreateRouteOutput, AWSError>;
/**
* Creates a route that is associated with a virtual router.
You can use the prefix parameter in your route specification for path-based
routing of requests. For example, if your virtual service name is
my-service.local and you want the route to match requests to
my-service.local/metrics, your prefix should be
/metrics.
If your route matches a request, you can distribute traffic to one or more target
virtual nodes with relative weighting.
*/
createRoute(callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request<AppMesh.Types.CreateRouteOutput, AWSError>;
/**
* Creates a virtual node within a service mesh.
A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS
service or a Kubernetes deployment. When you create a virtual node, you can specify the
service discovery information for your task group.
Any inbound traffic that your virtual node expects should be specified as a
listener. Any outbound traffic that your virtual node expects to reach
should be specified as a backend.
The response metadata for your new virtual node contains the arn that is
associated with the virtual node. Set this value (either the full ARN or the truncated
resource name: for example, mesh/default/virtualNode/simpleapp) as the
APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy
proxy container in your task definition or pod spec. This is then mapped to the
node.id and node.cluster Envoy parameters.
If you require your Envoy stats or tracing to use a different name, you can override
the node.cluster value that is set by
APPMESH_VIRTUAL_NODE_NAME with the
APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
*/
createVirtualNode(params: AppMesh.Types.CreateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request<AppMesh.Types.CreateVirtualNodeOutput, AWSError>;
/**
* Creates a virtual node within a service mesh.
A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS
service or a Kubernetes deployment. When you create a virtual node, you can specify the
service discovery information for your task group.
Any inbound traffic that your virtual node expects should be specified as a
listener. Any outbound traffic that your virtual node expects to reach
should be specified as a backend.
The response metadata for your new virtual node contains the arn that is
associated with the virtual node. Set this value (either the full ARN or the truncated
resource name: for example, mesh/default/virtualNode/simpleapp) as the
APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy
proxy container in your task definition or pod spec. This is then mapped to the
node.id and node.cluster Envoy parameters.
If you require your Envoy stats or tracing to use a different name, you can override
the node.cluster value that is set by
APPMESH_VIRTUAL_NODE_NAME with the
APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
*/
createVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request<AppMesh.Types.CreateVirtualNodeOutput, AWSError>;
/**
* Creates a virtual router within a service mesh.
Any inbound traffic that your virtual router expects should be specified as a
listener.
Virtual routers handle traffic for one or more virtual services within your mesh. After
you create your virtual router, create and associate routes for your virtual router that
direct incoming requests to different virtual nodes.
*/
createVirtualRouter(params: AppMesh.Types.CreateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request<AppMesh.Types.CreateVirtualRouterOutput, AWSError>;
/**
* Creates a virtual router within a service mesh.
Any inbound traffic that your virtual router expects should be specified as a
listener.
Virtual routers handle traffic for one or more virtual services within your mesh. After
you create your virtual router, create and associate routes for your virtual router that
direct incoming requests to different virtual nodes.
*/
createVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request<AppMesh.Types.CreateVirtualRouterOutput, AWSError>;
/**
* Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is provided by a virtual node
directly or indirectly by means of a virtual router. Dependent services call your virtual
service by its virtualServiceName, and those requests are routed to the
virtual node or virtual router that is specified as the provider for the virtual
service.
*/
createVirtualService(params: AppMesh.Types.CreateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request<AppMesh.Types.CreateVirtualServiceOutput, AWSError>;
/**
* Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is provided by a virtual node
directly or indirectly by means of a virtual router. Dependent services call your virtual
service by its virtualServiceName, and those requests are routed to the
virtual node or virtual router that is specified as the provider for the virtual
service.
*/
createVirtualService(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request<AppMesh.Types.CreateVirtualServiceOutput, AWSError>;
/**
* Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual
nodes) in the service mesh before you can delete the mesh itself.
*/
deleteMesh(params: AppMesh.Types.DeleteMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request<AppMesh.Types.DeleteMeshOutput, AWSError>;
/**
* Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, and virtual
nodes) in the service mesh before you can delete the mesh itself.
*/
deleteMesh(callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request<AppMesh.Types.DeleteMeshOutput, AWSError>;
/**
* Deletes an existing route.
*/
deleteRoute(params: AppMesh.Types.DeleteRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request<AppMesh.Types.DeleteRouteOutput, AWSError>;
/**
* Deletes an existing route.
*/
deleteRoute(callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request<AppMesh.Types.DeleteRouteOutput, AWSError>;
/**
* Deletes an existing virtual node.
You must delete any virtual services that list a virtual node as a service provider
before you can delete the virtual node itself.
*/
deleteVirtualNode(params: AppMesh.Types.DeleteVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request<AppMesh.Types.DeleteVirtualNodeOutput, AWSError>;
/**
* Deletes an existing virtual node.
You must delete any virtual services that list a virtual node as a service provider
before you can delete the virtual node itself.
*/
deleteVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request<AppMesh.Types.DeleteVirtualNodeOutput, AWSError>;
/**
* Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the
router itself.
*/
deleteVirtualRouter(params: AppMesh.Types.DeleteVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request<AppMesh.Types.DeleteVirtualRouterOutput, AWSError>;
/**
* Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the
router itself.
*/
deleteVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request<AppMesh.Types.DeleteVirtualRouterOutput, AWSError>;
/**
* Deletes an existing virtual service.
*/
deleteVirtualService(params: AppMesh.Types.DeleteVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request<AppMesh.Types.DeleteVirtualServiceOutput, AWSError>;
/**
* Deletes an existing virtual service.
*/
deleteVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request<AppMesh.Types.DeleteVirtualServiceOutput, AWSError>;
/**
* Describes an existing service mesh.
*/
describeMesh(params: AppMesh.Types.DescribeMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request<AppMesh.Types.DescribeMeshOutput, AWSError>;
/**
* Describes an existing service mesh.
*/
describeMesh(callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request<AppMesh.Types.DescribeMeshOutput, AWSError>;
/**
* Describes an existing route.
*/
describeRoute(params: AppMesh.Types.DescribeRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request<AppMesh.Types.DescribeRouteOutput, AWSError>;
/**
* Describes an existing route.
*/
describeRoute(callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request<AppMesh.Types.DescribeRouteOutput, AWSError>;
/**
* Describes an existing virtual node.
*/
describeVirtualNode(params: AppMesh.Types.DescribeVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request<AppMesh.Types.DescribeVirtualNodeOutput, AWSError>;
/**
* Describes an existing virtual node.
*/
describeVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request<AppMesh.Types.DescribeVirtualNodeOutput, AWSError>;
/**
* Describes an existing virtual router.
*/
describeVirtualRouter(params: AppMesh.Types.DescribeVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request<AppMesh.Types.DescribeVirtualRouterOutput, AWSError>;
/**
* Describes an existing virtual router.
*/
describeVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request<AppMesh.Types.DescribeVirtualRouterOutput, AWSError>;
/**
* Describes an existing virtual service.
*/
describeVirtualService(params: AppMesh.Types.DescribeVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request<AppMesh.Types.DescribeVirtualServiceOutput, AWSError>;
/**
* Describes an existing virtual service.
*/
describeVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request<AppMesh.Types.DescribeVirtualServiceOutput, AWSError>;
/**
* Returns a list of existing service meshes.
*/
listMeshes(params: AppMesh.Types.ListMeshesInput, callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request<AppMesh.Types.ListMeshesOutput, AWSError>;
/**
* Returns a list of existing service meshes.
*/
listMeshes(callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request<AppMesh.Types.ListMeshesOutput, AWSError>;
/**
* Returns a list of existing routes in a service mesh.
*/
listRoutes(params: AppMesh.Types.ListRoutesInput, callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request<AppMesh.Types.ListRoutesOutput, AWSError>;
/**
* Returns a list of existing routes in a service mesh.
*/
listRoutes(callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request<AppMesh.Types.ListRoutesOutput, AWSError>;
/**
* List the tags for an App Mesh resource.
*/
listTagsForResource(params: AppMesh.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request<AppMesh.Types.ListTagsForResourceOutput, AWSError>;
/**
* List the tags for an App Mesh resource.
*/
listTagsForResource(callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request<AppMesh.Types.ListTagsForResourceOutput, AWSError>;
/**
* Returns a list of existing virtual nodes.
*/
listVirtualNodes(params: AppMesh.Types.ListVirtualNodesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request<AppMesh.Types.ListVirtualNodesOutput, AWSError>;
/**
* Returns a list of existing virtual nodes.
*/
listVirtualNodes(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request<AppMesh.Types.ListVirtualNodesOutput, AWSError>;
/**
* Returns a list of existing virtual routers in a service mesh.
*/
listVirtualRouters(params: AppMesh.Types.ListVirtualRoutersInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request<AppMesh.Types.ListVirtualRoutersOutput, AWSError>;
/**
* Returns a list of existing virtual routers in a service mesh.
*/
listVirtualRouters(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request<AppMesh.Types.ListVirtualRoutersOutput, AWSError>;
/**
* Returns a list of existing virtual services in a service mesh.
*/
listVirtualServices(params: AppMesh.Types.ListVirtualServicesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request<AppMesh.Types.ListVirtualServicesOutput, AWSError>;
/**
* Returns a list of existing virtual services in a service mesh.
*/
listVirtualServices(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request<AppMesh.Types.ListVirtualServicesOutput, AWSError>;
/**
* Associates the specified tags to a resource with the specified resourceArn.
If existing tags on a resource aren't specified in the request parameters, they aren't
changed. When a resource is deleted, the tags associated with that resource are also
deleted.
*/
tagResource(params: AppMesh.Types.TagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request<AppMesh.Types.TagResourceOutput, AWSError>;
/**
* Associates the specified tags to a resource with the specified resourceArn.
If existing tags on a resource aren't specified in the request parameters, they aren't
changed. When a resource is deleted, the tags associated with that resource are also
deleted.
*/
tagResource(callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request<AppMesh.Types.TagResourceOutput, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(params: AppMesh.Types.UntagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request<AppMesh.Types.UntagResourceOutput, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request<AppMesh.Types.UntagResourceOutput, AWSError>;
/**
* Updates an existing service mesh.
*/
updateMesh(params: AppMesh.Types.UpdateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request<AppMesh.Types.UpdateMeshOutput, AWSError>;
/**
* Updates an existing service mesh.
*/
updateMesh(callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request<AppMesh.Types.UpdateMeshOutput, AWSError>;
/**
* Updates an existing route for a specified service mesh and virtual router.
*/
updateRoute(params: AppMesh.Types.UpdateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request<AppMesh.Types.UpdateRouteOutput, AWSError>;
/**
* Updates an existing route for a specified service mesh and virtual router.
*/
updateRoute(callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request<AppMesh.Types.UpdateRouteOutput, AWSError>;
/**
* Updates an existing virtual node in a specified service mesh.
*/
updateVirtualNode(params: AppMesh.Types.UpdateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request<AppMesh.Types.UpdateVirtualNodeOutput, AWSError>;
/**
* Updates an existing virtual node in a specified service mesh.
*/
updateVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request<AppMesh.Types.UpdateVirtualNodeOutput, AWSError>;
/**
* Updates an existing virtual router in a specified service mesh.
*/
updateVirtualRouter(params: AppMesh.Types.UpdateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request<AppMesh.Types.UpdateVirtualRouterOutput, AWSError>;
/**
* Updates an existing virtual router in a specified service mesh.
*/
updateVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request<AppMesh.Types.UpdateVirtualRouterOutput, AWSError>;
/**
* Updates an existing virtual service in a specified service mesh.
*/
updateVirtualService(params: AppMesh.Types.UpdateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request<AppMesh.Types.UpdateVirtualServiceOutput, AWSError>;
/**
* Updates an existing virtual service in a specified service mesh.
*/
updateVirtualService(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request<AppMesh.Types.UpdateVirtualServiceOutput, AWSError>;
}
declare namespace AppMesh {
export interface VirtualRouterListener {
portMapping: PortMapping;
}
export interface UpdateVirtualNodeInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The new virtual node specification to apply. This overwrites the existing data.
*/
spec: VirtualNodeSpec;
/**
* The name of the virtual node to update.
*/
virtualNodeName: ResourceName;
}
export interface DeleteMeshInput {
/**
* The name of the service mesh to delete.
*/
meshName: ResourceName;
}
export type TcpRetryPolicyEvents = TcpRetryPolicyEvent[];
export interface CreateVirtualServiceInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to create the virtual service in.
*/
meshName: ResourceName;
/**
* The virtual service specification to apply.
*/
spec: VirtualServiceSpec;
/**
* Optional metadata that you can apply to the virtual service to assist with
categorization and organization. Each tag consists of a key and an optional value, both of
which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have
a maximum length of 256 characters.
*/
tags?: TagList;
/**
* The name to use for the virtual service.
*/
virtualServiceName: ServiceName;
}
export type VirtualRouterStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export interface UpdateVirtualRouterInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The new virtual router specification to apply. This overwrites the existing data.
*/
spec: VirtualRouterSpec;
/**
* The name of the virtual router to update.
*/
virtualRouterName: ResourceName;
}
export type TagKeyList = TagKey[];
export interface GrpcRetryPolicy {
/**
* Specify at least one of the valid values.
*/
grpcRetryEvents?: GrpcRetryPolicyEvents;
/**
* Specify at least one of the following values.
server-error – HTTP status codes 500, 501,
502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502,
503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused
stream
*/
httpRetryEvents?: HttpRetryPolicyEvents;
/**
* The maximum number of retry attempts.
*/
maxRetries: MaxRetries;
/**
* An object that represents a duration of time.
*/
perRetryTimeout: Duration;
/**
* Specify a valid value.
*/
tcpRetryEvents?: TcpRetryPolicyEvents;
}
export interface ListTagsForResourceInput {
/**
* The maximum number of tag results returned by ListTagsForResource in
paginated output. When this parameter is used, ListTagsForResource returns
only limit results in a single page along with a nextToken
response element. You can see the remaining results of the initial request by sending
another ListTagsForResource request with the returned nextToken
value. This value can be between 1 and 100. If you don't use
this parameter, ListTagsForResource returns up to 100
results and a nextToken value if applicable.
*/
limit?: TagsLimit;
/**
* The nextToken value returned from a previous paginated
ListTagsForResource request where limit was used and the
results exceeded the value of that parameter. Pagination continues from the end of the
previous results that returned the nextToken value.
*/
nextToken?: String;
/**
* The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
*/
resourceArn: Arn;
}
export interface CreateVirtualNodeOutput {
/**
* The full description of your virtual node following the create call.
*/
virtualNode: VirtualNodeData;
}
export interface Logging {
/**
* The access log configuration for a virtual node.
*/
accessLog?: AccessLog;
}
export type GrpcRetryPolicyEvents = GrpcRetryPolicyEvent[];
export type Long = number;
export interface UpdateVirtualRouterOutput {
/**
* A full description of the virtual router that was updated.
*/
virtualRouter: VirtualRouterData;
}
export interface DescribeMeshOutput {
/**
* The full description of your service mesh.
*/
mesh: MeshData;
}
export interface DeleteVirtualRouterInput {
/**
* The name of the service mesh to delete the virtual router in.
*/
meshName: ResourceName;
/**
* The name of the virtual router to delete.
*/
virtualRouterName: ResourceName;
}
export interface ListVirtualRoutersOutput {
/**
* The nextToken value to include in a future ListVirtualRouters
request. When the results of a ListVirtualRouters request exceed
limit, you can use this value to retrieve the next page of results. This
value is null when there are no more results to return.
*/
nextToken?: String;
/**
* The list of existing virtual routers for the specified service mesh.
*/
virtualRouters: VirtualRouterList;
}
export interface DescribeRouteInput {
/**
* The name of the service mesh that the route resides in.
*/
meshName: ResourceName;
/**
* The name of the route to describe.
*/
routeName: ResourceName;
/**
* The name of the virtual router that the route is associated with.
*/
virtualRouterName: ResourceName;
}
export interface DeleteRouteOutput {
/**
* The route that was deleted.
*/
route: RouteData;
}
export interface ResourceMetadata {
/**
* The full Amazon Resource Name (ARN) for the resource.
*/
arn: Arn;
/**
* The Unix epoch timestamp in seconds for when the resource was created.
*/
createdAt: Timestamp;
/**
* The Unix epoch timestamp in seconds for when the resource was last updated.
*/
lastUpdatedAt: Timestamp;
/**
* The unique identifier for the resource.
*/
uid: String;
/**
* The version of the resource. Resources are created at version 1, and this version is
incremented each time that they're updated.
*/
version: Long;
}
export type Listeners = Listener[];
export type Backends = Backend[];
export type PortProtocol = "grpc"|"http"|"http2"|"tcp"|string;
export interface UpdateVirtualNodeOutput {
/**
* A full description of the virtual node that was updated.
*/
virtualNode: VirtualNodeData;
}
export interface ListRoutesOutput {
/**
* The nextToken value to include in a future ListRoutes request.
When the results of a ListRoutes request exceed limit, you can
use this value to retrieve the next page of results. This value is null when
there are no more results to return.
*/
nextToken?: String;
/**
* The list of existing routes for the specified service mesh and virtual router.
*/
routes: RouteList;
}
export interface VirtualServiceBackend {
/**
* The name of the virtual service that is acting as a virtual node backend.
*/
virtualServiceName: ServiceName;
}
export type VirtualNodeStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export type ServiceName = string;
export interface UpdateVirtualServiceInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
/**
* The new virtual service specification to apply. This overwrites the existing
data.
*/
spec: VirtualServiceSpec;
/**
* The name of the virtual service to update.
*/
virtualServiceName: ServiceName;
}
export type HealthCheckThreshold = number;
export interface UpdateRouteOutput {
/**
* A full description of the route that was updated.
*/
route: RouteData;
}
export type PercentInt = number;
export type GrpcRouteMetadataList = GrpcRouteMetadata[];
export type MethodName = string;
export type TagValue = string;
export interface HttpRouteAction {
/**
* An object that represents the targets that traffic is routed to when a request matches the route.
*/
weightedTargets: WeightedTargets;
}
export interface ListRoutesInput {
/**
* The maximum number of results returned by ListRoutes in paginated output.
When you use this parameter, ListRoutes returns only limit
results in a single page along with a nextToken response element. You can see
the remaining results of the initial request by sending another ListRoutes
request with the returned nextToken value. This value can be between
1 and 100. If you don't use this parameter,
ListRoutes returns up to 100 results and a
nextToken value if applicable.
*/
limit?: ListRoutesLimit;
/**
* The name of the service mesh to list routes in.
*/
meshName: ResourceName;
/**
* The nextToken value returned from a previous paginated
ListRoutes request where limit was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous
results that returned the nextToken value.
*/
nextToken?: String;
/**
* The name of the virtual router to list routes in.
*/
virtualRouterName: ResourceName;
}
export interface HealthCheckPolicy {
/**
* The number of consecutive successful health checks that must occur before declaring
listener healthy.
*/
healthyThreshold: HealthCheckThreshold;
/**
* The time period in milliseconds between each health check execution.
*/
intervalMillis: HealthCheckIntervalMillis;
/**
* The destination path for the health check request. This is required only if the
specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
*/
path?: String;
/**
* The destination port for the health check request. This port must match the port defined
in the PortMapping for the listener.
*/
port?: PortNumber;
/**
* The protocol for the health check request.
*/
protocol: PortProtocol;
/**
* The amount of time to wait when receiving a response from the health check, in
milliseconds.
*/
timeoutMillis: HealthCheckTimeoutMillis;
/**
* The number of consecutive failed health checks that must occur before declaring a
virtual node unhealthy.
*/
unhealthyThreshold: HealthCheckThreshold;
}
export interface VirtualServiceRef {
/**
* The full Amazon Resource Name (ARN) for the virtual service.
*/
arn: Arn;
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual service.
*/
virtualServiceName: ServiceName;
}
export interface EgressFilter {
/**
* The egress filter type. By default, the type is DROP_ALL, which allows
egress only from virtual nodes to other defined resources in the service mesh (and any
traffic to *.amazonaws.com for AWS API calls). You can set the egress filter
type to ALLOW_ALL to allow egress to any endpoint inside or outside of the
service mesh.
*/
type: EgressFilterType;
}
export type VirtualServiceList = VirtualServiceRef[];
export interface VirtualNodeStatus {
/**
* The current status of the virtual node.
*/
status: VirtualNodeStatusCode;
}
export interface VirtualRouterRef {
/**
* The full Amazon Resource Name (ARN) for the virtual router.
*/
arn: Arn;
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual router.
*/
virtualRouterName: ResourceName;
}
export interface VirtualServiceData {
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
metadata: ResourceMetadata;
/**
* The specifications of the virtual service.
*/
spec: VirtualServiceSpec;
/**
* The current status of the virtual service.
*/
status: VirtualServiceStatus;
/**
* The name of the virtual service.
*/
virtualServiceName: ServiceName;
}
export type Boolean = boolean;
export interface HttpRouteHeader {
/**
* Specify True to match anything except the match criteria. The default value is False.
*/
invert?: Boolean;
/**
* The HeaderMatchMethod object.
*/
match?: HeaderMatchMethod;
/**
* A name for the HTTP header in the client request that will be matched on.
*/
name: HeaderName;
}
export type HttpRetryPolicyEvent = string;
export interface DescribeVirtualServiceOutput {
/**
* The full description of your virtual service.
*/
virtualService: VirtualServiceData;
}
export type FilePath = string;
export type AwsCloudMapInstanceAttributes = AwsCloudMapInstanceAttribute[];
export interface VirtualNodeRef {
/**
* The full Amazon Resource Name (ARN) for the virtual node.
*/
arn: Arn;
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual node.
*/
virtualNodeName: ResourceName;
}
export interface CreateMeshInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name to use for the service mesh.
*/
meshName: ResourceName;
/**
* The service mesh specification to apply.
*/
spec?: MeshSpec;
/**
* Optional metadata that you can apply to the service mesh to assist with categorization
and organization. Each tag consists of a key and an optional value, both of which you
define. Tag keys can have a maximum character length of 128 characters, and tag values can have
a maximum length of 256 characters.
*/
tags?: TagList;
}
export interface GrpcRouteAction {
/**
* An object that represents the targets that traffic is routed to when a request matches the route.
*/
weightedTargets: WeightedTargets;
}
export interface DescribeVirtualNodeOutput {
/**
* The full description of your virtual node.
*/
virtualNode: VirtualNodeData;
}
export type AwsCloudMapName = string;
export interface UpdateMeshOutput {
mesh: MeshData;
}
export interface CreateRouteOutput {
/**
* The full description of your mesh following the create call.
*/
route: RouteData;
}
export interface GrpcRouteMetadataMatchMethod {
/**
* The value sent by the client must match the specified value exactly.
*/
exact?: HeaderMatch;
/**
* The value sent by the client must begin with the specified characters.
*/
prefix?: HeaderMatch;
/**
* An object that represents the range of values to match on.
*/
range?: MatchRange;
/**
* The value sent by the client must include the specified characters.
*/
regex?: HeaderMatch;
/**
* The value sent by the client must end with the specified characters.
*/
suffix?: HeaderMatch;
}
export interface DnsServiceDiscovery {
/**
* Specifies the DNS service discovery hostname for the virtual node.
*/
hostname: Hostname;
}
export interface DescribeVirtualServiceInput {
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual service to describe.
*/
virtualServiceName: ServiceName;
}
export type ListVirtualServicesLimit = number;
export interface DeleteRouteInput {
/**
* The name of the service mesh to delete the route in.
*/
meshName: ResourceName;
/**
* The name of the route to delete.
*/
routeName: ResourceName;
/**
* The name of the virtual router to delete the route in.
*/
virtualRouterName: ResourceName;
}
export interface VirtualNodeData {
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The associated metadata for the virtual node.
*/
metadata: ResourceMetadata;
/**
* The specifications of the virtual node.
*/
spec: VirtualNodeSpec;
/**
* The current status for the virtual node.
*/
status: VirtualNodeStatus;
/**
* The name of the virtual node.
*/
virtualNodeName: ResourceName;
}
export interface UntagResourceOutput {
}
export interface AwsCloudMapInstanceAttribute {
/**
* The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service
instance that contains the specified key and value is returned.
*/
key: AwsCloudMapInstanceAttributeKey;
/**
* The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service
instance that contains the specified key and value is returned.
*/
value: AwsCloudMapInstanceAttributeValue;
}
export type TcpRetryPolicyEvent = "connection-error"|string;
export interface VirtualServiceSpec {
/**
* The App Mesh object that is acting as the provider for a virtual service. You can specify
a single virtual node or virtual router.
*/
provider?: VirtualServiceProvider;
}
export interface Backend {
/**
* Specifies a virtual service to use as a backend for a virtual node.
*/
virtualService?: VirtualServiceBackend;
}
export interface MatchRange {
/**
* The end of the range.
*/
end: Long;
/**
* The start of the range.
*/
start: Long;
}
export type ListVirtualRoutersLimit = number;
export type HealthCheckIntervalMillis = number;
export type VirtualRouterList = VirtualRouterRef[];
export interface ListMeshesInput {
/**
* The maximum number of results returned by ListMeshes in paginated output.
When you use this parameter, ListMeshes returns only limit
results in a single page along with a nextToken response element. You can see
the remaining results of the initial request by sending another ListMeshes
request with the returned nextToken value. This value can be between
1 and 100. If you don't use this parameter,
ListMeshes returns up to 100 results and a
nextToken value if applicable.
*/
limit?: ListMeshesLimit;
/**
* The nextToken value returned from a previous paginated
ListMeshes request where limit was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous
results that returned the nextToken value.
This token should be treated as an opaque identifier that is used only to
retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: String;
}
export type Arn = string;
export interface TcpRoute {
/**
* The action to take if a match is determined.
*/
action: TcpRouteAction;
}
export type VirtualNodeList = VirtualNodeRef[];
export interface ListVirtualRoutersInput {
/**
* The maximum number of results returned by ListVirtualRouters in paginated
output. When you use this parameter, ListVirtualRouters returns only
limit results in a single page along with a nextToken response
element. You can see the remaining results of the initial request by sending another
ListVirtualRouters request with the returned nextToken value.
This value can be between 1 and 100. If you don't use this
parameter, ListVirtualRouters returns up to 100 results and
a nextToken value if applicable.
*/
limit?: ListVirtualRoutersLimit;
/**
* The name of the service mesh to list virtual routers in.
*/
meshName: ResourceName;
/**
* The nextToken value returned from a previous paginated
ListVirtualRouters request where limit was used and the
results exceeded the value of that parameter. Pagination continues from the end of the
previous results that returned the nextToken value.
*/
nextToken?: String;
}
export interface VirtualRouterData {
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The associated metadata for the virtual router.
*/
metadata: ResourceMetadata;
/**
* The specifications of the virtual router.
*/
spec: VirtualRouterSpec;
/**
* The current status of the virtual router.
*/
status: VirtualRouterStatus;
/**
* The name of the virtual router.
*/
virtualRouterName: ResourceName;
}
export interface UpdateMeshInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to update.
*/
meshName: ResourceName;
/**
* The service mesh specification to apply.
*/
spec?: MeshSpec;
}
export type DurationUnit = "ms"|"s"|string;
export type RoutePriority = number;
export interface ListVirtualServicesInput {
/**
* The maximum number of results returned by ListVirtualServices in paginated
output. When you use this parameter, ListVirtualServices returns only
limit results in a single page along with a nextToken response
element. You can see the remaining results of the initial request by sending another
ListVirtualServices request with the returned nextToken value.
This value can be between 1 and 100. If you don't use this
parameter, ListVirtualServices returns up to 100 results and
a nextToken value if applicable.
*/
limit?: ListVirtualServicesLimit;
/**
* The name of the service mesh to list virtual services in.
*/
meshName: ResourceName;
/**
* The nextToken value returned from a previous paginated
ListVirtualServices request where limit was used and the
results exceeded the value of that parameter. Pagination continues from the end of the
previous results that returned the nextToken value.
*/
nextToken?: String;
}
export interface CreateVirtualRouterInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to create the virtual router in.
*/
meshName: ResourceName;
/**
* The virtual router specification to apply.
*/
spec: VirtualRouterSpec;
/**
* Optional metadata that you can apply to the virtual router to assist with categorization
and organization. Each tag consists of a key and an optional value, both of which you
define. Tag keys can have a maximum character length of 128 characters, and tag values can have
a maximum length of 256 characters.
*/
tags?: TagList;
/**
* The name to use for the virtual router.
*/
virtualRouterName: ResourceName;
}
export interface AccessLog {
/**
* The file object to send virtual node access logs to.
*/
file?: FileAccessLog;
}
export interface ListVirtualNodesInput {
/**
* The maximum number of results returned by ListVirtualNodes in paginated
output. When you use this parameter, ListVirtualNodes returns only
limit results in a single page along with a nextToken response
element. You can see the remaining results of the initial request by sending another
ListVirtualNodes request with the returned nextToken value.
This value can be between 1 and 100. If you don't use this
parameter, ListVirtualNodes returns up to 100 results and a
nextToken value if applicable.
*/
limit?: ListVirtualNodesLimit;
/**
* The name of the service mesh to list virtual nodes in.
*/
meshName: ResourceName;
/**
* The nextToken value returned from a previous paginated
ListVirtualNodes request where limit was used and the results
exceeded the value of that parameter. Pagination continues from the end of the previous
results that returned the nextToken value.
*/
nextToken?: String;
}
export interface DescribeVirtualRouterOutput {
/**
* The full description of your virtual router.
*/
virtualRouter: VirtualRouterData;
}
export interface CreateMeshOutput {
/**
* The full description of your service mesh following the create call.
*/
mesh: MeshData;
}
export interface CreateVirtualRouterOutput {
/**
* The full description of your virtual router following the create call.
*/
virtualRouter: VirtualRouterData;
}
export interface VirtualServiceStatus {
/**
* The current status of the virtual service.
*/
status: VirtualServiceStatusCode;
}
export type HttpRetryPolicyEvents = HttpRetryPolicyEvent[];
export type ListVirtualNodesLimit = number;
export type HealthCheckTimeoutMillis = number;
export type ListMeshesLimit = number;
export type ResourceName = string;
export type AwsCloudMapInstanceAttributeKey = string;
export interface VirtualRouterSpec {
/**
* The listeners that the virtual router is expected to receive inbound traffic from.
You can specify one listener.
*/
listeners?: VirtualRouterListeners;
}
export type Timestamp = Date;
export type HeaderMatch = string;
export interface VirtualNodeSpec {
/**
* The backends that the virtual node is expected to send outbound traffic to.
*/
backends?: Backends;
/**
* The listeners that the virtual node is expected to receive inbound traffic from.
You can specify one listener.
*/
listeners?: Listeners;
/**
* The inbound and outbound access logging information for the virtual node.
*/
logging?: Logging;
/**
* The service discovery information for the virtual node. If your virtual node does not
expect ingress traffic, you can omit this parameter.
*/
serviceDiscovery?: ServiceDiscovery;
}
export interface ListMeshesOutput {
/**
* The list of existing service meshes.
*/
meshes: MeshList;
/**
* The nextToken value to include in a future ListMeshes request.
When the results of a ListMeshes request exceed limit, you can
use this value to retrieve the next page of results. This value is null when
there are no more results to return.
*/
nextToken?: String;
}
export type VirtualRouterListeners = VirtualRouterListener[];
export type HttpMethod = "CONNECT"|"DELETE"|"GET"|"HEAD"|"OPTIONS"|"PATCH"|"POST"|"PUT"|"TRACE"|string;
export interface Duration {
/**
* A unit of time.
*/
unit?: DurationUnit;
/**
* A number of time units.
*/
value?: DurationValue;
}
export interface DescribeRouteOutput {
/**
* The full description of your route.
*/
route: RouteData;
}
export interface HttpRouteMatch {
/**
* An object that represents the client request headers to match on.
*/
headers?: HttpRouteHeaders;
/**
* The client request method to match on. Specify only one.
*/
method?: HttpMethod;
/**
* Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You
can also match for path-based routing of requests. For example, if your virtual service
name is my-service.local and you want the route to match requests to
my-service.local/metrics, your prefix should be
/metrics.
*/
prefix: String;
/**
* The client request scheme to match on. Specify only one.
*/
scheme?: HttpScheme;
}
export type MeshList = MeshRef[];
export interface TagRef {
/**
* One part of a key-value pair that make up a tag. A key is a general label
that acts like a category for more specific tag values.
*/
key: TagKey;
/**
* The optional part of a key-value pair that make up a tag. A value acts as a
descriptor within a tag category (key).
*/
value?: TagValue;
}
export interface MeshRef {
/**
* The full Amazon Resource Name (ARN) of the service mesh.
*/
arn: Arn;
/**
* The name of the service mesh.
*/
meshName: ResourceName;
}
export type MaxRetries = number;
export type MeshStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export interface PortMapping {
/**
* The port used for the port mapping.
*/
port: PortNumber;
/**
* The protocol used for the port mapping. Specify one protocol.
*/
protocol: PortProtocol;
}
export interface MeshData {
/**
* The name of the service mesh.
*/
meshName: ResourceName;
/**
* The associated metadata for the service mesh.
*/
metadata: ResourceMetadata;
/**
* The associated specification for the service mesh.
*/
spec: MeshSpec;
/**
* The status of the service mesh.
*/
status: MeshStatus;
}
export interface VirtualRouterStatus {
/**
* The current status of the virtual router.
*/
status: VirtualRouterStatusCode;
}
export interface ListVirtualServicesOutput {
/**
* The nextToken value to include in a future ListVirtualServices
request. When the results of a ListVirtualServices request exceed
limit, you can use this value to retrieve the next page of results. This
value is null when there are no more results to return.
*/
nextToken?: String;
/**
* The list of existing virtual services for the specified service mesh.
*/
virtualServices: VirtualServiceList;
}
export type AwsCloudMapInstanceAttributeValue = string;
export interface WeightedTarget {
/**
* The virtual node to associate with the weighted target.
*/
virtualNode: ResourceName;
/**
* The relative weight of the weighted target.
*/
weight: PercentInt;
}
export interface TcpRouteAction {
/**
* An object that represents the targets that traffic is routed to when a request matches the route.
*/
weightedTargets: WeightedTargets;
}
export interface DescribeVirtualNodeInput {
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual node to describe.
*/
virtualNodeName: ResourceName;
}
export interface RouteStatus {
/**
* The current status for the route.
*/
status: RouteStatusCode;
}
export interface RouteRef {
/**
* The full Amazon Resource Name (ARN) for the route.
*/
arn: Arn;
/**
* The name of the service mesh that the route resides in.
*/
meshName: ResourceName;
/**
* The name of the route.
*/
routeName: ResourceName;
/**
* The virtual router that the route is associated with.
*/
virtualRouterName: ResourceName;
}
export interface Listener {
/**
* The health check information for the listener.
*/
healthCheck?: HealthCheckPolicy;
/**
* The port mapping information for the listener.
*/
portMapping: PortMapping;
}
export interface GrpcRoute {
/**
* An object that represents the action to take if a match is determined.
*/
action: GrpcRouteAction;
/**
* An object that represents the criteria for determining a request match.
*/
match: GrpcRouteMatch;
/**
* An object that represents a retry policy.
*/
retryPolicy?: GrpcRetryPolicy;
}
export interface DeleteVirtualNodeInput {
/**
* The name of the service mesh to delete the virtual node in.
*/
meshName: ResourceName;
/**
* The name of the virtual node to delete.
*/
virtualNodeName: ResourceName;
}
export interface RouteData {
/**
* The name of the service mesh that the route resides in.
*/
meshName: ResourceName;
/**
* The associated metadata for the route.
*/
metadata: ResourceMetadata;
/**
* The name of the route.
*/
routeName: ResourceName;
/**
* The specifications of the route.
*/
spec: RouteSpec;
/**
* The status of the route.
*/
status: RouteStatus;
/**
* The virtual router that the route is associated with.
*/
virtualRouterName: ResourceName;
}
export type RouteStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export type ListRoutesLimit = number;
export interface DeleteVirtualServiceOutput {
/**
* The virtual service that was deleted.
*/
virtualService: VirtualServiceData;
}
export interface VirtualNodeServiceProvider {
/**
* The name of the virtual node that is acting as a service provider.
*/
virtualNodeName: ResourceName;
}
export type HeaderName = string;
export type TagList = TagRef[];
export type GrpcRetryPolicyEvent = "cancelled"|"deadline-exceeded"|"internal"|"resource-exhausted"|"unavailable"|string;
export interface HttpRetryPolicy {
/**
* Specify at least one of the following values.
server-error – HTTP status codes 500, 501,
502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502,
503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused
stream
*/
httpRetryEvents?: HttpRetryPolicyEvents;
/**
* The maximum number of retry attempts.
*/
maxRetries: MaxRetries;
/**
* An object that represents a duration of time.
*/
perRetryTimeout: Duration;
/**
* Specify a valid value.
*/
tcpRetryEvents?: TcpRetryPolicyEvents;
}
export interface DescribeVirtualRouterInput {
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual router to describe.
*/
virtualRouterName: ResourceName;
}
export interface TagResourceOutput {
}
export type RouteList = RouteRef[];
export interface HeaderMatchMethod {
/**
* The value sent by the client must match the specified value exactly.
*/
exact?: HeaderMatch;
/**
* The value sent by the client must begin with the specified characters.
*/
prefix?: HeaderMatch;
/**
* An object that represents the range of values to match on.
*/
range?: MatchRange;
/**
* The value sent by the client must include the specified characters.
*/
regex?: HeaderMatch;
/**
* The value sent by the client must end with the specified characters.
*/
suffix?: HeaderMatch;
}
export interface DeleteMeshOutput {
/**
* The service mesh that was deleted.
*/
mesh: MeshData;
}
export type EgressFilterType = "ALLOW_ALL"|"DROP_ALL"|string;
export type DurationValue = number;
export type Hostname = string;
export type PortNumber = number;
export interface TagResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource to add tags to.
*/
resourceArn: Arn;
/**
* The tags to add to the resource. A tag is an array of key-value pairs.
Tag keys can have a maximum character length of 128 characters, and tag values can have
a maximum length of 256 characters.
*/
tags: TagList;
}
export interface GrpcRouteMetadata {
/**
* Specify True to match anything except the match criteria. The default value is False.
*/
invert?: Boolean;
/**
* An object that represents the data to match from the request.
*/
match?: GrpcRouteMetadataMatchMethod;
/**
* The name of the route.
*/
name: HeaderName;
}
export interface CreateRouteInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to create the route in.
*/
meshName: ResourceName;
/**
* The name to use for the route.
*/
routeName: ResourceName;
/**
* The route specification to apply.
*/
spec: RouteSpec;
/**
* Optional metadata that you can apply to the route to assist with categorization and
organization. Each tag consists of a key and an optional value, both of which you define.
Tag keys can have a maximum character length of 128 characters, and tag values can have
a maximum length of 256 characters.
*/
tags?: TagList;
/**
* The name of the virtual router in which to create the route.
*/
virtualRouterName: ResourceName;
}
export type WeightedTargets = WeightedTarget[];
export type HttpRouteHeaders = HttpRouteHeader[];
export interface VirtualServiceProvider {
/**
* The virtual node associated with a virtual service.
*/
virtualNode?: VirtualNodeServiceProvider;
/**
* The virtual router associated with a virtual service.
*/
virtualRouter?: VirtualRouterServiceProvider;
}
export interface GrpcRouteMatch {
/**
* An object that represents the data to match from the request.
*/
metadata?: GrpcRouteMetadataList;
/**
* The method name to match from the request. If you specify a name, you must also specify a serviceName.
*/
methodName?: MethodName;
/**
* The fully qualified domain name for the service to match from the request.
*/
serviceName?: ServiceName;
}
export type String = string;
export interface AwsCloudMapServiceDiscovery {
/**
* A string map that contains attributes with values that you can use to filter instances
by any custom attribute that you specified when you registered the instance. Only instances
that match all of the specified key/value pairs will be returned.
*/
attributes?: AwsCloudMapInstanceAttributes;
/**
* The name of the AWS Cloud Map namespace to use.
*/
namespaceName: AwsCloudMapName;
/**
* The name of the AWS Cloud Map service to use.
*/
serviceName: AwsCloudMapName;
}
export type HttpScheme = "http"|"https"|string;
export interface UpdateVirtualServiceOutput {
/**
* A full description of the virtual service that was updated.
*/
virtualService: VirtualServiceData;
}
export interface UpdateRouteInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the route resides in.
*/
meshName: ResourceName;
/**
* The name of the route to update.
*/
routeName: ResourceName;
/**
* The new route specification to apply. This overwrites the existing data.
*/
spec: RouteSpec;
/**
* The name of the virtual router that the route is associated with.
*/
virtualRouterName: ResourceName;
}
export interface MeshStatus {
/**
* The current mesh status.
*/
status?: MeshStatusCode;
}
export interface CreateVirtualNodeInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to create the virtual node in.
*/
meshName: ResourceName;
/**
* The virtual node specification to apply.
*/
spec: VirtualNodeSpec;
/**
* Optional metadata that you can apply to the virtual node to assist with categorization
and organization. Each tag consists of a key and an optional value, both of which you
define. Tag keys can have a maximum character length of 128 characters, and tag values can have
a maximum length of 256 characters.
*/
tags?: TagList;
/**
* The name to use for the virtual node.
*/
virtualNodeName: ResourceName;
}
export interface RouteSpec {
/**
* An object that represents the specification of a GRPC route.
*/
grpcRoute?: GrpcRoute;
/**
* An object that represents the specification of an HTTP2 route.
*/
http2Route?: HttpRoute;
/**
* An object that represents the specification of an HTTP route.
*/
httpRoute?: HttpRoute;
/**
* The priority for the route. Routes are matched based on the specified value, where 0 is
the highest priority.
*/
priority?: RoutePriority;
/**
* An object that represents the specification of a TCP route.
*/
tcpRoute?: TcpRoute;
}
export interface HttpRoute {
/**
* An object that represents the action to take if a match is determined.
*/
action: HttpRouteAction;
/**
* An object that represents the criteria for determining a request match.
*/
match: HttpRouteMatch;
/**
* An object that represents a retry policy.
*/
retryPolicy?: HttpRetryPolicy;
}
export interface DescribeMeshInput {
/**
* The name of the service mesh to describe.
*/
meshName: ResourceName;
}
export interface MeshSpec {
/**
* The egress filter rules for the service mesh.
*/
egressFilter?: EgressFilter;
}
export interface CreateVirtualServiceOutput {
/**
* The full description of your virtual service following the create call.
*/
virtualService: VirtualServiceData;
}
export interface FileAccessLog {
/**
* The file path to write access logs to. You can use /dev/stdout to send
access logs to standard out and configure your Envoy container to use a log driver, such as
awslogs, to export the access logs to a log storage service such as Amazon
CloudWatch Logs. You can also specify a path in the Envoy container's file system to write
the files to disk.
The Envoy process must have write permissions to the path that you specify here.
Otherwise, Envoy fails to bootstrap properly.
*/
path: FilePath;
}
export interface VirtualRouterServiceProvider {
/**
* The name of the virtual router that is acting as a service provider.
*/
virtualRouterName: ResourceName;
}
export interface DeleteVirtualServiceInput {
/**
* The name of the service mesh to delete the virtual service in.
*/
meshName: ResourceName;
/**
* The name of the virtual service to delete.
*/
virtualServiceName: ServiceName;
}
export interface ListTagsForResourceOutput {
/**
* The nextToken value to include in a future ListTagsForResource
request. When the results of a ListTagsForResource request exceed
limit, you can use this value to retrieve the next page of results. This
value is null when there are no more results to return.
*/
nextToken?: String;
/**
* The tags for the resource.
*/
tags: TagList;
}
export interface ServiceDiscovery {
/**
* Specifies any AWS Cloud Map information for the virtual node.
*/
awsCloudMap?: AwsCloudMapServiceDiscovery;
/**
* Specifies the DNS information for the virtual node.
*/
dns?: DnsServiceDiscovery;
}
export interface ListVirtualNodesOutput {
/**
* The nextToken value to include in a future ListVirtualNodes
request. When the results of a ListVirtualNodes request exceed
limit, you can use this value to retrieve the next page of results. This
value is null when there are no more results to return.
*/
nextToken?: String;
/**
* The list of existing virtual nodes for the specified service mesh.
*/
virtualNodes: VirtualNodeList;
}
export interface UntagResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource to delete tags from.
*/
resourceArn: Arn;
/**
* The keys of the tags to be removed.
*/
tagKeys: TagKeyList;
}
export interface DeleteVirtualRouterOutput {
/**
* The virtual router that was deleted.
*/
virtualRouter: VirtualRouterData;
}
export type TagsLimit = number;
export type TagKey = string;
export type VirtualServiceStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export interface DeleteVirtualNodeOutput {
/**
* The virtual node that was deleted.
*/
virtualNode: VirtualNodeData;
}
/**
* 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 = "2018-10-01"|"2018-10-01"|"2019-01-25"|"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 AppMesh client.
*/
export import Types = AppMesh;
}
export = AppMesh;