@aws-sdk/client-app-mesh 3.378.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,10 +6,12 @@ import { AppMeshServiceException as __BaseException } from "./AppMeshServiceExce
6
6
  */
7
7
  export interface JsonFormatRef {
8
8
  /**
9
+ * @public
9
10
  * <p>The specified key for the JSON.</p>
10
11
  */
11
12
  key: string | undefined;
12
13
  /**
14
+ * @public
13
15
  * <p>The specified value for the JSON.</p>
14
16
  */
15
17
  value: string | undefined;
@@ -24,6 +26,7 @@ export type LoggingFormat = LoggingFormat.JsonMember | LoggingFormat.TextMember
24
26
  */
25
27
  export declare namespace LoggingFormat {
26
28
  /**
29
+ * @public
27
30
  * <p/>
28
31
  */
29
32
  interface TextMember {
@@ -32,6 +35,7 @@ export declare namespace LoggingFormat {
32
35
  $unknown?: never;
33
36
  }
34
37
  /**
38
+ * @public
35
39
  * <p/>
36
40
  */
37
41
  interface JsonMember {
@@ -39,6 +43,9 @@ export declare namespace LoggingFormat {
39
43
  json: JsonFormatRef[];
40
44
  $unknown?: never;
41
45
  }
46
+ /**
47
+ * @public
48
+ */
42
49
  interface $UnknownMember {
43
50
  text?: never;
44
51
  json?: never;
@@ -57,6 +64,7 @@ export declare namespace LoggingFormat {
57
64
  */
58
65
  export interface FileAccessLog {
59
66
  /**
67
+ * @public
60
68
  * <p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send
61
69
  * access logs to standard out and configure your Envoy container to use a log driver, such as
62
70
  * <code>awslogs</code>, to export the access logs to a log storage service such as Amazon
@@ -70,6 +78,7 @@ export interface FileAccessLog {
70
78
  */
71
79
  path: string | undefined;
72
80
  /**
81
+ * @public
73
82
  * <p>The specified format for the logs. The format is either <code>json_format</code> or
74
83
  * <code>text_format</code>.</p>
75
84
  */
@@ -85,12 +94,16 @@ export type AccessLog = AccessLog.FileMember | AccessLog.$UnknownMember;
85
94
  */
86
95
  export declare namespace AccessLog {
87
96
  /**
97
+ * @public
88
98
  * <p>The file object to send virtual node access logs to.</p>
89
99
  */
90
100
  interface FileMember {
91
101
  file: FileAccessLog;
92
102
  $unknown?: never;
93
103
  }
104
+ /**
105
+ * @public
106
+ */
94
107
  interface $UnknownMember {
95
108
  file?: never;
96
109
  $unknown: [string, any];
@@ -145,10 +158,12 @@ export declare class InternalServerErrorException extends __BaseException {
145
158
  */
146
159
  export interface ListTagsForResourceInput {
147
160
  /**
161
+ * @public
148
162
  * <p>The Amazon Resource Name (ARN) that identifies the resource to list the tags for.</p>
149
163
  */
150
164
  resourceArn: string | undefined;
151
165
  /**
166
+ * @public
152
167
  * <p>The <code>nextToken</code> value returned from a previous paginated
153
168
  * <code>ListTagsForResource</code> request where <code>limit</code> was used and the
154
169
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -156,6 +171,7 @@ export interface ListTagsForResourceInput {
156
171
  */
157
172
  nextToken?: string;
158
173
  /**
174
+ * @public
159
175
  * <p>The maximum number of tag results returned by <code>ListTagsForResource</code> in
160
176
  * paginated output. When this parameter is used, <code>ListTagsForResource</code> returns
161
177
  * only <code>limit</code> results in a single page along with a <code>nextToken</code>
@@ -176,11 +192,13 @@ export interface ListTagsForResourceInput {
176
192
  */
177
193
  export interface TagRef {
178
194
  /**
195
+ * @public
179
196
  * <p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label
180
197
  * that acts like a category for more specific tag values.</p>
181
198
  */
182
199
  key: string | undefined;
183
200
  /**
201
+ * @public
184
202
  * <p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a
185
203
  * descriptor within a tag category (key).</p>
186
204
  */
@@ -192,10 +210,12 @@ export interface TagRef {
192
210
  */
193
211
  export interface ListTagsForResourceOutput {
194
212
  /**
213
+ * @public
195
214
  * <p>The tags for the resource.</p>
196
215
  */
197
216
  tags: TagRef[] | undefined;
198
217
  /**
218
+ * @public
199
219
  * <p>The <code>nextToken</code> value to include in a future <code>ListTagsForResource</code>
200
220
  * request. When the results of a <code>ListTagsForResource</code> request exceed
201
221
  * <code>limit</code>, you can use this value to retrieve the next page of results. This
@@ -276,6 +296,7 @@ export type EgressFilterType = (typeof EgressFilterType)[keyof typeof EgressFilt
276
296
  */
277
297
  export interface EgressFilter {
278
298
  /**
299
+ * @public
279
300
  * <p>The egress filter type. By default, the type is <code>DROP_ALL</code>, which allows
280
301
  * egress only from virtual nodes to other defined resources in the service mesh (and any
281
302
  * traffic to <code>*.amazonaws.com</code> for Amazon Web Services API calls). You can set the
@@ -304,6 +325,7 @@ export type IpPreference = (typeof IpPreference)[keyof typeof IpPreference];
304
325
  */
305
326
  export interface MeshServiceDiscovery {
306
327
  /**
328
+ * @public
307
329
  * <p>The IP version to use to control traffic within the mesh.</p>
308
330
  */
309
331
  ipPreference?: IpPreference | string;
@@ -314,10 +336,12 @@ export interface MeshServiceDiscovery {
314
336
  */
315
337
  export interface MeshSpec {
316
338
  /**
339
+ * @public
317
340
  * <p>The egress filter rules for the service mesh.</p>
318
341
  */
319
342
  egressFilter?: EgressFilter;
320
343
  /**
344
+ * @public
321
345
  * <p>An object that represents the service discovery information for a service mesh.</p>
322
346
  */
323
347
  serviceDiscovery?: MeshServiceDiscovery;
@@ -328,14 +352,17 @@ export interface MeshSpec {
328
352
  */
329
353
  export interface CreateMeshInput {
330
354
  /**
355
+ * @public
331
356
  * <p>The name to use for the service mesh.</p>
332
357
  */
333
358
  meshName: string | undefined;
334
359
  /**
360
+ * @public
335
361
  * <p>The service mesh specification to apply.</p>
336
362
  */
337
363
  spec?: MeshSpec;
338
364
  /**
365
+ * @public
339
366
  * <p>Optional metadata that you can apply to the service mesh to assist with categorization
340
367
  * and organization. Each tag consists of a key and an optional value, both of which you
341
368
  * define. Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -343,6 +370,7 @@ export interface CreateMeshInput {
343
370
  */
344
371
  tags?: TagRef[];
345
372
  /**
373
+ * @public
346
374
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
347
375
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
348
376
  */
@@ -354,31 +382,38 @@ export interface CreateMeshInput {
354
382
  */
355
383
  export interface ResourceMetadata {
356
384
  /**
385
+ * @public
357
386
  * <p>The full Amazon Resource Name (ARN) for the resource.</p>
358
387
  */
359
388
  arn: string | undefined;
360
389
  /**
390
+ * @public
361
391
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
362
392
  */
363
393
  version: number | undefined;
364
394
  /**
395
+ * @public
365
396
  * <p>The unique identifier for the resource.</p>
366
397
  */
367
398
  uid: string | undefined;
368
399
  /**
400
+ * @public
369
401
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
370
402
  */
371
403
  createdAt: Date | undefined;
372
404
  /**
405
+ * @public
373
406
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
374
407
  */
375
408
  lastUpdatedAt: Date | undefined;
376
409
  /**
410
+ * @public
377
411
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
378
412
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
379
413
  */
380
414
  meshOwner: string | undefined;
381
415
  /**
416
+ * @public
382
417
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
383
418
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
384
419
  */
@@ -403,6 +438,7 @@ export type MeshStatusCode = (typeof MeshStatusCode)[keyof typeof MeshStatusCode
403
438
  */
404
439
  export interface MeshStatus {
405
440
  /**
441
+ * @public
406
442
  * <p>The current mesh status.</p>
407
443
  */
408
444
  status?: MeshStatusCode | string;
@@ -413,18 +449,22 @@ export interface MeshStatus {
413
449
  */
414
450
  export interface MeshData {
415
451
  /**
452
+ * @public
416
453
  * <p>The name of the service mesh.</p>
417
454
  */
418
455
  meshName: string | undefined;
419
456
  /**
457
+ * @public
420
458
  * <p>The associated specification for the service mesh.</p>
421
459
  */
422
460
  spec: MeshSpec | undefined;
423
461
  /**
462
+ * @public
424
463
  * <p>The associated metadata for the service mesh.</p>
425
464
  */
426
465
  metadata: ResourceMetadata | undefined;
427
466
  /**
467
+ * @public
428
468
  * <p>The status of the service mesh.</p>
429
469
  */
430
470
  status: MeshStatus | undefined;
@@ -435,6 +475,7 @@ export interface MeshData {
435
475
  */
436
476
  export interface CreateMeshOutput {
437
477
  /**
478
+ * @public
438
479
  * <p>The full description of your service mesh following the create call.</p>
439
480
  */
440
481
  mesh: MeshData | undefined;
@@ -458,6 +499,7 @@ export declare class LimitExceededException extends __BaseException {
458
499
  */
459
500
  export interface DeleteMeshInput {
460
501
  /**
502
+ * @public
461
503
  * <p>The name of the service mesh to delete.</p>
462
504
  */
463
505
  meshName: string | undefined;
@@ -468,6 +510,7 @@ export interface DeleteMeshInput {
468
510
  */
469
511
  export interface DeleteMeshOutput {
470
512
  /**
513
+ * @public
471
514
  * <p>The service mesh that was deleted.</p>
472
515
  */
473
516
  mesh: MeshData | undefined;
@@ -491,10 +534,12 @@ export declare class ResourceInUseException extends __BaseException {
491
534
  */
492
535
  export interface DescribeMeshInput {
493
536
  /**
537
+ * @public
494
538
  * <p>The name of the service mesh to describe.</p>
495
539
  */
496
540
  meshName: string | undefined;
497
541
  /**
542
+ * @public
498
543
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
499
544
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
500
545
  */
@@ -506,6 +551,7 @@ export interface DescribeMeshInput {
506
551
  */
507
552
  export interface DescribeMeshOutput {
508
553
  /**
554
+ * @public
509
555
  * <p>The full description of your service mesh.</p>
510
556
  */
511
557
  mesh: MeshData | undefined;
@@ -516,6 +562,7 @@ export interface DescribeMeshOutput {
516
562
  */
517
563
  export interface ListMeshesInput {
518
564
  /**
565
+ * @public
519
566
  * <p>The <code>nextToken</code> value returned from a previous paginated
520
567
  * <code>ListMeshes</code> request where <code>limit</code> was used and the results
521
568
  * exceeded the value of that parameter. Pagination continues from the end of the previous
@@ -527,6 +574,7 @@ export interface ListMeshesInput {
527
574
  */
528
575
  nextToken?: string;
529
576
  /**
577
+ * @public
530
578
  * <p>The maximum number of results returned by <code>ListMeshes</code> in paginated output.
531
579
  * When you use this parameter, <code>ListMeshes</code> returns only <code>limit</code>
532
580
  * results in a single page along with a <code>nextToken</code> response element. You can see
@@ -544,32 +592,39 @@ export interface ListMeshesInput {
544
592
  */
545
593
  export interface MeshRef {
546
594
  /**
595
+ * @public
547
596
  * <p>The name of the service mesh.</p>
548
597
  */
549
598
  meshName: string | undefined;
550
599
  /**
600
+ * @public
551
601
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
552
602
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
553
603
  */
554
604
  meshOwner: string | undefined;
555
605
  /**
606
+ * @public
556
607
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
557
608
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
558
609
  */
559
610
  resourceOwner: string | undefined;
560
611
  /**
612
+ * @public
561
613
  * <p>The full Amazon Resource Name (ARN) of the service mesh.</p>
562
614
  */
563
615
  arn: string | undefined;
564
616
  /**
617
+ * @public
565
618
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
566
619
  */
567
620
  version: number | undefined;
568
621
  /**
622
+ * @public
569
623
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
570
624
  */
571
625
  createdAt: Date | undefined;
572
626
  /**
627
+ * @public
573
628
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
574
629
  */
575
630
  lastUpdatedAt: Date | undefined;
@@ -580,10 +635,12 @@ export interface MeshRef {
580
635
  */
581
636
  export interface ListMeshesOutput {
582
637
  /**
638
+ * @public
583
639
  * <p>The list of existing service meshes.</p>
584
640
  */
585
641
  meshes: MeshRef[] | undefined;
586
642
  /**
643
+ * @public
587
644
  * <p>The <code>nextToken</code> value to include in a future <code>ListMeshes</code> request.
588
645
  * When the results of a <code>ListMeshes</code> request exceed <code>limit</code>, you can
589
646
  * use this value to retrieve the next page of results. This value is <code>null</code> when
@@ -597,14 +654,17 @@ export interface ListMeshesOutput {
597
654
  */
598
655
  export interface UpdateMeshInput {
599
656
  /**
657
+ * @public
600
658
  * <p>The name of the service mesh to update.</p>
601
659
  */
602
660
  meshName: string | undefined;
603
661
  /**
662
+ * @public
604
663
  * <p>The service mesh specification to apply.</p>
605
664
  */
606
665
  spec?: MeshSpec;
607
666
  /**
667
+ * @public
608
668
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
609
669
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
610
670
  */
@@ -616,6 +676,7 @@ export interface UpdateMeshInput {
616
676
  */
617
677
  export interface UpdateMeshOutput {
618
678
  /**
679
+ * @public
619
680
  * <p>An object that represents a service mesh returned by a describe operation.</p>
620
681
  */
621
682
  mesh: MeshData | undefined;
@@ -627,10 +688,12 @@ export interface UpdateMeshOutput {
627
688
  */
628
689
  export interface VirtualGatewayListenerTlsFileCertificate {
629
690
  /**
691
+ * @public
630
692
  * <p>The certificate chain for the certificate.</p>
631
693
  */
632
694
  certificateChain: string | undefined;
633
695
  /**
696
+ * @public
634
697
  * <p>The private key for a certificate stored on the file system of the mesh endpoint that
635
698
  * the proxy is running on.</p>
636
699
  */
@@ -645,6 +708,7 @@ export interface VirtualGatewayListenerTlsFileCertificate {
645
708
  */
646
709
  export interface VirtualGatewayListenerTlsSdsCertificate {
647
710
  /**
711
+ * @public
648
712
  * <p>A reference to an object that represents the name of the secret secret requested from
649
713
  * the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or
650
714
  * certificate chain.</p>
@@ -661,6 +725,7 @@ export type VirtualGatewayClientTlsCertificate = VirtualGatewayClientTlsCertific
661
725
  */
662
726
  export declare namespace VirtualGatewayClientTlsCertificate {
663
727
  /**
728
+ * @public
664
729
  * <p>An object that represents a local file certificate. The certificate must meet specific
665
730
  * requirements and you must have proxy authorization enabled. For more information, see
666
731
  * <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html"> Transport Layer Security (TLS)
@@ -672,6 +737,7 @@ export declare namespace VirtualGatewayClientTlsCertificate {
672
737
  $unknown?: never;
673
738
  }
674
739
  /**
740
+ * @public
675
741
  * <p>A reference to an object that represents a virtual gateway's client's Secret Discovery
676
742
  * Service certificate.</p>
677
743
  */
@@ -680,6 +746,9 @@ export declare namespace VirtualGatewayClientTlsCertificate {
680
746
  sds: VirtualGatewayListenerTlsSdsCertificate;
681
747
  $unknown?: never;
682
748
  }
749
+ /**
750
+ * @public
751
+ */
683
752
  interface $UnknownMember {
684
753
  file?: never;
685
754
  sds?: never;
@@ -699,6 +768,7 @@ export declare namespace VirtualGatewayClientTlsCertificate {
699
768
  */
700
769
  export interface SubjectAlternativeNameMatchers {
701
770
  /**
771
+ * @public
702
772
  * <p>The values sent must match the specified values exactly.</p>
703
773
  */
704
774
  exact: string[] | undefined;
@@ -710,6 +780,7 @@ export interface SubjectAlternativeNameMatchers {
710
780
  */
711
781
  export interface SubjectAlternativeNames {
712
782
  /**
783
+ * @public
713
784
  * <p>An object that represents the criteria for determining a SANs match.</p>
714
785
  */
715
786
  match: SubjectAlternativeNameMatchers | undefined;
@@ -721,6 +792,7 @@ export interface SubjectAlternativeNames {
721
792
  */
722
793
  export interface VirtualGatewayTlsValidationContextAcmTrust {
723
794
  /**
795
+ * @public
724
796
  * <p>One or more ACM Amazon Resource Name (ARN)s.</p>
725
797
  */
726
798
  certificateAuthorityArns: string[] | undefined;
@@ -731,6 +803,7 @@ export interface VirtualGatewayTlsValidationContextAcmTrust {
731
803
  */
732
804
  export interface VirtualGatewayTlsValidationContextFileTrust {
733
805
  /**
806
+ * @public
734
807
  * <p>The certificate trust chain for a certificate stored on the file system of the virtual
735
808
  * node that the proxy is running on.</p>
736
809
  */
@@ -746,6 +819,7 @@ export interface VirtualGatewayTlsValidationContextFileTrust {
746
819
  */
747
820
  export interface VirtualGatewayTlsValidationContextSdsTrust {
748
821
  /**
822
+ * @public
749
823
  * <p>A reference to an object that represents the name of the secret for a virtual gateway's
750
824
  * Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>
751
825
  */
@@ -761,6 +835,7 @@ export type VirtualGatewayTlsValidationContextTrust = VirtualGatewayTlsValidatio
761
835
  */
762
836
  export declare namespace VirtualGatewayTlsValidationContextTrust {
763
837
  /**
838
+ * @public
764
839
  * <p>A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.</p>
765
840
  */
766
841
  interface AcmMember {
@@ -770,6 +845,7 @@ export declare namespace VirtualGatewayTlsValidationContextTrust {
770
845
  $unknown?: never;
771
846
  }
772
847
  /**
848
+ * @public
773
849
  * <p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>
774
850
  */
775
851
  interface FileMember {
@@ -779,6 +855,7 @@ export declare namespace VirtualGatewayTlsValidationContextTrust {
779
855
  $unknown?: never;
780
856
  }
781
857
  /**
858
+ * @public
782
859
  * <p>A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery
783
860
  * Service validation context trust.</p>
784
861
  */
@@ -788,6 +865,9 @@ export declare namespace VirtualGatewayTlsValidationContextTrust {
788
865
  sds: VirtualGatewayTlsValidationContextSdsTrust;
789
866
  $unknown?: never;
790
867
  }
868
+ /**
869
+ * @public
870
+ */
791
871
  interface $UnknownMember {
792
872
  acm?: never;
793
873
  file?: never;
@@ -808,11 +888,13 @@ export declare namespace VirtualGatewayTlsValidationContextTrust {
808
888
  */
809
889
  export interface VirtualGatewayTlsValidationContext {
810
890
  /**
891
+ * @public
811
892
  * <p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
812
893
  * certificate.</p>
813
894
  */
814
895
  trust: VirtualGatewayTlsValidationContextTrust | undefined;
815
896
  /**
897
+ * @public
816
898
  * <p>A reference to an object that represents the SANs for a virtual gateway's listener's
817
899
  * Transport Layer Security (TLS) validation context.</p>
818
900
  */
@@ -824,20 +906,24 @@ export interface VirtualGatewayTlsValidationContext {
824
906
  */
825
907
  export interface VirtualGatewayClientPolicyTls {
826
908
  /**
909
+ * @public
827
910
  * <p>Whether the policy is enforced. The default is <code>True</code>, if a value isn't
828
911
  * specified.</p>
829
912
  */
830
913
  enforce?: boolean;
831
914
  /**
915
+ * @public
832
916
  * <p>One or more ports that the policy is enforced for.</p>
833
917
  */
834
918
  ports?: number[];
835
919
  /**
920
+ * @public
836
921
  * <p>A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS)
837
922
  * certificate.</p>
838
923
  */
839
924
  certificate?: VirtualGatewayClientTlsCertificate;
840
925
  /**
926
+ * @public
841
927
  * <p>A reference to an object that represents a Transport Layer Security (TLS) validation context.</p>
842
928
  */
843
929
  validation: VirtualGatewayTlsValidationContext | undefined;
@@ -848,6 +934,7 @@ export interface VirtualGatewayClientPolicyTls {
848
934
  */
849
935
  export interface VirtualGatewayClientPolicy {
850
936
  /**
937
+ * @public
851
938
  * <p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>
852
939
  */
853
940
  tls?: VirtualGatewayClientPolicyTls;
@@ -858,6 +945,7 @@ export interface VirtualGatewayClientPolicy {
858
945
  */
859
946
  export interface VirtualGatewayBackendDefaults {
860
947
  /**
948
+ * @public
861
949
  * <p>A reference to an object that represents a client policy.</p>
862
950
  */
863
951
  clientPolicy?: VirtualGatewayClientPolicy;
@@ -868,6 +956,7 @@ export interface VirtualGatewayBackendDefaults {
868
956
  */
869
957
  export interface VirtualGatewayGrpcConnectionPool {
870
958
  /**
959
+ * @public
871
960
  * <p>Maximum number of inflight requests Envoy can concurrently support across hosts in
872
961
  * upstream cluster.</p>
873
962
  */
@@ -879,11 +968,13 @@ export interface VirtualGatewayGrpcConnectionPool {
879
968
  */
880
969
  export interface VirtualGatewayHttpConnectionPool {
881
970
  /**
971
+ * @public
882
972
  * <p>Maximum number of outbound TCP connections Envoy can establish concurrently with all
883
973
  * hosts in upstream cluster.</p>
884
974
  */
885
975
  maxConnections: number | undefined;
886
976
  /**
977
+ * @public
887
978
  * <p>Number of overflowing requests after <code>max_connections</code> Envoy will queue to
888
979
  * upstream cluster.</p>
889
980
  */
@@ -895,6 +986,7 @@ export interface VirtualGatewayHttpConnectionPool {
895
986
  */
896
987
  export interface VirtualGatewayHttp2ConnectionPool {
897
988
  /**
989
+ * @public
898
990
  * <p>Maximum number of inflight requests Envoy can concurrently support across hosts in
899
991
  * upstream cluster.</p>
900
992
  */
@@ -914,6 +1006,7 @@ export type VirtualGatewayConnectionPool = VirtualGatewayConnectionPool.GrpcMemb
914
1006
  */
915
1007
  export declare namespace VirtualGatewayConnectionPool {
916
1008
  /**
1009
+ * @public
917
1010
  * <p>An object that represents a type of connection pool.</p>
918
1011
  */
919
1012
  interface HttpMember {
@@ -923,6 +1016,7 @@ export declare namespace VirtualGatewayConnectionPool {
923
1016
  $unknown?: never;
924
1017
  }
925
1018
  /**
1019
+ * @public
926
1020
  * <p>An object that represents a type of connection pool.</p>
927
1021
  */
928
1022
  interface Http2Member {
@@ -932,6 +1026,7 @@ export declare namespace VirtualGatewayConnectionPool {
932
1026
  $unknown?: never;
933
1027
  }
934
1028
  /**
1029
+ * @public
935
1030
  * <p>An object that represents a type of connection pool. </p>
936
1031
  */
937
1032
  interface GrpcMember {
@@ -940,6 +1035,9 @@ export declare namespace VirtualGatewayConnectionPool {
940
1035
  grpc: VirtualGatewayGrpcConnectionPool;
941
1036
  $unknown?: never;
942
1037
  }
1038
+ /**
1039
+ * @public
1040
+ */
943
1041
  interface $UnknownMember {
944
1042
  http?: never;
945
1043
  http2?: never;
@@ -974,36 +1072,43 @@ export type VirtualGatewayPortProtocol = (typeof VirtualGatewayPortProtocol)[key
974
1072
  */
975
1073
  export interface VirtualGatewayHealthCheckPolicy {
976
1074
  /**
1075
+ * @public
977
1076
  * <p>The amount of time to wait when receiving a response from the health check, in
978
1077
  * milliseconds.</p>
979
1078
  */
980
1079
  timeoutMillis: number | undefined;
981
1080
  /**
1081
+ * @public
982
1082
  * <p>The time period in milliseconds between each health check execution.</p>
983
1083
  */
984
1084
  intervalMillis: number | undefined;
985
1085
  /**
1086
+ * @public
986
1087
  * <p>The protocol for the health check request. If you specify <code>grpc</code>, then your
987
1088
  * service must conform to the <a href="https://github.com/grpc/grpc/blob/master/doc/health-checking.md">GRPC Health
988
1089
  * Checking Protocol</a>.</p>
989
1090
  */
990
1091
  protocol: VirtualGatewayPortProtocol | string | undefined;
991
1092
  /**
1093
+ * @public
992
1094
  * <p>The destination port for the health check request. This port must match the port defined
993
1095
  * in the <a>PortMapping</a> for the listener.</p>
994
1096
  */
995
1097
  port?: number;
996
1098
  /**
1099
+ * @public
997
1100
  * <p>The destination path for the health check request. This value is only used if the
998
1101
  * specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>
999
1102
  */
1000
1103
  path?: string;
1001
1104
  /**
1105
+ * @public
1002
1106
  * <p>The number of consecutive successful health checks that must occur before declaring the
1003
1107
  * listener healthy.</p>
1004
1108
  */
1005
1109
  healthyThreshold: number | undefined;
1006
1110
  /**
1111
+ * @public
1007
1112
  * <p>The number of consecutive failed health checks that must occur before declaring a
1008
1113
  * virtual gateway unhealthy.</p>
1009
1114
  */
@@ -1015,10 +1120,12 @@ export interface VirtualGatewayHealthCheckPolicy {
1015
1120
  */
1016
1121
  export interface VirtualGatewayPortMapping {
1017
1122
  /**
1123
+ * @public
1018
1124
  * <p>The port used for the port mapping. Specify one protocol.</p>
1019
1125
  */
1020
1126
  port: number | undefined;
1021
1127
  /**
1128
+ * @public
1022
1129
  * <p>The protocol used for the port mapping.</p>
1023
1130
  */
1024
1131
  protocol: VirtualGatewayPortProtocol | string | undefined;
@@ -1029,6 +1136,7 @@ export interface VirtualGatewayPortMapping {
1029
1136
  */
1030
1137
  export interface VirtualGatewayListenerTlsAcmCertificate {
1031
1138
  /**
1139
+ * @public
1032
1140
  * <p>The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites">Transport Layer Security (TLS)</a>.</p>
1033
1141
  */
1034
1142
  certificateArn: string | undefined;
@@ -1043,6 +1151,7 @@ export type VirtualGatewayListenerTlsCertificate = VirtualGatewayListenerTlsCert
1043
1151
  */
1044
1152
  export declare namespace VirtualGatewayListenerTlsCertificate {
1045
1153
  /**
1154
+ * @public
1046
1155
  * <p>A reference to an object that represents an Certificate Manager certificate.</p>
1047
1156
  */
1048
1157
  interface AcmMember {
@@ -1052,6 +1161,7 @@ export declare namespace VirtualGatewayListenerTlsCertificate {
1052
1161
  $unknown?: never;
1053
1162
  }
1054
1163
  /**
1164
+ * @public
1055
1165
  * <p>A reference to an object that represents a local file certificate.</p>
1056
1166
  */
1057
1167
  interface FileMember {
@@ -1061,6 +1171,7 @@ export declare namespace VirtualGatewayListenerTlsCertificate {
1061
1171
  $unknown?: never;
1062
1172
  }
1063
1173
  /**
1174
+ * @public
1064
1175
  * <p>A reference to an object that represents a virtual gateway's listener's Secret Discovery
1065
1176
  * Service certificate.</p>
1066
1177
  */
@@ -1070,6 +1181,9 @@ export declare namespace VirtualGatewayListenerTlsCertificate {
1070
1181
  sds: VirtualGatewayListenerTlsSdsCertificate;
1071
1182
  $unknown?: never;
1072
1183
  }
1184
+ /**
1185
+ * @public
1186
+ */
1073
1187
  interface $UnknownMember {
1074
1188
  acm?: never;
1075
1189
  file?: never;
@@ -1108,6 +1222,7 @@ export type VirtualGatewayListenerTlsValidationContextTrust = VirtualGatewayList
1108
1222
  */
1109
1223
  export declare namespace VirtualGatewayListenerTlsValidationContextTrust {
1110
1224
  /**
1225
+ * @public
1111
1226
  * <p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>
1112
1227
  */
1113
1228
  interface FileMember {
@@ -1116,6 +1231,7 @@ export declare namespace VirtualGatewayListenerTlsValidationContextTrust {
1116
1231
  $unknown?: never;
1117
1232
  }
1118
1233
  /**
1234
+ * @public
1119
1235
  * <p>A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret
1120
1236
  * Discovery Service validation context trust.</p>
1121
1237
  */
@@ -1124,6 +1240,9 @@ export declare namespace VirtualGatewayListenerTlsValidationContextTrust {
1124
1240
  sds: VirtualGatewayTlsValidationContextSdsTrust;
1125
1241
  $unknown?: never;
1126
1242
  }
1243
+ /**
1244
+ * @public
1245
+ */
1127
1246
  interface $UnknownMember {
1128
1247
  file?: never;
1129
1248
  sds?: never;
@@ -1143,11 +1262,13 @@ export declare namespace VirtualGatewayListenerTlsValidationContextTrust {
1143
1262
  */
1144
1263
  export interface VirtualGatewayListenerTlsValidationContext {
1145
1264
  /**
1265
+ * @public
1146
1266
  * <p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
1147
1267
  * certificate.</p>
1148
1268
  */
1149
1269
  trust: VirtualGatewayListenerTlsValidationContextTrust | undefined;
1150
1270
  /**
1271
+ * @public
1151
1272
  * <p>A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS)
1152
1273
  * validation context.</p>
1153
1274
  */
@@ -1159,6 +1280,7 @@ export interface VirtualGatewayListenerTlsValidationContext {
1159
1280
  */
1160
1281
  export interface VirtualGatewayListenerTls {
1161
1282
  /**
1283
+ * @public
1162
1284
  * <p>Specify one of the following modes.</p>
1163
1285
  * <ul>
1164
1286
  * <li>
@@ -1180,11 +1302,13 @@ export interface VirtualGatewayListenerTls {
1180
1302
  */
1181
1303
  mode: VirtualGatewayListenerTlsMode | string | undefined;
1182
1304
  /**
1305
+ * @public
1183
1306
  * <p>A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation
1184
1307
  * context.</p>
1185
1308
  */
1186
1309
  validation?: VirtualGatewayListenerTlsValidationContext;
1187
1310
  /**
1311
+ * @public
1188
1312
  * <p>An object that represents a Transport Layer Security (TLS) certificate.</p>
1189
1313
  */
1190
1314
  certificate: VirtualGatewayListenerTlsCertificate | undefined;
@@ -1195,18 +1319,22 @@ export interface VirtualGatewayListenerTls {
1195
1319
  */
1196
1320
  export interface VirtualGatewayListener {
1197
1321
  /**
1322
+ * @public
1198
1323
  * <p>The health check information for the listener.</p>
1199
1324
  */
1200
1325
  healthCheck?: VirtualGatewayHealthCheckPolicy;
1201
1326
  /**
1327
+ * @public
1202
1328
  * <p>The port mapping information for the listener.</p>
1203
1329
  */
1204
1330
  portMapping: VirtualGatewayPortMapping | undefined;
1205
1331
  /**
1332
+ * @public
1206
1333
  * <p>A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.</p>
1207
1334
  */
1208
1335
  tls?: VirtualGatewayListenerTls;
1209
1336
  /**
1337
+ * @public
1210
1338
  * <p>The connection pool information for the virtual gateway listener.</p>
1211
1339
  */
1212
1340
  connectionPool?: VirtualGatewayConnectionPool;
@@ -1217,6 +1345,7 @@ export interface VirtualGatewayListener {
1217
1345
  */
1218
1346
  export interface VirtualGatewayFileAccessLog {
1219
1347
  /**
1348
+ * @public
1220
1349
  * <p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send
1221
1350
  * access logs to standard out and configure your Envoy container to use a log driver, such as
1222
1351
  * <code>awslogs</code>, to export the access logs to a log storage service such as Amazon
@@ -1225,6 +1354,7 @@ export interface VirtualGatewayFileAccessLog {
1225
1354
  */
1226
1355
  path: string | undefined;
1227
1356
  /**
1357
+ * @public
1228
1358
  * <p>The specified format for the virtual gateway access logs. It can be either
1229
1359
  * <code>json_format</code> or <code>text_format</code>.</p>
1230
1360
  */
@@ -1240,12 +1370,16 @@ export type VirtualGatewayAccessLog = VirtualGatewayAccessLog.FileMember | Virtu
1240
1370
  */
1241
1371
  export declare namespace VirtualGatewayAccessLog {
1242
1372
  /**
1373
+ * @public
1243
1374
  * <p>The file object to send virtual gateway access logs to.</p>
1244
1375
  */
1245
1376
  interface FileMember {
1246
1377
  file: VirtualGatewayFileAccessLog;
1247
1378
  $unknown?: never;
1248
1379
  }
1380
+ /**
1381
+ * @public
1382
+ */
1249
1383
  interface $UnknownMember {
1250
1384
  file?: never;
1251
1385
  $unknown: [string, any];
@@ -1262,6 +1396,7 @@ export declare namespace VirtualGatewayAccessLog {
1262
1396
  */
1263
1397
  export interface VirtualGatewayLogging {
1264
1398
  /**
1399
+ * @public
1265
1400
  * <p>The access log configuration.</p>
1266
1401
  */
1267
1402
  accessLog?: VirtualGatewayAccessLog;
@@ -1272,15 +1407,18 @@ export interface VirtualGatewayLogging {
1272
1407
  */
1273
1408
  export interface VirtualGatewaySpec {
1274
1409
  /**
1410
+ * @public
1275
1411
  * <p>A reference to an object that represents the defaults for backends.</p>
1276
1412
  */
1277
1413
  backendDefaults?: VirtualGatewayBackendDefaults;
1278
1414
  /**
1415
+ * @public
1279
1416
  * <p>The listeners that the mesh endpoint is expected to receive inbound traffic from. You
1280
1417
  * can specify one listener.</p>
1281
1418
  */
1282
1419
  listeners: VirtualGatewayListener[] | undefined;
1283
1420
  /**
1421
+ * @public
1284
1422
  * <p>An object that represents logging information.</p>
1285
1423
  */
1286
1424
  logging?: VirtualGatewayLogging;
@@ -1290,18 +1428,22 @@ export interface VirtualGatewaySpec {
1290
1428
  */
1291
1429
  export interface CreateVirtualGatewayInput {
1292
1430
  /**
1431
+ * @public
1293
1432
  * <p>The name to use for the virtual gateway.</p>
1294
1433
  */
1295
1434
  virtualGatewayName: string | undefined;
1296
1435
  /**
1436
+ * @public
1297
1437
  * <p>The name of the service mesh to create the virtual gateway in.</p>
1298
1438
  */
1299
1439
  meshName: string | undefined;
1300
1440
  /**
1441
+ * @public
1301
1442
  * <p>The virtual gateway specification to apply.</p>
1302
1443
  */
1303
1444
  spec: VirtualGatewaySpec | undefined;
1304
1445
  /**
1446
+ * @public
1305
1447
  * <p>Optional metadata that you can apply to the virtual gateway to assist with
1306
1448
  * categorization and organization. Each tag consists of a key and an optional value, both of
1307
1449
  * which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -1309,11 +1451,13 @@ export interface CreateVirtualGatewayInput {
1309
1451
  */
1310
1452
  tags?: TagRef[];
1311
1453
  /**
1454
+ * @public
1312
1455
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
1313
1456
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
1314
1457
  */
1315
1458
  clientToken?: string;
1316
1459
  /**
1460
+ * @public
1317
1461
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
1318
1462
  * the account that you specify must share the mesh with your account before you can create
1319
1463
  * the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
@@ -1339,6 +1483,7 @@ export type VirtualGatewayStatusCode = (typeof VirtualGatewayStatusCode)[keyof t
1339
1483
  */
1340
1484
  export interface VirtualGatewayStatus {
1341
1485
  /**
1486
+ * @public
1342
1487
  * <p>The current status.</p>
1343
1488
  */
1344
1489
  status: VirtualGatewayStatusCode | string | undefined;
@@ -1349,22 +1494,27 @@ export interface VirtualGatewayStatus {
1349
1494
  */
1350
1495
  export interface VirtualGatewayData {
1351
1496
  /**
1497
+ * @public
1352
1498
  * <p>The name of the service mesh that the virtual gateway resides in.</p>
1353
1499
  */
1354
1500
  meshName: string | undefined;
1355
1501
  /**
1502
+ * @public
1356
1503
  * <p>The name of the virtual gateway.</p>
1357
1504
  */
1358
1505
  virtualGatewayName: string | undefined;
1359
1506
  /**
1507
+ * @public
1360
1508
  * <p>The specifications of the virtual gateway.</p>
1361
1509
  */
1362
1510
  spec: VirtualGatewaySpec | undefined;
1363
1511
  /**
1512
+ * @public
1364
1513
  * <p>An object that represents metadata for a resource.</p>
1365
1514
  */
1366
1515
  metadata: ResourceMetadata | undefined;
1367
1516
  /**
1517
+ * @public
1368
1518
  * <p>The current status of the virtual gateway.</p>
1369
1519
  */
1370
1520
  status: VirtualGatewayStatus | undefined;
@@ -1374,6 +1524,7 @@ export interface VirtualGatewayData {
1374
1524
  */
1375
1525
  export interface CreateVirtualGatewayOutput {
1376
1526
  /**
1527
+ * @public
1377
1528
  * <p>The full description of your virtual gateway following the create call.</p>
1378
1529
  */
1379
1530
  virtualGateway: VirtualGatewayData | undefined;
@@ -1383,14 +1534,17 @@ export interface CreateVirtualGatewayOutput {
1383
1534
  */
1384
1535
  export interface DeleteVirtualGatewayInput {
1385
1536
  /**
1537
+ * @public
1386
1538
  * <p>The name of the virtual gateway to delete.</p>
1387
1539
  */
1388
1540
  virtualGatewayName: string | undefined;
1389
1541
  /**
1542
+ * @public
1390
1543
  * <p>The name of the service mesh to delete the virtual gateway from.</p>
1391
1544
  */
1392
1545
  meshName: string | undefined;
1393
1546
  /**
1547
+ * @public
1394
1548
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
1395
1549
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
1396
1550
  */
@@ -1401,6 +1555,7 @@ export interface DeleteVirtualGatewayInput {
1401
1555
  */
1402
1556
  export interface DeleteVirtualGatewayOutput {
1403
1557
  /**
1558
+ * @public
1404
1559
  * <p>The virtual gateway that was deleted.</p>
1405
1560
  */
1406
1561
  virtualGateway: VirtualGatewayData | undefined;
@@ -1410,14 +1565,17 @@ export interface DeleteVirtualGatewayOutput {
1410
1565
  */
1411
1566
  export interface DescribeVirtualGatewayInput {
1412
1567
  /**
1568
+ * @public
1413
1569
  * <p>The name of the virtual gateway to describe.</p>
1414
1570
  */
1415
1571
  virtualGatewayName: string | undefined;
1416
1572
  /**
1573
+ * @public
1417
1574
  * <p>The name of the service mesh that the gateway route resides in.</p>
1418
1575
  */
1419
1576
  meshName: string | undefined;
1420
1577
  /**
1578
+ * @public
1421
1579
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
1422
1580
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
1423
1581
  */
@@ -1428,6 +1586,7 @@ export interface DescribeVirtualGatewayInput {
1428
1586
  */
1429
1587
  export interface DescribeVirtualGatewayOutput {
1430
1588
  /**
1589
+ * @public
1431
1590
  * <p>The full description of your virtual gateway.</p>
1432
1591
  */
1433
1592
  virtualGateway: VirtualGatewayData | undefined;
@@ -1450,6 +1609,7 @@ export type DefaultGatewayRouteRewrite = (typeof DefaultGatewayRouteRewrite)[key
1450
1609
  */
1451
1610
  export interface GatewayRouteHostnameRewrite {
1452
1611
  /**
1612
+ * @public
1453
1613
  * <p>The default target host name to write to.</p>
1454
1614
  */
1455
1615
  defaultTargetHostname?: DefaultGatewayRouteRewrite | string;
@@ -1460,6 +1620,7 @@ export interface GatewayRouteHostnameRewrite {
1460
1620
  */
1461
1621
  export interface GrpcGatewayRouteRewrite {
1462
1622
  /**
1623
+ * @public
1463
1624
  * <p>The host name of the gateway route to rewrite.</p>
1464
1625
  */
1465
1626
  hostname?: GatewayRouteHostnameRewrite;
@@ -1470,6 +1631,7 @@ export interface GrpcGatewayRouteRewrite {
1470
1631
  */
1471
1632
  export interface GatewayRouteVirtualService {
1472
1633
  /**
1634
+ * @public
1473
1635
  * <p>The name of the virtual service that traffic is routed to.</p>
1474
1636
  */
1475
1637
  virtualServiceName: string | undefined;
@@ -1480,10 +1642,12 @@ export interface GatewayRouteVirtualService {
1480
1642
  */
1481
1643
  export interface GatewayRouteTarget {
1482
1644
  /**
1645
+ * @public
1483
1646
  * <p>An object that represents a virtual service gateway route target.</p>
1484
1647
  */
1485
1648
  virtualService: GatewayRouteVirtualService | undefined;
1486
1649
  /**
1650
+ * @public
1487
1651
  * <p>The port number of the gateway route target.</p>
1488
1652
  */
1489
1653
  port?: number;
@@ -1494,10 +1658,12 @@ export interface GatewayRouteTarget {
1494
1658
  */
1495
1659
  export interface GrpcGatewayRouteAction {
1496
1660
  /**
1661
+ * @public
1497
1662
  * <p>An object that represents the target that traffic is routed to when a request matches the gateway route.</p>
1498
1663
  */
1499
1664
  target: GatewayRouteTarget | undefined;
1500
1665
  /**
1666
+ * @public
1501
1667
  * <p>The gateway route action to rewrite.</p>
1502
1668
  */
1503
1669
  rewrite?: GrpcGatewayRouteRewrite;
@@ -1508,10 +1674,12 @@ export interface GrpcGatewayRouteAction {
1508
1674
  */
1509
1675
  export interface GatewayRouteHostnameMatch {
1510
1676
  /**
1677
+ * @public
1511
1678
  * <p>The exact host name to match on.</p>
1512
1679
  */
1513
1680
  exact?: string;
1514
1681
  /**
1682
+ * @public
1515
1683
  * <p>The specified ending characters of the host name to match on.</p>
1516
1684
  */
1517
1685
  suffix?: string;
@@ -1522,10 +1690,12 @@ export interface GatewayRouteHostnameMatch {
1522
1690
  */
1523
1691
  export interface MatchRange {
1524
1692
  /**
1693
+ * @public
1525
1694
  * <p>The start of the range.</p>
1526
1695
  */
1527
1696
  start: number | undefined;
1528
1697
  /**
1698
+ * @public
1529
1699
  * <p>The end of the range.</p>
1530
1700
  */
1531
1701
  end: number | undefined;
@@ -1540,6 +1710,7 @@ export type GrpcMetadataMatchMethod = GrpcMetadataMatchMethod.ExactMember | Grpc
1540
1710
  */
1541
1711
  export declare namespace GrpcMetadataMatchMethod {
1542
1712
  /**
1713
+ * @public
1543
1714
  * <p>The exact method header to be matched on.</p>
1544
1715
  */
1545
1716
  interface ExactMember {
@@ -1551,6 +1722,7 @@ export declare namespace GrpcMetadataMatchMethod {
1551
1722
  $unknown?: never;
1552
1723
  }
1553
1724
  /**
1725
+ * @public
1554
1726
  * <p>The regex used to match the method header.</p>
1555
1727
  */
1556
1728
  interface RegexMember {
@@ -1562,6 +1734,7 @@ export declare namespace GrpcMetadataMatchMethod {
1562
1734
  $unknown?: never;
1563
1735
  }
1564
1736
  /**
1737
+ * @public
1565
1738
  * <p>An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.</p>
1566
1739
  */
1567
1740
  interface RangeMember {
@@ -1573,6 +1746,7 @@ export declare namespace GrpcMetadataMatchMethod {
1573
1746
  $unknown?: never;
1574
1747
  }
1575
1748
  /**
1749
+ * @public
1576
1750
  * <p>The specified beginning characters of the method header to be matched on.</p>
1577
1751
  */
1578
1752
  interface PrefixMember {
@@ -1584,6 +1758,7 @@ export declare namespace GrpcMetadataMatchMethod {
1584
1758
  $unknown?: never;
1585
1759
  }
1586
1760
  /**
1761
+ * @public
1587
1762
  * <p>The specified ending characters of the method header to match on.</p>
1588
1763
  */
1589
1764
  interface SuffixMember {
@@ -1594,6 +1769,9 @@ export declare namespace GrpcMetadataMatchMethod {
1594
1769
  suffix: string;
1595
1770
  $unknown?: never;
1596
1771
  }
1772
+ /**
1773
+ * @public
1774
+ */
1597
1775
  interface $UnknownMember {
1598
1776
  exact?: never;
1599
1777
  regex?: never;
@@ -1618,15 +1796,18 @@ export declare namespace GrpcMetadataMatchMethod {
1618
1796
  */
1619
1797
  export interface GrpcGatewayRouteMetadata {
1620
1798
  /**
1799
+ * @public
1621
1800
  * <p>A name for the gateway route metadata.</p>
1622
1801
  */
1623
1802
  name: string | undefined;
1624
1803
  /**
1804
+ * @public
1625
1805
  * <p>Specify <code>True</code> to match anything except the match criteria. The default value
1626
1806
  * is <code>False</code>.</p>
1627
1807
  */
1628
1808
  invert?: boolean;
1629
1809
  /**
1810
+ * @public
1630
1811
  * <p>The criteria for determining a metadata match.</p>
1631
1812
  */
1632
1813
  match?: GrpcMetadataMatchMethod;
@@ -1637,18 +1818,22 @@ export interface GrpcGatewayRouteMetadata {
1637
1818
  */
1638
1819
  export interface GrpcGatewayRouteMatch {
1639
1820
  /**
1821
+ * @public
1640
1822
  * <p>The fully qualified domain name for the service to match from the request.</p>
1641
1823
  */
1642
1824
  serviceName?: string;
1643
1825
  /**
1826
+ * @public
1644
1827
  * <p>The gateway route host name to be matched on.</p>
1645
1828
  */
1646
1829
  hostname?: GatewayRouteHostnameMatch;
1647
1830
  /**
1831
+ * @public
1648
1832
  * <p>The gateway route metadata to be matched on.</p>
1649
1833
  */
1650
1834
  metadata?: GrpcGatewayRouteMetadata[];
1651
1835
  /**
1836
+ * @public
1652
1837
  * <p>The port number to match from the request.</p>
1653
1838
  */
1654
1839
  port?: number;
@@ -1659,10 +1844,12 @@ export interface GrpcGatewayRouteMatch {
1659
1844
  */
1660
1845
  export interface GrpcGatewayRoute {
1661
1846
  /**
1847
+ * @public
1662
1848
  * <p>An object that represents the criteria for determining a request match.</p>
1663
1849
  */
1664
1850
  match: GrpcGatewayRouteMatch | undefined;
1665
1851
  /**
1852
+ * @public
1666
1853
  * <p>An object that represents the action to take if a match is determined.</p>
1667
1854
  */
1668
1855
  action: GrpcGatewayRouteAction | undefined;
@@ -1673,6 +1860,7 @@ export interface GrpcGatewayRoute {
1673
1860
  */
1674
1861
  export interface HttpGatewayRoutePathRewrite {
1675
1862
  /**
1863
+ * @public
1676
1864
  * <p>The exact path to rewrite.</p>
1677
1865
  */
1678
1866
  exact?: string;
@@ -1683,10 +1871,12 @@ export interface HttpGatewayRoutePathRewrite {
1683
1871
  */
1684
1872
  export interface HttpGatewayRoutePrefixRewrite {
1685
1873
  /**
1874
+ * @public
1686
1875
  * <p>The default prefix used to replace the incoming route prefix when rewritten.</p>
1687
1876
  */
1688
1877
  defaultPrefix?: DefaultGatewayRouteRewrite | string;
1689
1878
  /**
1879
+ * @public
1690
1880
  * <p>The value used to replace the incoming route prefix when rewritten.</p>
1691
1881
  */
1692
1882
  value?: string;
@@ -1697,14 +1887,17 @@ export interface HttpGatewayRoutePrefixRewrite {
1697
1887
  */
1698
1888
  export interface HttpGatewayRouteRewrite {
1699
1889
  /**
1890
+ * @public
1700
1891
  * <p>The specified beginning characters to rewrite.</p>
1701
1892
  */
1702
1893
  prefix?: HttpGatewayRoutePrefixRewrite;
1703
1894
  /**
1895
+ * @public
1704
1896
  * <p>The path to rewrite.</p>
1705
1897
  */
1706
1898
  path?: HttpGatewayRoutePathRewrite;
1707
1899
  /**
1900
+ * @public
1708
1901
  * <p>The host name to rewrite.</p>
1709
1902
  */
1710
1903
  hostname?: GatewayRouteHostnameRewrite;
@@ -1715,10 +1908,12 @@ export interface HttpGatewayRouteRewrite {
1715
1908
  */
1716
1909
  export interface HttpGatewayRouteAction {
1717
1910
  /**
1911
+ * @public
1718
1912
  * <p>An object that represents the target that traffic is routed to when a request matches the gateway route.</p>
1719
1913
  */
1720
1914
  target: GatewayRouteTarget | undefined;
1721
1915
  /**
1916
+ * @public
1722
1917
  * <p>The gateway route action to rewrite.</p>
1723
1918
  */
1724
1919
  rewrite?: HttpGatewayRouteRewrite;
@@ -1734,6 +1929,7 @@ export type HeaderMatchMethod = HeaderMatchMethod.ExactMember | HeaderMatchMetho
1734
1929
  */
1735
1930
  export declare namespace HeaderMatchMethod {
1736
1931
  /**
1932
+ * @public
1737
1933
  * <p>The value sent by the client must match the specified value exactly.</p>
1738
1934
  */
1739
1935
  interface ExactMember {
@@ -1745,6 +1941,7 @@ export declare namespace HeaderMatchMethod {
1745
1941
  $unknown?: never;
1746
1942
  }
1747
1943
  /**
1944
+ * @public
1748
1945
  * <p>The value sent by the client must include the specified characters.</p>
1749
1946
  */
1750
1947
  interface RegexMember {
@@ -1756,6 +1953,7 @@ export declare namespace HeaderMatchMethod {
1756
1953
  $unknown?: never;
1757
1954
  }
1758
1955
  /**
1956
+ * @public
1759
1957
  * <p>An object that represents the range of values to match on.</p>
1760
1958
  */
1761
1959
  interface RangeMember {
@@ -1767,6 +1965,7 @@ export declare namespace HeaderMatchMethod {
1767
1965
  $unknown?: never;
1768
1966
  }
1769
1967
  /**
1968
+ * @public
1770
1969
  * <p>The value sent by the client must begin with the specified characters.</p>
1771
1970
  */
1772
1971
  interface PrefixMember {
@@ -1778,6 +1977,7 @@ export declare namespace HeaderMatchMethod {
1778
1977
  $unknown?: never;
1779
1978
  }
1780
1979
  /**
1980
+ * @public
1781
1981
  * <p>The value sent by the client must end with the specified characters.</p>
1782
1982
  */
1783
1983
  interface SuffixMember {
@@ -1788,6 +1988,9 @@ export declare namespace HeaderMatchMethod {
1788
1988
  suffix: string;
1789
1989
  $unknown?: never;
1790
1990
  }
1991
+ /**
1992
+ * @public
1993
+ */
1791
1994
  interface $UnknownMember {
1792
1995
  exact?: never;
1793
1996
  regex?: never;
@@ -1812,15 +2015,18 @@ export declare namespace HeaderMatchMethod {
1812
2015
  */
1813
2016
  export interface HttpGatewayRouteHeader {
1814
2017
  /**
2018
+ * @public
1815
2019
  * <p>A name for the HTTP header in the gateway route that will be matched on.</p>
1816
2020
  */
1817
2021
  name: string | undefined;
1818
2022
  /**
2023
+ * @public
1819
2024
  * <p>Specify <code>True</code> to match anything except the match criteria. The default value
1820
2025
  * is <code>False</code>.</p>
1821
2026
  */
1822
2027
  invert?: boolean;
1823
2028
  /**
2029
+ * @public
1824
2030
  * <p>An object that represents the method and value to match with the header value sent in a
1825
2031
  * request. Specify one match method.</p>
1826
2032
  */
@@ -1851,10 +2057,12 @@ export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];
1851
2057
  */
1852
2058
  export interface HttpPathMatch {
1853
2059
  /**
2060
+ * @public
1854
2061
  * <p>The exact path to match on.</p>
1855
2062
  */
1856
2063
  exact?: string;
1857
2064
  /**
2065
+ * @public
1858
2066
  * <p>The regex used to match the path.</p>
1859
2067
  */
1860
2068
  regex?: string;
@@ -1865,6 +2073,7 @@ export interface HttpPathMatch {
1865
2073
  */
1866
2074
  export interface QueryParameterMatch {
1867
2075
  /**
2076
+ * @public
1868
2077
  * <p>The exact query parameter to match on.</p>
1869
2078
  */
1870
2079
  exact?: string;
@@ -1875,10 +2084,12 @@ export interface QueryParameterMatch {
1875
2084
  */
1876
2085
  export interface HttpQueryParameter {
1877
2086
  /**
2087
+ * @public
1878
2088
  * <p>A name for the query parameter that will be matched on.</p>
1879
2089
  */
1880
2090
  name: string | undefined;
1881
2091
  /**
2092
+ * @public
1882
2093
  * <p>The query parameter to match on.</p>
1883
2094
  */
1884
2095
  match?: QueryParameterMatch;
@@ -1889,6 +2100,7 @@ export interface HttpQueryParameter {
1889
2100
  */
1890
2101
  export interface HttpGatewayRouteMatch {
1891
2102
  /**
2103
+ * @public
1892
2104
  * <p>Specifies the path to match requests with. This parameter must always start with
1893
2105
  * <code>/</code>, which by itself matches all requests to the virtual service name. You
1894
2106
  * can also match for path-based routing of requests. For example, if your virtual service
@@ -1898,26 +2110,32 @@ export interface HttpGatewayRouteMatch {
1898
2110
  */
1899
2111
  prefix?: string;
1900
2112
  /**
2113
+ * @public
1901
2114
  * <p>The path to match on.</p>
1902
2115
  */
1903
2116
  path?: HttpPathMatch;
1904
2117
  /**
2118
+ * @public
1905
2119
  * <p>The query parameter to match on.</p>
1906
2120
  */
1907
2121
  queryParameters?: HttpQueryParameter[];
1908
2122
  /**
2123
+ * @public
1909
2124
  * <p>The method to match on.</p>
1910
2125
  */
1911
2126
  method?: HttpMethod | string;
1912
2127
  /**
2128
+ * @public
1913
2129
  * <p>The host name to match on.</p>
1914
2130
  */
1915
2131
  hostname?: GatewayRouteHostnameMatch;
1916
2132
  /**
2133
+ * @public
1917
2134
  * <p>The client request headers to match on.</p>
1918
2135
  */
1919
2136
  headers?: HttpGatewayRouteHeader[];
1920
2137
  /**
2138
+ * @public
1921
2139
  * <p>The port number to match on.</p>
1922
2140
  */
1923
2141
  port?: number;
@@ -1928,10 +2146,12 @@ export interface HttpGatewayRouteMatch {
1928
2146
  */
1929
2147
  export interface HttpGatewayRoute {
1930
2148
  /**
2149
+ * @public
1931
2150
  * <p>An object that represents the criteria for determining a request match.</p>
1932
2151
  */
1933
2152
  match: HttpGatewayRouteMatch | undefined;
1934
2153
  /**
2154
+ * @public
1935
2155
  * <p>An object that represents the action to take if a match is determined.</p>
1936
2156
  */
1937
2157
  action: HttpGatewayRouteAction | undefined;
@@ -1943,18 +2163,22 @@ export interface HttpGatewayRoute {
1943
2163
  */
1944
2164
  export interface GatewayRouteSpec {
1945
2165
  /**
2166
+ * @public
1946
2167
  * <p>The ordering of the gateway routes spec.</p>
1947
2168
  */
1948
2169
  priority?: number;
1949
2170
  /**
2171
+ * @public
1950
2172
  * <p>An object that represents the specification of an HTTP gateway route.</p>
1951
2173
  */
1952
2174
  httpRoute?: HttpGatewayRoute;
1953
2175
  /**
2176
+ * @public
1954
2177
  * <p>An object that represents the specification of an HTTP/2 gateway route.</p>
1955
2178
  */
1956
2179
  http2Route?: HttpGatewayRoute;
1957
2180
  /**
2181
+ * @public
1958
2182
  * <p>An object that represents the specification of a gRPC gateway route.</p>
1959
2183
  */
1960
2184
  grpcRoute?: GrpcGatewayRoute;
@@ -1964,24 +2188,29 @@ export interface GatewayRouteSpec {
1964
2188
  */
1965
2189
  export interface CreateGatewayRouteInput {
1966
2190
  /**
2191
+ * @public
1967
2192
  * <p>The name to use for the gateway route.</p>
1968
2193
  */
1969
2194
  gatewayRouteName: string | undefined;
1970
2195
  /**
2196
+ * @public
1971
2197
  * <p>The name of the service mesh to create the gateway route in.</p>
1972
2198
  */
1973
2199
  meshName: string | undefined;
1974
2200
  /**
2201
+ * @public
1975
2202
  * <p>The name of the virtual gateway to associate the gateway route with. If the virtual
1976
2203
  * gateway is in a shared mesh, then you must be the owner of the virtual gateway
1977
2204
  * resource.</p>
1978
2205
  */
1979
2206
  virtualGatewayName: string | undefined;
1980
2207
  /**
2208
+ * @public
1981
2209
  * <p>The gateway route specification to apply.</p>
1982
2210
  */
1983
2211
  spec: GatewayRouteSpec | undefined;
1984
2212
  /**
2213
+ * @public
1985
2214
  * <p>Optional metadata that you can apply to the gateway route to assist with categorization
1986
2215
  * and organization. Each tag consists of a key and an optional value, both of which you
1987
2216
  * define. Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -1989,11 +2218,13 @@ export interface CreateGatewayRouteInput {
1989
2218
  */
1990
2219
  tags?: TagRef[];
1991
2220
  /**
2221
+ * @public
1992
2222
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
1993
2223
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
1994
2224
  */
1995
2225
  clientToken?: string;
1996
2226
  /**
2227
+ * @public
1997
2228
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
1998
2229
  * the account that you specify must share the mesh with your account before you can create
1999
2230
  * the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
@@ -2019,6 +2250,7 @@ export type GatewayRouteStatusCode = (typeof GatewayRouteStatusCode)[keyof typeo
2019
2250
  */
2020
2251
  export interface GatewayRouteStatus {
2021
2252
  /**
2253
+ * @public
2022
2254
  * <p>The current status for the gateway route.</p>
2023
2255
  */
2024
2256
  status: GatewayRouteStatusCode | string | undefined;
@@ -2029,26 +2261,32 @@ export interface GatewayRouteStatus {
2029
2261
  */
2030
2262
  export interface GatewayRouteData {
2031
2263
  /**
2264
+ * @public
2032
2265
  * <p>The name of the service mesh that the resource resides in. </p>
2033
2266
  */
2034
2267
  meshName: string | undefined;
2035
2268
  /**
2269
+ * @public
2036
2270
  * <p>The name of the gateway route.</p>
2037
2271
  */
2038
2272
  gatewayRouteName: string | undefined;
2039
2273
  /**
2274
+ * @public
2040
2275
  * <p>The virtual gateway that the gateway route is associated with.</p>
2041
2276
  */
2042
2277
  virtualGatewayName: string | undefined;
2043
2278
  /**
2279
+ * @public
2044
2280
  * <p>The specifications of the gateway route.</p>
2045
2281
  */
2046
2282
  spec: GatewayRouteSpec | undefined;
2047
2283
  /**
2284
+ * @public
2048
2285
  * <p>An object that represents metadata for a resource.</p>
2049
2286
  */
2050
2287
  metadata: ResourceMetadata | undefined;
2051
2288
  /**
2289
+ * @public
2052
2290
  * <p>The status of the gateway route.</p>
2053
2291
  */
2054
2292
  status: GatewayRouteStatus | undefined;
@@ -2058,6 +2296,7 @@ export interface GatewayRouteData {
2058
2296
  */
2059
2297
  export interface CreateGatewayRouteOutput {
2060
2298
  /**
2299
+ * @public
2061
2300
  * <p>The full description of your gateway route following the create call.</p>
2062
2301
  */
2063
2302
  gatewayRoute: GatewayRouteData | undefined;
@@ -2067,18 +2306,22 @@ export interface CreateGatewayRouteOutput {
2067
2306
  */
2068
2307
  export interface DeleteGatewayRouteInput {
2069
2308
  /**
2309
+ * @public
2070
2310
  * <p>The name of the gateway route to delete.</p>
2071
2311
  */
2072
2312
  gatewayRouteName: string | undefined;
2073
2313
  /**
2314
+ * @public
2074
2315
  * <p>The name of the service mesh to delete the gateway route from.</p>
2075
2316
  */
2076
2317
  meshName: string | undefined;
2077
2318
  /**
2319
+ * @public
2078
2320
  * <p>The name of the virtual gateway to delete the route from.</p>
2079
2321
  */
2080
2322
  virtualGatewayName: string | undefined;
2081
2323
  /**
2324
+ * @public
2082
2325
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2083
2326
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2084
2327
  */
@@ -2089,6 +2332,7 @@ export interface DeleteGatewayRouteInput {
2089
2332
  */
2090
2333
  export interface DeleteGatewayRouteOutput {
2091
2334
  /**
2335
+ * @public
2092
2336
  * <p>The gateway route that was deleted.</p>
2093
2337
  */
2094
2338
  gatewayRoute: GatewayRouteData | undefined;
@@ -2098,18 +2342,22 @@ export interface DeleteGatewayRouteOutput {
2098
2342
  */
2099
2343
  export interface DescribeGatewayRouteInput {
2100
2344
  /**
2345
+ * @public
2101
2346
  * <p>The name of the gateway route to describe.</p>
2102
2347
  */
2103
2348
  gatewayRouteName: string | undefined;
2104
2349
  /**
2350
+ * @public
2105
2351
  * <p>The name of the service mesh that the gateway route resides in.</p>
2106
2352
  */
2107
2353
  meshName: string | undefined;
2108
2354
  /**
2355
+ * @public
2109
2356
  * <p>The name of the virtual gateway that the gateway route is associated with.</p>
2110
2357
  */
2111
2358
  virtualGatewayName: string | undefined;
2112
2359
  /**
2360
+ * @public
2113
2361
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2114
2362
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2115
2363
  */
@@ -2120,6 +2368,7 @@ export interface DescribeGatewayRouteInput {
2120
2368
  */
2121
2369
  export interface DescribeGatewayRouteOutput {
2122
2370
  /**
2371
+ * @public
2123
2372
  * <p>The full description of your gateway route.</p>
2124
2373
  */
2125
2374
  gatewayRoute: GatewayRouteData | undefined;
@@ -2129,14 +2378,17 @@ export interface DescribeGatewayRouteOutput {
2129
2378
  */
2130
2379
  export interface ListGatewayRoutesInput {
2131
2380
  /**
2381
+ * @public
2132
2382
  * <p>The name of the service mesh to list gateway routes in.</p>
2133
2383
  */
2134
2384
  meshName: string | undefined;
2135
2385
  /**
2386
+ * @public
2136
2387
  * <p>The name of the virtual gateway to list gateway routes in.</p>
2137
2388
  */
2138
2389
  virtualGatewayName: string | undefined;
2139
2390
  /**
2391
+ * @public
2140
2392
  * <p>The <code>nextToken</code> value returned from a previous paginated
2141
2393
  * <code>ListGatewayRoutes</code> request where <code>limit</code> was used and the results
2142
2394
  * exceeded the value of that parameter. Pagination continues from the end of the previous
@@ -2144,6 +2396,7 @@ export interface ListGatewayRoutesInput {
2144
2396
  */
2145
2397
  nextToken?: string;
2146
2398
  /**
2399
+ * @public
2147
2400
  * <p>The maximum number of results returned by <code>ListGatewayRoutes</code> in paginated
2148
2401
  * output. When you use this parameter, <code>ListGatewayRoutes</code> returns only
2149
2402
  * <code>limit</code> results in a single page along with a <code>nextToken</code> response
@@ -2155,6 +2408,7 @@ export interface ListGatewayRoutesInput {
2155
2408
  */
2156
2409
  limit?: number;
2157
2410
  /**
2411
+ * @public
2158
2412
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2159
2413
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2160
2414
  */
@@ -2166,40 +2420,49 @@ export interface ListGatewayRoutesInput {
2166
2420
  */
2167
2421
  export interface GatewayRouteRef {
2168
2422
  /**
2423
+ * @public
2169
2424
  * <p>The name of the service mesh that the resource resides in. </p>
2170
2425
  */
2171
2426
  meshName: string | undefined;
2172
2427
  /**
2428
+ * @public
2173
2429
  * <p>The name of the gateway route.</p>
2174
2430
  */
2175
2431
  gatewayRouteName: string | undefined;
2176
2432
  /**
2433
+ * @public
2177
2434
  * <p>The virtual gateway that the gateway route is associated with.</p>
2178
2435
  */
2179
2436
  virtualGatewayName: string | undefined;
2180
2437
  /**
2438
+ * @public
2181
2439
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2182
2440
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2183
2441
  */
2184
2442
  meshOwner: string | undefined;
2185
2443
  /**
2444
+ * @public
2186
2445
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
2187
2446
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2188
2447
  */
2189
2448
  resourceOwner: string | undefined;
2190
2449
  /**
2450
+ * @public
2191
2451
  * <p>The full Amazon Resource Name (ARN) for the gateway route.</p>
2192
2452
  */
2193
2453
  arn: string | undefined;
2194
2454
  /**
2455
+ * @public
2195
2456
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
2196
2457
  */
2197
2458
  version: number | undefined;
2198
2459
  /**
2460
+ * @public
2199
2461
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
2200
2462
  */
2201
2463
  createdAt: Date | undefined;
2202
2464
  /**
2465
+ * @public
2203
2466
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
2204
2467
  */
2205
2468
  lastUpdatedAt: Date | undefined;
@@ -2209,11 +2472,13 @@ export interface GatewayRouteRef {
2209
2472
  */
2210
2473
  export interface ListGatewayRoutesOutput {
2211
2474
  /**
2475
+ * @public
2212
2476
  * <p>The list of existing gateway routes for the specified service mesh and virtual
2213
2477
  * gateway.</p>
2214
2478
  */
2215
2479
  gatewayRoutes: GatewayRouteRef[] | undefined;
2216
2480
  /**
2481
+ * @public
2217
2482
  * <p>The <code>nextToken</code> value to include in a future <code>ListGatewayRoutes</code>
2218
2483
  * request. When the results of a <code>ListGatewayRoutes</code> request exceed
2219
2484
  * <code>limit</code>, you can use this value to retrieve the next page of results. This
@@ -2226,27 +2491,33 @@ export interface ListGatewayRoutesOutput {
2226
2491
  */
2227
2492
  export interface UpdateGatewayRouteInput {
2228
2493
  /**
2494
+ * @public
2229
2495
  * <p>The name of the gateway route to update.</p>
2230
2496
  */
2231
2497
  gatewayRouteName: string | undefined;
2232
2498
  /**
2499
+ * @public
2233
2500
  * <p>The name of the service mesh that the gateway route resides in.</p>
2234
2501
  */
2235
2502
  meshName: string | undefined;
2236
2503
  /**
2504
+ * @public
2237
2505
  * <p>The name of the virtual gateway that the gateway route is associated with.</p>
2238
2506
  */
2239
2507
  virtualGatewayName: string | undefined;
2240
2508
  /**
2509
+ * @public
2241
2510
  * <p>The new gateway route specification to apply. This overwrites the existing data.</p>
2242
2511
  */
2243
2512
  spec: GatewayRouteSpec | undefined;
2244
2513
  /**
2514
+ * @public
2245
2515
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
2246
2516
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
2247
2517
  */
2248
2518
  clientToken?: string;
2249
2519
  /**
2520
+ * @public
2250
2521
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2251
2522
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2252
2523
  */
@@ -2257,6 +2528,7 @@ export interface UpdateGatewayRouteInput {
2257
2528
  */
2258
2529
  export interface UpdateGatewayRouteOutput {
2259
2530
  /**
2531
+ * @public
2260
2532
  * <p>A full description of the gateway route that was updated.</p>
2261
2533
  */
2262
2534
  gatewayRoute: GatewayRouteData | undefined;
@@ -2266,10 +2538,12 @@ export interface UpdateGatewayRouteOutput {
2266
2538
  */
2267
2539
  export interface ListVirtualGatewaysInput {
2268
2540
  /**
2541
+ * @public
2269
2542
  * <p>The name of the service mesh to list virtual gateways in.</p>
2270
2543
  */
2271
2544
  meshName: string | undefined;
2272
2545
  /**
2546
+ * @public
2273
2547
  * <p>The <code>nextToken</code> value returned from a previous paginated
2274
2548
  * <code>ListVirtualGateways</code> request where <code>limit</code> was used and the
2275
2549
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -2277,6 +2551,7 @@ export interface ListVirtualGatewaysInput {
2277
2551
  */
2278
2552
  nextToken?: string;
2279
2553
  /**
2554
+ * @public
2280
2555
  * <p>The maximum number of results returned by <code>ListVirtualGateways</code> in paginated
2281
2556
  * output. When you use this parameter, <code>ListVirtualGateways</code> returns only
2282
2557
  * <code>limit</code> results in a single page along with a <code>nextToken</code> response
@@ -2288,6 +2563,7 @@ export interface ListVirtualGatewaysInput {
2288
2563
  */
2289
2564
  limit?: number;
2290
2565
  /**
2566
+ * @public
2291
2567
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2292
2568
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2293
2569
  */
@@ -2299,36 +2575,44 @@ export interface ListVirtualGatewaysInput {
2299
2575
  */
2300
2576
  export interface VirtualGatewayRef {
2301
2577
  /**
2578
+ * @public
2302
2579
  * <p>The name of the service mesh that the resource resides in.</p>
2303
2580
  */
2304
2581
  meshName: string | undefined;
2305
2582
  /**
2583
+ * @public
2306
2584
  * <p>The name of the resource.</p>
2307
2585
  */
2308
2586
  virtualGatewayName: string | undefined;
2309
2587
  /**
2588
+ * @public
2310
2589
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2311
2590
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2312
2591
  */
2313
2592
  meshOwner: string | undefined;
2314
2593
  /**
2594
+ * @public
2315
2595
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
2316
2596
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2317
2597
  */
2318
2598
  resourceOwner: string | undefined;
2319
2599
  /**
2600
+ * @public
2320
2601
  * <p>The full Amazon Resource Name (ARN) for the resource.</p>
2321
2602
  */
2322
2603
  arn: string | undefined;
2323
2604
  /**
2605
+ * @public
2324
2606
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
2325
2607
  */
2326
2608
  version: number | undefined;
2327
2609
  /**
2610
+ * @public
2328
2611
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
2329
2612
  */
2330
2613
  createdAt: Date | undefined;
2331
2614
  /**
2615
+ * @public
2332
2616
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
2333
2617
  */
2334
2618
  lastUpdatedAt: Date | undefined;
@@ -2338,10 +2622,12 @@ export interface VirtualGatewayRef {
2338
2622
  */
2339
2623
  export interface ListVirtualGatewaysOutput {
2340
2624
  /**
2625
+ * @public
2341
2626
  * <p>The list of existing virtual gateways for the specified service mesh.</p>
2342
2627
  */
2343
2628
  virtualGateways: VirtualGatewayRef[] | undefined;
2344
2629
  /**
2630
+ * @public
2345
2631
  * <p>The <code>nextToken</code> value to include in a future <code>ListVirtualGateways</code>
2346
2632
  * request. When the results of a <code>ListVirtualGateways</code> request exceed
2347
2633
  * <code>limit</code>, you can use this value to retrieve the next page of results. This
@@ -2354,24 +2640,29 @@ export interface ListVirtualGatewaysOutput {
2354
2640
  */
2355
2641
  export interface UpdateVirtualGatewayInput {
2356
2642
  /**
2643
+ * @public
2357
2644
  * <p>The name of the virtual gateway to update.</p>
2358
2645
  */
2359
2646
  virtualGatewayName: string | undefined;
2360
2647
  /**
2648
+ * @public
2361
2649
  * <p>The name of the service mesh that the virtual gateway resides in.</p>
2362
2650
  */
2363
2651
  meshName: string | undefined;
2364
2652
  /**
2653
+ * @public
2365
2654
  * <p>The new virtual gateway specification to apply. This overwrites the existing
2366
2655
  * data.</p>
2367
2656
  */
2368
2657
  spec: VirtualGatewaySpec | undefined;
2369
2658
  /**
2659
+ * @public
2370
2660
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
2371
2661
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
2372
2662
  */
2373
2663
  clientToken?: string;
2374
2664
  /**
2665
+ * @public
2375
2666
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
2376
2667
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
2377
2668
  */
@@ -2382,6 +2673,7 @@ export interface UpdateVirtualGatewayInput {
2382
2673
  */
2383
2674
  export interface UpdateVirtualGatewayOutput {
2384
2675
  /**
2676
+ * @public
2385
2677
  * <p>A full description of the virtual gateway that was updated.</p>
2386
2678
  */
2387
2679
  virtualGateway: VirtualGatewayData | undefined;
@@ -2393,10 +2685,12 @@ export interface UpdateVirtualGatewayOutput {
2393
2685
  */
2394
2686
  export interface ListenerTlsFileCertificate {
2395
2687
  /**
2688
+ * @public
2396
2689
  * <p>The certificate chain for the certificate.</p>
2397
2690
  */
2398
2691
  certificateChain: string | undefined;
2399
2692
  /**
2693
+ * @public
2400
2694
  * <p>The private key for a certificate stored on the file system of the virtual node that the
2401
2695
  * proxy is running on.</p>
2402
2696
  */
@@ -2411,6 +2705,7 @@ export interface ListenerTlsFileCertificate {
2411
2705
  */
2412
2706
  export interface ListenerTlsSdsCertificate {
2413
2707
  /**
2708
+ * @public
2414
2709
  * <p>A reference to an object that represents the name of the secret requested from the
2415
2710
  * Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or
2416
2711
  * certificate chain.</p>
@@ -2427,6 +2722,7 @@ export type ClientTlsCertificate = ClientTlsCertificate.FileMember | ClientTlsCe
2427
2722
  */
2428
2723
  export declare namespace ClientTlsCertificate {
2429
2724
  /**
2725
+ * @public
2430
2726
  * <p>An object that represents a local file certificate. The certificate must meet specific
2431
2727
  * requirements and you must have proxy authorization enabled. For more information, see
2432
2728
  * <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html">Transport Layer Security (TLS)</a>.</p>
@@ -2437,6 +2733,7 @@ export declare namespace ClientTlsCertificate {
2437
2733
  $unknown?: never;
2438
2734
  }
2439
2735
  /**
2736
+ * @public
2440
2737
  * <p>A reference to an object that represents a client's TLS Secret Discovery Service
2441
2738
  * certificate.</p>
2442
2739
  */
@@ -2445,6 +2742,9 @@ export declare namespace ClientTlsCertificate {
2445
2742
  sds: ListenerTlsSdsCertificate;
2446
2743
  $unknown?: never;
2447
2744
  }
2745
+ /**
2746
+ * @public
2747
+ */
2448
2748
  interface $UnknownMember {
2449
2749
  file?: never;
2450
2750
  sds?: never;
@@ -2464,6 +2764,7 @@ export declare namespace ClientTlsCertificate {
2464
2764
  */
2465
2765
  export interface TlsValidationContextAcmTrust {
2466
2766
  /**
2767
+ * @public
2467
2768
  * <p>One or more ACM Amazon Resource Name (ARN)s.</p>
2468
2769
  */
2469
2770
  certificateAuthorityArns: string[] | undefined;
@@ -2474,6 +2775,7 @@ export interface TlsValidationContextAcmTrust {
2474
2775
  */
2475
2776
  export interface TlsValidationContextFileTrust {
2476
2777
  /**
2778
+ * @public
2477
2779
  * <p>The certificate trust chain for a certificate stored on the file system of the virtual
2478
2780
  * node that the proxy is running on.</p>
2479
2781
  */
@@ -2488,6 +2790,7 @@ export interface TlsValidationContextFileTrust {
2488
2790
  */
2489
2791
  export interface TlsValidationContextSdsTrust {
2490
2792
  /**
2793
+ * @public
2491
2794
  * <p>A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret
2492
2795
  * Discovery Service validation context trust.</p>
2493
2796
  */
@@ -2503,6 +2806,7 @@ export type TlsValidationContextTrust = TlsValidationContextTrust.AcmMember | Tl
2503
2806
  */
2504
2807
  export declare namespace TlsValidationContextTrust {
2505
2808
  /**
2809
+ * @public
2506
2810
  * <p>A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.</p>
2507
2811
  */
2508
2812
  interface AcmMember {
@@ -2512,6 +2816,7 @@ export declare namespace TlsValidationContextTrust {
2512
2816
  $unknown?: never;
2513
2817
  }
2514
2818
  /**
2819
+ * @public
2515
2820
  * <p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>
2516
2821
  */
2517
2822
  interface FileMember {
@@ -2521,6 +2826,7 @@ export declare namespace TlsValidationContextTrust {
2521
2826
  $unknown?: never;
2522
2827
  }
2523
2828
  /**
2829
+ * @public
2524
2830
  * <p>A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation
2525
2831
  * context trust.</p>
2526
2832
  */
@@ -2530,6 +2836,9 @@ export declare namespace TlsValidationContextTrust {
2530
2836
  sds: TlsValidationContextSdsTrust;
2531
2837
  $unknown?: never;
2532
2838
  }
2839
+ /**
2840
+ * @public
2841
+ */
2533
2842
  interface $UnknownMember {
2534
2843
  acm?: never;
2535
2844
  file?: never;
@@ -2551,11 +2860,13 @@ export declare namespace TlsValidationContextTrust {
2551
2860
  */
2552
2861
  export interface TlsValidationContext {
2553
2862
  /**
2863
+ * @public
2554
2864
  * <p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
2555
2865
  * certificate.</p>
2556
2866
  */
2557
2867
  trust: TlsValidationContextTrust | undefined;
2558
2868
  /**
2869
+ * @public
2559
2870
  * <p>A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you
2560
2871
  * don't specify SANs on the <i>terminating</i> mesh endpoint, the Envoy proxy
2561
2872
  * for that node doesn't verify the SAN on a peer client certificate. If you don't specify
@@ -2572,18 +2883,22 @@ export interface TlsValidationContext {
2572
2883
  */
2573
2884
  export interface ClientPolicyTls {
2574
2885
  /**
2886
+ * @public
2575
2887
  * <p>Whether the policy is enforced. The default is <code>True</code>, if a value isn't specified.</p>
2576
2888
  */
2577
2889
  enforce?: boolean;
2578
2890
  /**
2891
+ * @public
2579
2892
  * <p>One or more ports that the policy is enforced for.</p>
2580
2893
  */
2581
2894
  ports?: number[];
2582
2895
  /**
2896
+ * @public
2583
2897
  * <p>A reference to an object that represents a client's TLS certificate.</p>
2584
2898
  */
2585
2899
  certificate?: ClientTlsCertificate;
2586
2900
  /**
2901
+ * @public
2587
2902
  * <p>A reference to an object that represents a TLS validation context.</p>
2588
2903
  */
2589
2904
  validation: TlsValidationContext | undefined;
@@ -2594,6 +2909,7 @@ export interface ClientPolicyTls {
2594
2909
  */
2595
2910
  export interface ClientPolicy {
2596
2911
  /**
2912
+ * @public
2597
2913
  * <p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>
2598
2914
  */
2599
2915
  tls?: ClientPolicyTls;
@@ -2604,6 +2920,7 @@ export interface ClientPolicy {
2604
2920
  */
2605
2921
  export interface BackendDefaults {
2606
2922
  /**
2923
+ * @public
2607
2924
  * <p>A reference to an object that represents a client policy.</p>
2608
2925
  */
2609
2926
  clientPolicy?: ClientPolicy;
@@ -2614,10 +2931,12 @@ export interface BackendDefaults {
2614
2931
  */
2615
2932
  export interface VirtualServiceBackend {
2616
2933
  /**
2934
+ * @public
2617
2935
  * <p>The name of the virtual service that is acting as a virtual node backend.</p>
2618
2936
  */
2619
2937
  virtualServiceName: string | undefined;
2620
2938
  /**
2939
+ * @public
2621
2940
  * <p>A reference to an object that represents the client policy for a backend.</p>
2622
2941
  */
2623
2942
  clientPolicy?: ClientPolicy;
@@ -2633,12 +2952,16 @@ export type Backend = Backend.VirtualServiceMember | Backend.$UnknownMember;
2633
2952
  */
2634
2953
  export declare namespace Backend {
2635
2954
  /**
2955
+ * @public
2636
2956
  * <p>Specifies a virtual service to use as a backend. </p>
2637
2957
  */
2638
2958
  interface VirtualServiceMember {
2639
2959
  virtualService: VirtualServiceBackend;
2640
2960
  $unknown?: never;
2641
2961
  }
2962
+ /**
2963
+ * @public
2964
+ */
2642
2965
  interface $UnknownMember {
2643
2966
  virtualService?: never;
2644
2967
  $unknown: [string, any];
@@ -2655,6 +2978,7 @@ export declare namespace Backend {
2655
2978
  */
2656
2979
  export interface VirtualNodeGrpcConnectionPool {
2657
2980
  /**
2981
+ * @public
2658
2982
  * <p>Maximum number of inflight requests Envoy can concurrently support across hosts in
2659
2983
  * upstream cluster.</p>
2660
2984
  */
@@ -2666,11 +2990,13 @@ export interface VirtualNodeGrpcConnectionPool {
2666
2990
  */
2667
2991
  export interface VirtualNodeHttpConnectionPool {
2668
2992
  /**
2993
+ * @public
2669
2994
  * <p>Maximum number of outbound TCP connections Envoy can establish concurrently with all
2670
2995
  * hosts in upstream cluster.</p>
2671
2996
  */
2672
2997
  maxConnections: number | undefined;
2673
2998
  /**
2999
+ * @public
2674
3000
  * <p>Number of overflowing requests after <code>max_connections</code> Envoy will queue to
2675
3001
  * upstream cluster.</p>
2676
3002
  */
@@ -2682,6 +3008,7 @@ export interface VirtualNodeHttpConnectionPool {
2682
3008
  */
2683
3009
  export interface VirtualNodeHttp2ConnectionPool {
2684
3010
  /**
3011
+ * @public
2685
3012
  * <p>Maximum number of inflight requests Envoy can concurrently support across hosts in
2686
3013
  * upstream cluster.</p>
2687
3014
  */
@@ -2693,6 +3020,7 @@ export interface VirtualNodeHttp2ConnectionPool {
2693
3020
  */
2694
3021
  export interface VirtualNodeTcpConnectionPool {
2695
3022
  /**
3023
+ * @public
2696
3024
  * <p>Maximum number of outbound TCP connections Envoy can establish concurrently with all
2697
3025
  * hosts in upstream cluster.</p>
2698
3026
  */
@@ -2713,6 +3041,7 @@ export type VirtualNodeConnectionPool = VirtualNodeConnectionPool.GrpcMember | V
2713
3041
  */
2714
3042
  export declare namespace VirtualNodeConnectionPool {
2715
3043
  /**
3044
+ * @public
2716
3045
  * <p>An object that represents a type of connection pool.</p>
2717
3046
  */
2718
3047
  interface TcpMember {
@@ -2723,6 +3052,7 @@ export declare namespace VirtualNodeConnectionPool {
2723
3052
  $unknown?: never;
2724
3053
  }
2725
3054
  /**
3055
+ * @public
2726
3056
  * <p>An object that represents a type of connection pool.</p>
2727
3057
  */
2728
3058
  interface HttpMember {
@@ -2733,6 +3063,7 @@ export declare namespace VirtualNodeConnectionPool {
2733
3063
  $unknown?: never;
2734
3064
  }
2735
3065
  /**
3066
+ * @public
2736
3067
  * <p>An object that represents a type of connection pool.</p>
2737
3068
  */
2738
3069
  interface Http2Member {
@@ -2743,6 +3074,7 @@ export declare namespace VirtualNodeConnectionPool {
2743
3074
  $unknown?: never;
2744
3075
  }
2745
3076
  /**
3077
+ * @public
2746
3078
  * <p>An object that represents a type of connection pool.</p>
2747
3079
  */
2748
3080
  interface GrpcMember {
@@ -2752,6 +3084,9 @@ export declare namespace VirtualNodeConnectionPool {
2752
3084
  grpc: VirtualNodeGrpcConnectionPool;
2753
3085
  $unknown?: never;
2754
3086
  }
3087
+ /**
3088
+ * @public
3089
+ */
2755
3090
  interface $UnknownMember {
2756
3091
  tcp?: never;
2757
3092
  http?: never;
@@ -2788,36 +3123,43 @@ export type PortProtocol = (typeof PortProtocol)[keyof typeof PortProtocol];
2788
3123
  */
2789
3124
  export interface HealthCheckPolicy {
2790
3125
  /**
3126
+ * @public
2791
3127
  * <p>The amount of time to wait when receiving a response from the health check, in
2792
3128
  * milliseconds.</p>
2793
3129
  */
2794
3130
  timeoutMillis: number | undefined;
2795
3131
  /**
3132
+ * @public
2796
3133
  * <p>The time period in milliseconds between each health check execution.</p>
2797
3134
  */
2798
3135
  intervalMillis: number | undefined;
2799
3136
  /**
3137
+ * @public
2800
3138
  * <p>The protocol for the health check request. If you specify <code>grpc</code>, then your
2801
3139
  * service must conform to the <a href="https://github.com/grpc/grpc/blob/master/doc/health-checking.md">GRPC Health
2802
3140
  * Checking Protocol</a>.</p>
2803
3141
  */
2804
3142
  protocol: PortProtocol | string | undefined;
2805
3143
  /**
3144
+ * @public
2806
3145
  * <p>The destination port for the health check request. This port must match the port defined
2807
3146
  * in the <a>PortMapping</a> for the listener.</p>
2808
3147
  */
2809
3148
  port?: number;
2810
3149
  /**
3150
+ * @public
2811
3151
  * <p>The destination path for the health check request. This value is only used if the
2812
3152
  * specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>
2813
3153
  */
2814
3154
  path?: string;
2815
3155
  /**
3156
+ * @public
2816
3157
  * <p>The number of consecutive successful health checks that must occur before declaring
2817
3158
  * listener healthy.</p>
2818
3159
  */
2819
3160
  healthyThreshold: number | undefined;
2820
3161
  /**
3162
+ * @public
2821
3163
  * <p>The number of consecutive failed health checks that must occur before declaring a
2822
3164
  * virtual node unhealthy. </p>
2823
3165
  */
@@ -2841,10 +3183,12 @@ export type DurationUnit = (typeof DurationUnit)[keyof typeof DurationUnit];
2841
3183
  */
2842
3184
  export interface Duration {
2843
3185
  /**
3186
+ * @public
2844
3187
  * <p>A number of time units.</p>
2845
3188
  */
2846
3189
  value?: number;
2847
3190
  /**
3191
+ * @public
2848
3192
  * <p>A unit of time.</p>
2849
3193
  */
2850
3194
  unit?: DurationUnit | string;
@@ -2855,18 +3199,22 @@ export interface Duration {
2855
3199
  */
2856
3200
  export interface OutlierDetection {
2857
3201
  /**
3202
+ * @public
2858
3203
  * <p>Number of consecutive <code>5xx</code> errors required for ejection. </p>
2859
3204
  */
2860
3205
  maxServerErrors: number | undefined;
2861
3206
  /**
3207
+ * @public
2862
3208
  * <p>The time interval between ejection sweep analysis.</p>
2863
3209
  */
2864
3210
  interval: Duration | undefined;
2865
3211
  /**
3212
+ * @public
2866
3213
  * <p>The base amount of time for which a host is ejected.</p>
2867
3214
  */
2868
3215
  baseEjectionDuration: Duration | undefined;
2869
3216
  /**
3217
+ * @public
2870
3218
  * <p>Maximum percentage of hosts in load balancing pool for upstream service that can be
2871
3219
  * ejected. Will eject at least one host regardless of the value.</p>
2872
3220
  */
@@ -2878,10 +3226,12 @@ export interface OutlierDetection {
2878
3226
  */
2879
3227
  export interface PortMapping {
2880
3228
  /**
3229
+ * @public
2881
3230
  * <p>The port used for the port mapping.</p>
2882
3231
  */
2883
3232
  port: number | undefined;
2884
3233
  /**
3234
+ * @public
2885
3235
  * <p>The protocol used for the port mapping. Specify one protocol.</p>
2886
3236
  */
2887
3237
  protocol: PortProtocol | string | undefined;
@@ -2892,12 +3242,14 @@ export interface PortMapping {
2892
3242
  */
2893
3243
  export interface GrpcTimeout {
2894
3244
  /**
3245
+ * @public
2895
3246
  * <p>An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh
2896
3247
  * resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15
2897
3248
  * seconds for the source and destination virtual node and the route.</p>
2898
3249
  */
2899
3250
  perRequest?: Duration;
2900
3251
  /**
3252
+ * @public
2901
3253
  * <p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>
2902
3254
  */
2903
3255
  idle?: Duration;
@@ -2908,12 +3260,14 @@ export interface GrpcTimeout {
2908
3260
  */
2909
3261
  export interface HttpTimeout {
2910
3262
  /**
3263
+ * @public
2911
3264
  * <p>An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh
2912
3265
  * resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15
2913
3266
  * seconds for the source and destination virtual node and the route.</p>
2914
3267
  */
2915
3268
  perRequest?: Duration;
2916
3269
  /**
3270
+ * @public
2917
3271
  * <p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>
2918
3272
  */
2919
3273
  idle?: Duration;
@@ -2924,6 +3278,7 @@ export interface HttpTimeout {
2924
3278
  */
2925
3279
  export interface TcpTimeout {
2926
3280
  /**
3281
+ * @public
2927
3282
  * <p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>
2928
3283
  */
2929
3284
  idle?: Duration;
@@ -2938,6 +3293,7 @@ export type ListenerTimeout = ListenerTimeout.GrpcMember | ListenerTimeout.HttpM
2938
3293
  */
2939
3294
  export declare namespace ListenerTimeout {
2940
3295
  /**
3296
+ * @public
2941
3297
  * <p>An object that represents types of timeouts. </p>
2942
3298
  */
2943
3299
  interface TcpMember {
@@ -2948,6 +3304,7 @@ export declare namespace ListenerTimeout {
2948
3304
  $unknown?: never;
2949
3305
  }
2950
3306
  /**
3307
+ * @public
2951
3308
  * <p>An object that represents types of timeouts. </p>
2952
3309
  */
2953
3310
  interface HttpMember {
@@ -2958,6 +3315,7 @@ export declare namespace ListenerTimeout {
2958
3315
  $unknown?: never;
2959
3316
  }
2960
3317
  /**
3318
+ * @public
2961
3319
  * <p>An object that represents types of timeouts. </p>
2962
3320
  */
2963
3321
  interface Http2Member {
@@ -2968,6 +3326,7 @@ export declare namespace ListenerTimeout {
2968
3326
  $unknown?: never;
2969
3327
  }
2970
3328
  /**
3329
+ * @public
2971
3330
  * <p>An object that represents types of timeouts. </p>
2972
3331
  */
2973
3332
  interface GrpcMember {
@@ -2977,6 +3336,9 @@ export declare namespace ListenerTimeout {
2977
3336
  grpc: GrpcTimeout;
2978
3337
  $unknown?: never;
2979
3338
  }
3339
+ /**
3340
+ * @public
3341
+ */
2980
3342
  interface $UnknownMember {
2981
3343
  tcp?: never;
2982
3344
  http?: never;
@@ -2999,6 +3361,7 @@ export declare namespace ListenerTimeout {
2999
3361
  */
3000
3362
  export interface ListenerTlsAcmCertificate {
3001
3363
  /**
3364
+ * @public
3002
3365
  * <p>The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites">Transport Layer Security (TLS)</a>.</p>
3003
3366
  */
3004
3367
  certificateArn: string | undefined;
@@ -3013,6 +3376,7 @@ export type ListenerTlsCertificate = ListenerTlsCertificate.AcmMember | Listener
3013
3376
  */
3014
3377
  export declare namespace ListenerTlsCertificate {
3015
3378
  /**
3379
+ * @public
3016
3380
  * <p>A reference to an object that represents an Certificate Manager certificate.</p>
3017
3381
  */
3018
3382
  interface AcmMember {
@@ -3022,6 +3386,7 @@ export declare namespace ListenerTlsCertificate {
3022
3386
  $unknown?: never;
3023
3387
  }
3024
3388
  /**
3389
+ * @public
3025
3390
  * <p>A reference to an object that represents a local file certificate.</p>
3026
3391
  */
3027
3392
  interface FileMember {
@@ -3031,6 +3396,7 @@ export declare namespace ListenerTlsCertificate {
3031
3396
  $unknown?: never;
3032
3397
  }
3033
3398
  /**
3399
+ * @public
3034
3400
  * <p>A reference to an object that represents a listener's Secret Discovery Service
3035
3401
  * certificate.</p>
3036
3402
  */
@@ -3040,6 +3406,9 @@ export declare namespace ListenerTlsCertificate {
3040
3406
  sds: ListenerTlsSdsCertificate;
3041
3407
  $unknown?: never;
3042
3408
  }
3409
+ /**
3410
+ * @public
3411
+ */
3043
3412
  interface $UnknownMember {
3044
3413
  acm?: never;
3045
3414
  file?: never;
@@ -3077,6 +3446,7 @@ export type ListenerTlsValidationContextTrust = ListenerTlsValidationContextTrus
3077
3446
  */
3078
3447
  export declare namespace ListenerTlsValidationContextTrust {
3079
3448
  /**
3449
+ * @public
3080
3450
  * <p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>
3081
3451
  */
3082
3452
  interface FileMember {
@@ -3085,6 +3455,7 @@ export declare namespace ListenerTlsValidationContextTrust {
3085
3455
  $unknown?: never;
3086
3456
  }
3087
3457
  /**
3458
+ * @public
3088
3459
  * <p>A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service
3089
3460
  * validation context trust.</p>
3090
3461
  */
@@ -3093,6 +3464,9 @@ export declare namespace ListenerTlsValidationContextTrust {
3093
3464
  sds: TlsValidationContextSdsTrust;
3094
3465
  $unknown?: never;
3095
3466
  }
3467
+ /**
3468
+ * @public
3469
+ */
3096
3470
  interface $UnknownMember {
3097
3471
  file?: never;
3098
3472
  sds?: never;
@@ -3111,11 +3485,13 @@ export declare namespace ListenerTlsValidationContextTrust {
3111
3485
  */
3112
3486
  export interface ListenerTlsValidationContext {
3113
3487
  /**
3488
+ * @public
3114
3489
  * <p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS)
3115
3490
  * certificate.</p>
3116
3491
  */
3117
3492
  trust: ListenerTlsValidationContextTrust | undefined;
3118
3493
  /**
3494
+ * @public
3119
3495
  * <p>A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation
3120
3496
  * context.</p>
3121
3497
  */
@@ -3127,6 +3503,7 @@ export interface ListenerTlsValidationContext {
3127
3503
  */
3128
3504
  export interface ListenerTls {
3129
3505
  /**
3506
+ * @public
3130
3507
  * <p>Specify one of the following modes.</p>
3131
3508
  * <ul>
3132
3509
  * <li>
@@ -3148,10 +3525,12 @@ export interface ListenerTls {
3148
3525
  */
3149
3526
  mode: ListenerTlsMode | string | undefined;
3150
3527
  /**
3528
+ * @public
3151
3529
  * <p>A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.</p>
3152
3530
  */
3153
3531
  certificate: ListenerTlsCertificate | undefined;
3154
3532
  /**
3533
+ * @public
3155
3534
  * <p>A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.</p>
3156
3535
  */
3157
3536
  validation?: ListenerTlsValidationContext;
@@ -3162,26 +3541,32 @@ export interface ListenerTls {
3162
3541
  */
3163
3542
  export interface Listener {
3164
3543
  /**
3544
+ * @public
3165
3545
  * <p>The port mapping information for the listener.</p>
3166
3546
  */
3167
3547
  portMapping: PortMapping | undefined;
3168
3548
  /**
3549
+ * @public
3169
3550
  * <p>A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.</p>
3170
3551
  */
3171
3552
  tls?: ListenerTls;
3172
3553
  /**
3554
+ * @public
3173
3555
  * <p>The health check information for the listener.</p>
3174
3556
  */
3175
3557
  healthCheck?: HealthCheckPolicy;
3176
3558
  /**
3559
+ * @public
3177
3560
  * <p>An object that represents timeouts for different protocols.</p>
3178
3561
  */
3179
3562
  timeout?: ListenerTimeout;
3180
3563
  /**
3564
+ * @public
3181
3565
  * <p>The outlier detection information for the listener.</p>
3182
3566
  */
3183
3567
  outlierDetection?: OutlierDetection;
3184
3568
  /**
3569
+ * @public
3185
3570
  * <p>The connection pool information for the listener.</p>
3186
3571
  */
3187
3572
  connectionPool?: VirtualNodeConnectionPool;
@@ -3192,6 +3577,7 @@ export interface Listener {
3192
3577
  */
3193
3578
  export interface Logging {
3194
3579
  /**
3580
+ * @public
3195
3581
  * <p>The access log configuration for a virtual node.</p>
3196
3582
  */
3197
3583
  accessLog?: AccessLog;
@@ -3206,11 +3592,13 @@ export interface Logging {
3206
3592
  */
3207
3593
  export interface AwsCloudMapInstanceAttribute {
3208
3594
  /**
3595
+ * @public
3209
3596
  * <p>The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is
3210
3597
  * returned.</p>
3211
3598
  */
3212
3599
  key: string | undefined;
3213
3600
  /**
3601
+ * @public
3214
3602
  * <p>The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is
3215
3603
  * returned.</p>
3216
3604
  */
@@ -3226,20 +3614,24 @@ export interface AwsCloudMapInstanceAttribute {
3226
3614
  */
3227
3615
  export interface AwsCloudMapServiceDiscovery {
3228
3616
  /**
3617
+ * @public
3229
3618
  * <p>The name of the Cloud Map namespace to use.</p>
3230
3619
  */
3231
3620
  namespaceName: string | undefined;
3232
3621
  /**
3622
+ * @public
3233
3623
  * <p>The name of the Cloud Map service to use.</p>
3234
3624
  */
3235
3625
  serviceName: string | undefined;
3236
3626
  /**
3627
+ * @public
3237
3628
  * <p>A string map that contains attributes with values that you can use to filter instances
3238
3629
  * by any custom attribute that you specified when you registered the instance. Only instances
3239
3630
  * that match all of the specified key/value pairs will be returned.</p>
3240
3631
  */
3241
3632
  attributes?: AwsCloudMapInstanceAttribute[];
3242
3633
  /**
3634
+ * @public
3243
3635
  * <p>The preferred IP version that this virtual node uses. Setting the IP preference on the
3244
3636
  * virtual node only overrides the IP preference set for the mesh on this specific
3245
3637
  * node.</p>
@@ -3265,14 +3657,17 @@ export type DnsResponseType = (typeof DnsResponseType)[keyof typeof DnsResponseT
3265
3657
  */
3266
3658
  export interface DnsServiceDiscovery {
3267
3659
  /**
3660
+ * @public
3268
3661
  * <p>Specifies the DNS service discovery hostname for the virtual node. </p>
3269
3662
  */
3270
3663
  hostname: string | undefined;
3271
3664
  /**
3665
+ * @public
3272
3666
  * <p>Specifies the DNS response type for the virtual node.</p>
3273
3667
  */
3274
3668
  responseType?: DnsResponseType | string;
3275
3669
  /**
3670
+ * @public
3276
3671
  * <p>The preferred IP version that this virtual node uses. Setting the IP preference on the
3277
3672
  * virtual node only overrides the IP preference set for the mesh on this specific
3278
3673
  * node.</p>
@@ -3289,6 +3684,7 @@ export type ServiceDiscovery = ServiceDiscovery.AwsCloudMapMember | ServiceDisco
3289
3684
  */
3290
3685
  export declare namespace ServiceDiscovery {
3291
3686
  /**
3687
+ * @public
3292
3688
  * <p>Specifies the DNS information for the virtual node.</p>
3293
3689
  */
3294
3690
  interface DnsMember {
@@ -3297,6 +3693,7 @@ export declare namespace ServiceDiscovery {
3297
3693
  $unknown?: never;
3298
3694
  }
3299
3695
  /**
3696
+ * @public
3300
3697
  * <p>Specifies any Cloud Map information for the virtual node.</p>
3301
3698
  */
3302
3699
  interface AwsCloudMapMember {
@@ -3304,6 +3701,9 @@ export declare namespace ServiceDiscovery {
3304
3701
  awsCloudMap: AwsCloudMapServiceDiscovery;
3305
3702
  $unknown?: never;
3306
3703
  }
3704
+ /**
3705
+ * @public
3706
+ */
3307
3707
  interface $UnknownMember {
3308
3708
  dns?: never;
3309
3709
  awsCloudMap?: never;
@@ -3322,25 +3722,30 @@ export declare namespace ServiceDiscovery {
3322
3722
  */
3323
3723
  export interface VirtualNodeSpec {
3324
3724
  /**
3725
+ * @public
3325
3726
  * <p>The service discovery information for the virtual node. If your virtual node does not
3326
3727
  * expect ingress traffic, you can omit this parameter. If you specify a
3327
3728
  * <code>listener</code>, then you must specify service discovery information.</p>
3328
3729
  */
3329
3730
  serviceDiscovery?: ServiceDiscovery;
3330
3731
  /**
3732
+ * @public
3331
3733
  * <p>The listener that the virtual node is expected to receive inbound traffic from. You can
3332
3734
  * specify one listener.</p>
3333
3735
  */
3334
3736
  listeners?: Listener[];
3335
3737
  /**
3738
+ * @public
3336
3739
  * <p>The backends that the virtual node is expected to send outbound traffic to.</p>
3337
3740
  */
3338
3741
  backends?: Backend[];
3339
3742
  /**
3743
+ * @public
3340
3744
  * <p>A reference to an object that represents the defaults for backends.</p>
3341
3745
  */
3342
3746
  backendDefaults?: BackendDefaults;
3343
3747
  /**
3748
+ * @public
3344
3749
  * <p>The inbound and outbound access logging information for the virtual node.</p>
3345
3750
  */
3346
3751
  logging?: Logging;
@@ -3351,18 +3756,22 @@ export interface VirtualNodeSpec {
3351
3756
  */
3352
3757
  export interface CreateVirtualNodeInput {
3353
3758
  /**
3759
+ * @public
3354
3760
  * <p>The name to use for the virtual node.</p>
3355
3761
  */
3356
3762
  virtualNodeName: string | undefined;
3357
3763
  /**
3764
+ * @public
3358
3765
  * <p>The name of the service mesh to create the virtual node in.</p>
3359
3766
  */
3360
3767
  meshName: string | undefined;
3361
3768
  /**
3769
+ * @public
3362
3770
  * <p>The virtual node specification to apply.</p>
3363
3771
  */
3364
3772
  spec: VirtualNodeSpec | undefined;
3365
3773
  /**
3774
+ * @public
3366
3775
  * <p>Optional metadata that you can apply to the virtual node to assist with categorization
3367
3776
  * and organization. Each tag consists of a key and an optional value, both of which you
3368
3777
  * define. Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -3370,11 +3779,13 @@ export interface CreateVirtualNodeInput {
3370
3779
  */
3371
3780
  tags?: TagRef[];
3372
3781
  /**
3782
+ * @public
3373
3783
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3374
3784
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
3375
3785
  */
3376
3786
  clientToken?: string;
3377
3787
  /**
3788
+ * @public
3378
3789
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
3379
3790
  * the account that you specify must share the mesh with your account before you can create
3380
3791
  * the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
@@ -3400,6 +3811,7 @@ export type VirtualNodeStatusCode = (typeof VirtualNodeStatusCode)[keyof typeof
3400
3811
  */
3401
3812
  export interface VirtualNodeStatus {
3402
3813
  /**
3814
+ * @public
3403
3815
  * <p>The current status of the virtual node.</p>
3404
3816
  */
3405
3817
  status: VirtualNodeStatusCode | string | undefined;
@@ -3410,22 +3822,27 @@ export interface VirtualNodeStatus {
3410
3822
  */
3411
3823
  export interface VirtualNodeData {
3412
3824
  /**
3825
+ * @public
3413
3826
  * <p>The name of the service mesh that the virtual node resides in.</p>
3414
3827
  */
3415
3828
  meshName: string | undefined;
3416
3829
  /**
3830
+ * @public
3417
3831
  * <p>The name of the virtual node.</p>
3418
3832
  */
3419
3833
  virtualNodeName: string | undefined;
3420
3834
  /**
3835
+ * @public
3421
3836
  * <p>The specifications of the virtual node.</p>
3422
3837
  */
3423
3838
  spec: VirtualNodeSpec | undefined;
3424
3839
  /**
3840
+ * @public
3425
3841
  * <p>The associated metadata for the virtual node.</p>
3426
3842
  */
3427
3843
  metadata: ResourceMetadata | undefined;
3428
3844
  /**
3845
+ * @public
3429
3846
  * <p>The current status for the virtual node.</p>
3430
3847
  */
3431
3848
  status: VirtualNodeStatus | undefined;
@@ -3436,6 +3853,7 @@ export interface VirtualNodeData {
3436
3853
  */
3437
3854
  export interface CreateVirtualNodeOutput {
3438
3855
  /**
3856
+ * @public
3439
3857
  * <p>The full description of your virtual node following the create call.</p>
3440
3858
  */
3441
3859
  virtualNode: VirtualNodeData | undefined;
@@ -3446,14 +3864,17 @@ export interface CreateVirtualNodeOutput {
3446
3864
  */
3447
3865
  export interface DeleteVirtualNodeInput {
3448
3866
  /**
3867
+ * @public
3449
3868
  * <p>The name of the virtual node to delete.</p>
3450
3869
  */
3451
3870
  virtualNodeName: string | undefined;
3452
3871
  /**
3872
+ * @public
3453
3873
  * <p>The name of the service mesh to delete the virtual node in.</p>
3454
3874
  */
3455
3875
  meshName: string | undefined;
3456
3876
  /**
3877
+ * @public
3457
3878
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3458
3879
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3459
3880
  */
@@ -3465,6 +3886,7 @@ export interface DeleteVirtualNodeInput {
3465
3886
  */
3466
3887
  export interface DeleteVirtualNodeOutput {
3467
3888
  /**
3889
+ * @public
3468
3890
  * <p>The virtual node that was deleted.</p>
3469
3891
  */
3470
3892
  virtualNode: VirtualNodeData | undefined;
@@ -3475,14 +3897,17 @@ export interface DeleteVirtualNodeOutput {
3475
3897
  */
3476
3898
  export interface DescribeVirtualNodeInput {
3477
3899
  /**
3900
+ * @public
3478
3901
  * <p>The name of the virtual node to describe.</p>
3479
3902
  */
3480
3903
  virtualNodeName: string | undefined;
3481
3904
  /**
3905
+ * @public
3482
3906
  * <p>The name of the service mesh that the virtual node resides in.</p>
3483
3907
  */
3484
3908
  meshName: string | undefined;
3485
3909
  /**
3910
+ * @public
3486
3911
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3487
3912
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3488
3913
  */
@@ -3494,6 +3919,7 @@ export interface DescribeVirtualNodeInput {
3494
3919
  */
3495
3920
  export interface DescribeVirtualNodeOutput {
3496
3921
  /**
3922
+ * @public
3497
3923
  * <p>The full description of your virtual node.</p>
3498
3924
  */
3499
3925
  virtualNode: VirtualNodeData | undefined;
@@ -3504,10 +3930,12 @@ export interface DescribeVirtualNodeOutput {
3504
3930
  */
3505
3931
  export interface ListVirtualNodesInput {
3506
3932
  /**
3933
+ * @public
3507
3934
  * <p>The name of the service mesh to list virtual nodes in.</p>
3508
3935
  */
3509
3936
  meshName: string | undefined;
3510
3937
  /**
3938
+ * @public
3511
3939
  * <p>The <code>nextToken</code> value returned from a previous paginated
3512
3940
  * <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results
3513
3941
  * exceeded the value of that parameter. Pagination continues from the end of the previous
@@ -3515,6 +3943,7 @@ export interface ListVirtualNodesInput {
3515
3943
  */
3516
3944
  nextToken?: string;
3517
3945
  /**
3946
+ * @public
3518
3947
  * <p>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated
3519
3948
  * output. When you use this parameter, <code>ListVirtualNodes</code> returns only
3520
3949
  * <code>limit</code> results in a single page along with a <code>nextToken</code> response
@@ -3526,6 +3955,7 @@ export interface ListVirtualNodesInput {
3526
3955
  */
3527
3956
  limit?: number;
3528
3957
  /**
3958
+ * @public
3529
3959
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3530
3960
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3531
3961
  */
@@ -3537,36 +3967,44 @@ export interface ListVirtualNodesInput {
3537
3967
  */
3538
3968
  export interface VirtualNodeRef {
3539
3969
  /**
3970
+ * @public
3540
3971
  * <p>The name of the service mesh that the virtual node resides in.</p>
3541
3972
  */
3542
3973
  meshName: string | undefined;
3543
3974
  /**
3975
+ * @public
3544
3976
  * <p>The name of the virtual node.</p>
3545
3977
  */
3546
3978
  virtualNodeName: string | undefined;
3547
3979
  /**
3980
+ * @public
3548
3981
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3549
3982
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3550
3983
  */
3551
3984
  meshOwner: string | undefined;
3552
3985
  /**
3986
+ * @public
3553
3987
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
3554
3988
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3555
3989
  */
3556
3990
  resourceOwner: string | undefined;
3557
3991
  /**
3992
+ * @public
3558
3993
  * <p>The full Amazon Resource Name (ARN) for the virtual node.</p>
3559
3994
  */
3560
3995
  arn: string | undefined;
3561
3996
  /**
3997
+ * @public
3562
3998
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
3563
3999
  */
3564
4000
  version: number | undefined;
3565
4001
  /**
4002
+ * @public
3566
4003
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
3567
4004
  */
3568
4005
  createdAt: Date | undefined;
3569
4006
  /**
4007
+ * @public
3570
4008
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
3571
4009
  */
3572
4010
  lastUpdatedAt: Date | undefined;
@@ -3577,10 +4015,12 @@ export interface VirtualNodeRef {
3577
4015
  */
3578
4016
  export interface ListVirtualNodesOutput {
3579
4017
  /**
4018
+ * @public
3580
4019
  * <p>The list of existing virtual nodes for the specified service mesh.</p>
3581
4020
  */
3582
4021
  virtualNodes: VirtualNodeRef[] | undefined;
3583
4022
  /**
4023
+ * @public
3584
4024
  * <p>The <code>nextToken</code> value to include in a future <code>ListVirtualNodes</code>
3585
4025
  * request. When the results of a <code>ListVirtualNodes</code> request exceed
3586
4026
  * <code>limit</code>, you can use this value to retrieve the next page of results. This
@@ -3594,23 +4034,28 @@ export interface ListVirtualNodesOutput {
3594
4034
  */
3595
4035
  export interface UpdateVirtualNodeInput {
3596
4036
  /**
4037
+ * @public
3597
4038
  * <p>The name of the virtual node to update.</p>
3598
4039
  */
3599
4040
  virtualNodeName: string | undefined;
3600
4041
  /**
4042
+ * @public
3601
4043
  * <p>The name of the service mesh that the virtual node resides in.</p>
3602
4044
  */
3603
4045
  meshName: string | undefined;
3604
4046
  /**
4047
+ * @public
3605
4048
  * <p>The new virtual node specification to apply. This overwrites the existing data.</p>
3606
4049
  */
3607
4050
  spec: VirtualNodeSpec | undefined;
3608
4051
  /**
4052
+ * @public
3609
4053
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3610
4054
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
3611
4055
  */
3612
4056
  clientToken?: string;
3613
4057
  /**
4058
+ * @public
3614
4059
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3615
4060
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3616
4061
  */
@@ -3622,6 +4067,7 @@ export interface UpdateVirtualNodeInput {
3622
4067
  */
3623
4068
  export interface UpdateVirtualNodeOutput {
3624
4069
  /**
4070
+ * @public
3625
4071
  * <p>A full description of the virtual node that was updated.</p>
3626
4072
  */
3627
4073
  virtualNode: VirtualNodeData | undefined;
@@ -3632,6 +4078,7 @@ export interface UpdateVirtualNodeOutput {
3632
4078
  */
3633
4079
  export interface VirtualRouterListener {
3634
4080
  /**
4081
+ * @public
3635
4082
  * <p>An object that represents a port mapping.</p>
3636
4083
  */
3637
4084
  portMapping: PortMapping | undefined;
@@ -3642,6 +4089,7 @@ export interface VirtualRouterListener {
3642
4089
  */
3643
4090
  export interface VirtualRouterSpec {
3644
4091
  /**
4092
+ * @public
3645
4093
  * <p>The listeners that the virtual router is expected to receive inbound traffic from. You
3646
4094
  * can specify one listener.</p>
3647
4095
  */
@@ -3653,18 +4101,22 @@ export interface VirtualRouterSpec {
3653
4101
  */
3654
4102
  export interface CreateVirtualRouterInput {
3655
4103
  /**
4104
+ * @public
3656
4105
  * <p>The name to use for the virtual router.</p>
3657
4106
  */
3658
4107
  virtualRouterName: string | undefined;
3659
4108
  /**
4109
+ * @public
3660
4110
  * <p>The name of the service mesh to create the virtual router in.</p>
3661
4111
  */
3662
4112
  meshName: string | undefined;
3663
4113
  /**
4114
+ * @public
3664
4115
  * <p>The virtual router specification to apply.</p>
3665
4116
  */
3666
4117
  spec: VirtualRouterSpec | undefined;
3667
4118
  /**
4119
+ * @public
3668
4120
  * <p>Optional metadata that you can apply to the virtual router to assist with categorization
3669
4121
  * and organization. Each tag consists of a key and an optional value, both of which you
3670
4122
  * define. Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -3672,11 +4124,13 @@ export interface CreateVirtualRouterInput {
3672
4124
  */
3673
4125
  tags?: TagRef[];
3674
4126
  /**
4127
+ * @public
3675
4128
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
3676
4129
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
3677
4130
  */
3678
4131
  clientToken?: string;
3679
4132
  /**
4133
+ * @public
3680
4134
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
3681
4135
  * the account that you specify must share the mesh with your account before you can create
3682
4136
  * the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
@@ -3702,6 +4156,7 @@ export type VirtualRouterStatusCode = (typeof VirtualRouterStatusCode)[keyof typ
3702
4156
  */
3703
4157
  export interface VirtualRouterStatus {
3704
4158
  /**
4159
+ * @public
3705
4160
  * <p>The current status of the virtual router.</p>
3706
4161
  */
3707
4162
  status: VirtualRouterStatusCode | string | undefined;
@@ -3712,22 +4167,27 @@ export interface VirtualRouterStatus {
3712
4167
  */
3713
4168
  export interface VirtualRouterData {
3714
4169
  /**
4170
+ * @public
3715
4171
  * <p>The name of the service mesh that the virtual router resides in.</p>
3716
4172
  */
3717
4173
  meshName: string | undefined;
3718
4174
  /**
4175
+ * @public
3719
4176
  * <p>The name of the virtual router.</p>
3720
4177
  */
3721
4178
  virtualRouterName: string | undefined;
3722
4179
  /**
4180
+ * @public
3723
4181
  * <p>The specifications of the virtual router.</p>
3724
4182
  */
3725
4183
  spec: VirtualRouterSpec | undefined;
3726
4184
  /**
4185
+ * @public
3727
4186
  * <p>The associated metadata for the virtual router.</p>
3728
4187
  */
3729
4188
  metadata: ResourceMetadata | undefined;
3730
4189
  /**
4190
+ * @public
3731
4191
  * <p>The current status of the virtual router.</p>
3732
4192
  */
3733
4193
  status: VirtualRouterStatus | undefined;
@@ -3738,6 +4198,7 @@ export interface VirtualRouterData {
3738
4198
  */
3739
4199
  export interface CreateVirtualRouterOutput {
3740
4200
  /**
4201
+ * @public
3741
4202
  * <p>The full description of your virtual router following the create call.</p>
3742
4203
  */
3743
4204
  virtualRouter: VirtualRouterData | undefined;
@@ -3748,14 +4209,17 @@ export interface CreateVirtualRouterOutput {
3748
4209
  */
3749
4210
  export interface DeleteVirtualRouterInput {
3750
4211
  /**
4212
+ * @public
3751
4213
  * <p>The name of the virtual router to delete.</p>
3752
4214
  */
3753
4215
  virtualRouterName: string | undefined;
3754
4216
  /**
4217
+ * @public
3755
4218
  * <p>The name of the service mesh to delete the virtual router in.</p>
3756
4219
  */
3757
4220
  meshName: string | undefined;
3758
4221
  /**
4222
+ * @public
3759
4223
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3760
4224
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3761
4225
  */
@@ -3767,6 +4231,7 @@ export interface DeleteVirtualRouterInput {
3767
4231
  */
3768
4232
  export interface DeleteVirtualRouterOutput {
3769
4233
  /**
4234
+ * @public
3770
4235
  * <p>The virtual router that was deleted.</p>
3771
4236
  */
3772
4237
  virtualRouter: VirtualRouterData | undefined;
@@ -3777,14 +4242,17 @@ export interface DeleteVirtualRouterOutput {
3777
4242
  */
3778
4243
  export interface DescribeVirtualRouterInput {
3779
4244
  /**
4245
+ * @public
3780
4246
  * <p>The name of the virtual router to describe.</p>
3781
4247
  */
3782
4248
  virtualRouterName: string | undefined;
3783
4249
  /**
4250
+ * @public
3784
4251
  * <p>The name of the service mesh that the virtual router resides in.</p>
3785
4252
  */
3786
4253
  meshName: string | undefined;
3787
4254
  /**
4255
+ * @public
3788
4256
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3789
4257
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3790
4258
  */
@@ -3796,6 +4264,7 @@ export interface DescribeVirtualRouterInput {
3796
4264
  */
3797
4265
  export interface DescribeVirtualRouterOutput {
3798
4266
  /**
4267
+ * @public
3799
4268
  * <p>The full description of your virtual router.</p>
3800
4269
  */
3801
4270
  virtualRouter: VirtualRouterData | undefined;
@@ -3806,10 +4275,12 @@ export interface DescribeVirtualRouterOutput {
3806
4275
  */
3807
4276
  export interface ListVirtualRoutersInput {
3808
4277
  /**
4278
+ * @public
3809
4279
  * <p>The name of the service mesh to list virtual routers in.</p>
3810
4280
  */
3811
4281
  meshName: string | undefined;
3812
4282
  /**
4283
+ * @public
3813
4284
  * <p>The <code>nextToken</code> value returned from a previous paginated
3814
4285
  * <code>ListVirtualRouters</code> request where <code>limit</code> was used and the
3815
4286
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -3817,6 +4288,7 @@ export interface ListVirtualRoutersInput {
3817
4288
  */
3818
4289
  nextToken?: string;
3819
4290
  /**
4291
+ * @public
3820
4292
  * <p>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated
3821
4293
  * output. When you use this parameter, <code>ListVirtualRouters</code> returns only
3822
4294
  * <code>limit</code> results in a single page along with a <code>nextToken</code> response
@@ -3828,6 +4300,7 @@ export interface ListVirtualRoutersInput {
3828
4300
  */
3829
4301
  limit?: number;
3830
4302
  /**
4303
+ * @public
3831
4304
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3832
4305
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3833
4306
  */
@@ -3839,36 +4312,44 @@ export interface ListVirtualRoutersInput {
3839
4312
  */
3840
4313
  export interface VirtualRouterRef {
3841
4314
  /**
4315
+ * @public
3842
4316
  * <p>The name of the service mesh that the virtual router resides in.</p>
3843
4317
  */
3844
4318
  meshName: string | undefined;
3845
4319
  /**
4320
+ * @public
3846
4321
  * <p>The name of the virtual router.</p>
3847
4322
  */
3848
4323
  virtualRouterName: string | undefined;
3849
4324
  /**
4325
+ * @public
3850
4326
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
3851
4327
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3852
4328
  */
3853
4329
  meshOwner: string | undefined;
3854
4330
  /**
4331
+ * @public
3855
4332
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
3856
4333
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
3857
4334
  */
3858
4335
  resourceOwner: string | undefined;
3859
4336
  /**
4337
+ * @public
3860
4338
  * <p>The full Amazon Resource Name (ARN) for the virtual router.</p>
3861
4339
  */
3862
4340
  arn: string | undefined;
3863
4341
  /**
4342
+ * @public
3864
4343
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
3865
4344
  */
3866
4345
  version: number | undefined;
3867
4346
  /**
4347
+ * @public
3868
4348
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
3869
4349
  */
3870
4350
  createdAt: Date | undefined;
3871
4351
  /**
4352
+ * @public
3872
4353
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
3873
4354
  */
3874
4355
  lastUpdatedAt: Date | undefined;
@@ -3879,10 +4360,12 @@ export interface VirtualRouterRef {
3879
4360
  */
3880
4361
  export interface ListVirtualRoutersOutput {
3881
4362
  /**
4363
+ * @public
3882
4364
  * <p>The list of existing virtual routers for the specified service mesh.</p>
3883
4365
  */
3884
4366
  virtualRouters: VirtualRouterRef[] | undefined;
3885
4367
  /**
4368
+ * @public
3886
4369
  * <p>The <code>nextToken</code> value to include in a future <code>ListVirtualRouters</code>
3887
4370
  * request. When the results of a <code>ListVirtualRouters</code> request exceed
3888
4371
  * <code>limit</code>, you can use this value to retrieve the next page of results. This
@@ -3899,14 +4382,17 @@ export interface ListVirtualRoutersOutput {
3899
4382
  */
3900
4383
  export interface WeightedTarget {
3901
4384
  /**
4385
+ * @public
3902
4386
  * <p>The virtual node to associate with the weighted target.</p>
3903
4387
  */
3904
4388
  virtualNode: string | undefined;
3905
4389
  /**
4390
+ * @public
3906
4391
  * <p>The relative weight of the weighted target.</p>
3907
4392
  */
3908
4393
  weight: number | undefined;
3909
4394
  /**
4395
+ * @public
3910
4396
  * <p>The targeted port of the weighted object.</p>
3911
4397
  */
3912
4398
  port?: number;
@@ -3917,6 +4403,7 @@ export interface WeightedTarget {
3917
4403
  */
3918
4404
  export interface GrpcRouteAction {
3919
4405
  /**
4406
+ * @public
3920
4407
  * <p>An object that represents the targets that traffic is routed to when a request matches the route.</p>
3921
4408
  */
3922
4409
  weightedTargets: WeightedTarget[] | undefined;
@@ -3931,6 +4418,7 @@ export type GrpcRouteMetadataMatchMethod = GrpcRouteMetadataMatchMethod.ExactMem
3931
4418
  */
3932
4419
  export declare namespace GrpcRouteMetadataMatchMethod {
3933
4420
  /**
4421
+ * @public
3934
4422
  * <p>The value sent by the client must match the specified value exactly.</p>
3935
4423
  */
3936
4424
  interface ExactMember {
@@ -3942,6 +4430,7 @@ export declare namespace GrpcRouteMetadataMatchMethod {
3942
4430
  $unknown?: never;
3943
4431
  }
3944
4432
  /**
4433
+ * @public
3945
4434
  * <p>The value sent by the client must include the specified characters.</p>
3946
4435
  */
3947
4436
  interface RegexMember {
@@ -3953,6 +4442,7 @@ export declare namespace GrpcRouteMetadataMatchMethod {
3953
4442
  $unknown?: never;
3954
4443
  }
3955
4444
  /**
4445
+ * @public
3956
4446
  * <p>An object that represents the range of values to match on.</p>
3957
4447
  */
3958
4448
  interface RangeMember {
@@ -3964,6 +4454,7 @@ export declare namespace GrpcRouteMetadataMatchMethod {
3964
4454
  $unknown?: never;
3965
4455
  }
3966
4456
  /**
4457
+ * @public
3967
4458
  * <p>The value sent by the client must begin with the specified characters.</p>
3968
4459
  */
3969
4460
  interface PrefixMember {
@@ -3975,6 +4466,7 @@ export declare namespace GrpcRouteMetadataMatchMethod {
3975
4466
  $unknown?: never;
3976
4467
  }
3977
4468
  /**
4469
+ * @public
3978
4470
  * <p>The value sent by the client must end with the specified characters.</p>
3979
4471
  */
3980
4472
  interface SuffixMember {
@@ -3985,6 +4477,9 @@ export declare namespace GrpcRouteMetadataMatchMethod {
3985
4477
  suffix: string;
3986
4478
  $unknown?: never;
3987
4479
  }
4480
+ /**
4481
+ * @public
4482
+ */
3988
4483
  interface $UnknownMember {
3989
4484
  exact?: never;
3990
4485
  regex?: never;
@@ -4009,14 +4504,17 @@ export declare namespace GrpcRouteMetadataMatchMethod {
4009
4504
  */
4010
4505
  export interface GrpcRouteMetadata {
4011
4506
  /**
4507
+ * @public
4012
4508
  * <p>The name of the route.</p>
4013
4509
  */
4014
4510
  name: string | undefined;
4015
4511
  /**
4512
+ * @public
4016
4513
  * <p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>
4017
4514
  */
4018
4515
  invert?: boolean;
4019
4516
  /**
4517
+ * @public
4020
4518
  * <p>An object that represents the data to match from the request.</p>
4021
4519
  */
4022
4520
  match?: GrpcRouteMetadataMatchMethod;
@@ -4027,19 +4525,23 @@ export interface GrpcRouteMetadata {
4027
4525
  */
4028
4526
  export interface GrpcRouteMatch {
4029
4527
  /**
4528
+ * @public
4030
4529
  * <p>The fully qualified domain name for the service to match from the request.</p>
4031
4530
  */
4032
4531
  serviceName?: string;
4033
4532
  /**
4533
+ * @public
4034
4534
  * <p>The method name to match from the request. If you specify a name, you must also specify
4035
4535
  * a <code>serviceName</code>.</p>
4036
4536
  */
4037
4537
  methodName?: string;
4038
4538
  /**
4539
+ * @public
4039
4540
  * <p>An object that represents the data to match from the request.</p>
4040
4541
  */
4041
4542
  metadata?: GrpcRouteMetadata[];
4042
4543
  /**
4544
+ * @public
4043
4545
  * <p>The port number to match on.</p>
4044
4546
  */
4045
4547
  port?: number;
@@ -4078,14 +4580,17 @@ export type TcpRetryPolicyEvent = (typeof TcpRetryPolicyEvent)[keyof typeof TcpR
4078
4580
  */
4079
4581
  export interface GrpcRetryPolicy {
4080
4582
  /**
4583
+ * @public
4081
4584
  * <p>The timeout for each retry attempt.</p>
4082
4585
  */
4083
4586
  perRetryTimeout: Duration | undefined;
4084
4587
  /**
4588
+ * @public
4085
4589
  * <p>The maximum number of retry attempts.</p>
4086
4590
  */
4087
4591
  maxRetries: number | undefined;
4088
4592
  /**
4593
+ * @public
4089
4594
  * <p>Specify at least one of the following values.</p>
4090
4595
  * <ul>
4091
4596
  * <li>
@@ -4111,10 +4616,12 @@ export interface GrpcRetryPolicy {
4111
4616
  */
4112
4617
  httpRetryEvents?: string[];
4113
4618
  /**
4619
+ * @public
4114
4620
  * <p>Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.</p>
4115
4621
  */
4116
4622
  tcpRetryEvents?: (TcpRetryPolicyEvent | string)[];
4117
4623
  /**
4624
+ * @public
4118
4625
  * <p>Specify at least one of the valid values.</p>
4119
4626
  */
4120
4627
  grpcRetryEvents?: (GrpcRetryPolicyEvent | string)[];
@@ -4125,18 +4632,22 @@ export interface GrpcRetryPolicy {
4125
4632
  */
4126
4633
  export interface GrpcRoute {
4127
4634
  /**
4635
+ * @public
4128
4636
  * <p>An object that represents the action to take if a match is determined.</p>
4129
4637
  */
4130
4638
  action: GrpcRouteAction | undefined;
4131
4639
  /**
4640
+ * @public
4132
4641
  * <p>An object that represents the criteria for determining a request match.</p>
4133
4642
  */
4134
4643
  match: GrpcRouteMatch | undefined;
4135
4644
  /**
4645
+ * @public
4136
4646
  * <p>An object that represents a retry policy.</p>
4137
4647
  */
4138
4648
  retryPolicy?: GrpcRetryPolicy;
4139
4649
  /**
4650
+ * @public
4140
4651
  * <p>An object that represents types of timeouts. </p>
4141
4652
  */
4142
4653
  timeout?: GrpcTimeout;
@@ -4147,6 +4658,7 @@ export interface GrpcRoute {
4147
4658
  */
4148
4659
  export interface HttpRouteAction {
4149
4660
  /**
4661
+ * @public
4150
4662
  * <p>An object that represents the targets that traffic is routed to when a request matches the route.</p>
4151
4663
  */
4152
4664
  weightedTargets: WeightedTarget[] | undefined;
@@ -4157,14 +4669,17 @@ export interface HttpRouteAction {
4157
4669
  */
4158
4670
  export interface HttpRouteHeader {
4159
4671
  /**
4672
+ * @public
4160
4673
  * <p>A name for the HTTP header in the client request that will be matched on.</p>
4161
4674
  */
4162
4675
  name: string | undefined;
4163
4676
  /**
4677
+ * @public
4164
4678
  * <p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>
4165
4679
  */
4166
4680
  invert?: boolean;
4167
4681
  /**
4682
+ * @public
4168
4683
  * <p>The <code>HeaderMatchMethod</code> object.</p>
4169
4684
  */
4170
4685
  match?: HeaderMatchMethod;
@@ -4188,6 +4703,7 @@ export type HttpScheme = (typeof HttpScheme)[keyof typeof HttpScheme];
4188
4703
  */
4189
4704
  export interface HttpRouteMatch {
4190
4705
  /**
4706
+ * @public
4191
4707
  * <p>Specifies the path to match requests with. This parameter must always start with
4192
4708
  * <code>/</code>, which by itself matches all requests to the virtual service name. You
4193
4709
  * can also match for path-based routing of requests. For example, if your virtual service
@@ -4197,27 +4713,33 @@ export interface HttpRouteMatch {
4197
4713
  */
4198
4714
  prefix?: string;
4199
4715
  /**
4716
+ * @public
4200
4717
  * <p>The client request path to match on.</p>
4201
4718
  */
4202
4719
  path?: HttpPathMatch;
4203
4720
  /**
4721
+ * @public
4204
4722
  * <p>The client request query parameters to match on.</p>
4205
4723
  */
4206
4724
  queryParameters?: HttpQueryParameter[];
4207
4725
  /**
4726
+ * @public
4208
4727
  * <p>The client request method to match on. Specify only one.</p>
4209
4728
  */
4210
4729
  method?: HttpMethod | string;
4211
4730
  /**
4731
+ * @public
4212
4732
  * <p>The client request scheme to match on. Specify only one. Applicable only for HTTP2
4213
4733
  * routes.</p>
4214
4734
  */
4215
4735
  scheme?: HttpScheme | string;
4216
4736
  /**
4737
+ * @public
4217
4738
  * <p>The client request headers to match on.</p>
4218
4739
  */
4219
4740
  headers?: HttpRouteHeader[];
4220
4741
  /**
4742
+ * @public
4221
4743
  * <p>The port number to match on.</p>
4222
4744
  */
4223
4745
  port?: number;
@@ -4230,14 +4752,17 @@ export interface HttpRouteMatch {
4230
4752
  */
4231
4753
  export interface HttpRetryPolicy {
4232
4754
  /**
4755
+ * @public
4233
4756
  * <p>The timeout for each retry attempt.</p>
4234
4757
  */
4235
4758
  perRetryTimeout: Duration | undefined;
4236
4759
  /**
4760
+ * @public
4237
4761
  * <p>The maximum number of retry attempts.</p>
4238
4762
  */
4239
4763
  maxRetries: number | undefined;
4240
4764
  /**
4765
+ * @public
4241
4766
  * <p>Specify at least one of the following values.</p>
4242
4767
  * <ul>
4243
4768
  * <li>
@@ -4263,6 +4788,7 @@ export interface HttpRetryPolicy {
4263
4788
  */
4264
4789
  httpRetryEvents?: string[];
4265
4790
  /**
4791
+ * @public
4266
4792
  * <p>Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.</p>
4267
4793
  */
4268
4794
  tcpRetryEvents?: (TcpRetryPolicyEvent | string)[];
@@ -4273,18 +4799,22 @@ export interface HttpRetryPolicy {
4273
4799
  */
4274
4800
  export interface HttpRoute {
4275
4801
  /**
4802
+ * @public
4276
4803
  * <p>An object that represents the criteria for determining a request match.</p>
4277
4804
  */
4278
4805
  match: HttpRouteMatch | undefined;
4279
4806
  /**
4807
+ * @public
4280
4808
  * <p>An object that represents the action to take if a match is determined.</p>
4281
4809
  */
4282
4810
  action: HttpRouteAction | undefined;
4283
4811
  /**
4812
+ * @public
4284
4813
  * <p>An object that represents a retry policy.</p>
4285
4814
  */
4286
4815
  retryPolicy?: HttpRetryPolicy;
4287
4816
  /**
4817
+ * @public
4288
4818
  * <p>An object that represents types of timeouts. </p>
4289
4819
  */
4290
4820
  timeout?: HttpTimeout;
@@ -4295,6 +4825,7 @@ export interface HttpRoute {
4295
4825
  */
4296
4826
  export interface TcpRouteAction {
4297
4827
  /**
4828
+ * @public
4298
4829
  * <p>An object that represents the targets that traffic is routed to when a request matches the route.</p>
4299
4830
  */
4300
4831
  weightedTargets: WeightedTarget[] | undefined;
@@ -4305,6 +4836,7 @@ export interface TcpRouteAction {
4305
4836
  */
4306
4837
  export interface TcpRouteMatch {
4307
4838
  /**
4839
+ * @public
4308
4840
  * <p>The port number to match on.</p>
4309
4841
  */
4310
4842
  port?: number;
@@ -4315,14 +4847,17 @@ export interface TcpRouteMatch {
4315
4847
  */
4316
4848
  export interface TcpRoute {
4317
4849
  /**
4850
+ * @public
4318
4851
  * <p>The action to take if a match is determined.</p>
4319
4852
  */
4320
4853
  action: TcpRouteAction | undefined;
4321
4854
  /**
4855
+ * @public
4322
4856
  * <p>An object that represents types of timeouts. </p>
4323
4857
  */
4324
4858
  timeout?: TcpTimeout;
4325
4859
  /**
4860
+ * @public
4326
4861
  * <p>An object that represents the criteria for determining a request match.</p>
4327
4862
  */
4328
4863
  match?: TcpRouteMatch;
@@ -4333,23 +4868,28 @@ export interface TcpRoute {
4333
4868
  */
4334
4869
  export interface RouteSpec {
4335
4870
  /**
4871
+ * @public
4336
4872
  * <p>The priority for the route. Routes are matched based on the specified value, where 0 is
4337
4873
  * the highest priority.</p>
4338
4874
  */
4339
4875
  priority?: number;
4340
4876
  /**
4877
+ * @public
4341
4878
  * <p>An object that represents the specification of an HTTP route.</p>
4342
4879
  */
4343
4880
  httpRoute?: HttpRoute;
4344
4881
  /**
4882
+ * @public
4345
4883
  * <p>An object that represents the specification of a TCP route.</p>
4346
4884
  */
4347
4885
  tcpRoute?: TcpRoute;
4348
4886
  /**
4887
+ * @public
4349
4888
  * <p>An object that represents the specification of an HTTP/2 route.</p>
4350
4889
  */
4351
4890
  http2Route?: HttpRoute;
4352
4891
  /**
4892
+ * @public
4353
4893
  * <p>An object that represents the specification of a gRPC route.</p>
4354
4894
  */
4355
4895
  grpcRoute?: GrpcRoute;
@@ -4360,23 +4900,28 @@ export interface RouteSpec {
4360
4900
  */
4361
4901
  export interface CreateRouteInput {
4362
4902
  /**
4903
+ * @public
4363
4904
  * <p>The name to use for the route.</p>
4364
4905
  */
4365
4906
  routeName: string | undefined;
4366
4907
  /**
4908
+ * @public
4367
4909
  * <p>The name of the service mesh to create the route in.</p>
4368
4910
  */
4369
4911
  meshName: string | undefined;
4370
4912
  /**
4913
+ * @public
4371
4914
  * <p>The name of the virtual router in which to create the route. If the virtual router is in
4372
4915
  * a shared mesh, then you must be the owner of the virtual router resource.</p>
4373
4916
  */
4374
4917
  virtualRouterName: string | undefined;
4375
4918
  /**
4919
+ * @public
4376
4920
  * <p>The route specification to apply.</p>
4377
4921
  */
4378
4922
  spec: RouteSpec | undefined;
4379
4923
  /**
4924
+ * @public
4380
4925
  * <p>Optional metadata that you can apply to the route to assist with categorization and
4381
4926
  * organization. Each tag consists of a key and an optional value, both of which you define.
4382
4927
  * Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -4384,11 +4929,13 @@ export interface CreateRouteInput {
4384
4929
  */
4385
4930
  tags?: TagRef[];
4386
4931
  /**
4932
+ * @public
4387
4933
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
4388
4934
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
4389
4935
  */
4390
4936
  clientToken?: string;
4391
4937
  /**
4938
+ * @public
4392
4939
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
4393
4940
  * the account that you specify must share the mesh with your account before you can create
4394
4941
  * the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
@@ -4414,6 +4961,7 @@ export type RouteStatusCode = (typeof RouteStatusCode)[keyof typeof RouteStatusC
4414
4961
  */
4415
4962
  export interface RouteStatus {
4416
4963
  /**
4964
+ * @public
4417
4965
  * <p>The current status for the route.</p>
4418
4966
  */
4419
4967
  status: RouteStatusCode | string | undefined;
@@ -4424,26 +4972,32 @@ export interface RouteStatus {
4424
4972
  */
4425
4973
  export interface RouteData {
4426
4974
  /**
4975
+ * @public
4427
4976
  * <p>The name of the service mesh that the route resides in.</p>
4428
4977
  */
4429
4978
  meshName: string | undefined;
4430
4979
  /**
4980
+ * @public
4431
4981
  * <p>The virtual router that the route is associated with.</p>
4432
4982
  */
4433
4983
  virtualRouterName: string | undefined;
4434
4984
  /**
4985
+ * @public
4435
4986
  * <p>The name of the route.</p>
4436
4987
  */
4437
4988
  routeName: string | undefined;
4438
4989
  /**
4990
+ * @public
4439
4991
  * <p>The specifications of the route.</p>
4440
4992
  */
4441
4993
  spec: RouteSpec | undefined;
4442
4994
  /**
4995
+ * @public
4443
4996
  * <p>The associated metadata for the route.</p>
4444
4997
  */
4445
4998
  metadata: ResourceMetadata | undefined;
4446
4999
  /**
5000
+ * @public
4447
5001
  * <p>The status of the route.</p>
4448
5002
  */
4449
5003
  status: RouteStatus | undefined;
@@ -4454,6 +5008,7 @@ export interface RouteData {
4454
5008
  */
4455
5009
  export interface CreateRouteOutput {
4456
5010
  /**
5011
+ * @public
4457
5012
  * <p>The full description of your mesh following the create call.</p>
4458
5013
  */
4459
5014
  route: RouteData | undefined;
@@ -4464,18 +5019,22 @@ export interface CreateRouteOutput {
4464
5019
  */
4465
5020
  export interface DeleteRouteInput {
4466
5021
  /**
5022
+ * @public
4467
5023
  * <p>The name of the route to delete.</p>
4468
5024
  */
4469
5025
  routeName: string | undefined;
4470
5026
  /**
5027
+ * @public
4471
5028
  * <p>The name of the service mesh to delete the route in.</p>
4472
5029
  */
4473
5030
  meshName: string | undefined;
4474
5031
  /**
5032
+ * @public
4475
5033
  * <p>The name of the virtual router to delete the route in.</p>
4476
5034
  */
4477
5035
  virtualRouterName: string | undefined;
4478
5036
  /**
5037
+ * @public
4479
5038
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4480
5039
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4481
5040
  */
@@ -4487,6 +5046,7 @@ export interface DeleteRouteInput {
4487
5046
  */
4488
5047
  export interface DeleteRouteOutput {
4489
5048
  /**
5049
+ * @public
4490
5050
  * <p>The route that was deleted.</p>
4491
5051
  */
4492
5052
  route: RouteData | undefined;
@@ -4497,19 +5057,23 @@ export interface DeleteRouteOutput {
4497
5057
  */
4498
5058
  export interface DescribeRouteInput {
4499
5059
  /**
5060
+ * @public
4500
5061
  * <p>The name of the route to describe.</p>
4501
5062
  */
4502
5063
  routeName: string | undefined;
4503
5064
  /**
5065
+ * @public
4504
5066
  * <p>The name of the service mesh that the route resides in.</p>
4505
5067
  */
4506
5068
  meshName: string | undefined;
4507
5069
  /**
5070
+ * @public
4508
5071
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4509
5072
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4510
5073
  */
4511
5074
  meshOwner?: string;
4512
5075
  /**
5076
+ * @public
4513
5077
  * <p>The name of the virtual router that the route is associated with.</p>
4514
5078
  */
4515
5079
  virtualRouterName: string | undefined;
@@ -4520,6 +5084,7 @@ export interface DescribeRouteInput {
4520
5084
  */
4521
5085
  export interface DescribeRouteOutput {
4522
5086
  /**
5087
+ * @public
4523
5088
  * <p>The full description of your route.</p>
4524
5089
  */
4525
5090
  route: RouteData | undefined;
@@ -4530,14 +5095,17 @@ export interface DescribeRouteOutput {
4530
5095
  */
4531
5096
  export interface ListRoutesInput {
4532
5097
  /**
5098
+ * @public
4533
5099
  * <p>The name of the service mesh to list routes in.</p>
4534
5100
  */
4535
5101
  meshName: string | undefined;
4536
5102
  /**
5103
+ * @public
4537
5104
  * <p>The name of the virtual router to list routes in.</p>
4538
5105
  */
4539
5106
  virtualRouterName: string | undefined;
4540
5107
  /**
5108
+ * @public
4541
5109
  * <p>The <code>nextToken</code> value returned from a previous paginated
4542
5110
  * <code>ListRoutes</code> request where <code>limit</code> was used and the results
4543
5111
  * exceeded the value of that parameter. Pagination continues from the end of the previous
@@ -4545,6 +5113,7 @@ export interface ListRoutesInput {
4545
5113
  */
4546
5114
  nextToken?: string;
4547
5115
  /**
5116
+ * @public
4548
5117
  * <p>The maximum number of results returned by <code>ListRoutes</code> in paginated output.
4549
5118
  * When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code>
4550
5119
  * results in a single page along with a <code>nextToken</code> response element. You can see
@@ -4556,6 +5125,7 @@ export interface ListRoutesInput {
4556
5125
  */
4557
5126
  limit?: number;
4558
5127
  /**
5128
+ * @public
4559
5129
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4560
5130
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4561
5131
  */
@@ -4567,40 +5137,49 @@ export interface ListRoutesInput {
4567
5137
  */
4568
5138
  export interface RouteRef {
4569
5139
  /**
5140
+ * @public
4570
5141
  * <p>The name of the service mesh that the route resides in.</p>
4571
5142
  */
4572
5143
  meshName: string | undefined;
4573
5144
  /**
5145
+ * @public
4574
5146
  * <p>The virtual router that the route is associated with.</p>
4575
5147
  */
4576
5148
  virtualRouterName: string | undefined;
4577
5149
  /**
5150
+ * @public
4578
5151
  * <p>The name of the route.</p>
4579
5152
  */
4580
5153
  routeName: string | undefined;
4581
5154
  /**
5155
+ * @public
4582
5156
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4583
5157
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4584
5158
  */
4585
5159
  meshOwner: string | undefined;
4586
5160
  /**
5161
+ * @public
4587
5162
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
4588
5163
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4589
5164
  */
4590
5165
  resourceOwner: string | undefined;
4591
5166
  /**
5167
+ * @public
4592
5168
  * <p>The full Amazon Resource Name (ARN) for the route.</p>
4593
5169
  */
4594
5170
  arn: string | undefined;
4595
5171
  /**
5172
+ * @public
4596
5173
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
4597
5174
  */
4598
5175
  version: number | undefined;
4599
5176
  /**
5177
+ * @public
4600
5178
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
4601
5179
  */
4602
5180
  createdAt: Date | undefined;
4603
5181
  /**
5182
+ * @public
4604
5183
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
4605
5184
  */
4606
5185
  lastUpdatedAt: Date | undefined;
@@ -4611,10 +5190,12 @@ export interface RouteRef {
4611
5190
  */
4612
5191
  export interface ListRoutesOutput {
4613
5192
  /**
5193
+ * @public
4614
5194
  * <p>The list of existing routes for the specified service mesh and virtual router.</p>
4615
5195
  */
4616
5196
  routes: RouteRef[] | undefined;
4617
5197
  /**
5198
+ * @public
4618
5199
  * <p>The <code>nextToken</code> value to include in a future <code>ListRoutes</code> request.
4619
5200
  * When the results of a <code>ListRoutes</code> request exceed <code>limit</code>, you can
4620
5201
  * use this value to retrieve the next page of results. This value is <code>null</code> when
@@ -4628,27 +5209,33 @@ export interface ListRoutesOutput {
4628
5209
  */
4629
5210
  export interface UpdateRouteInput {
4630
5211
  /**
5212
+ * @public
4631
5213
  * <p>The name of the route to update.</p>
4632
5214
  */
4633
5215
  routeName: string | undefined;
4634
5216
  /**
5217
+ * @public
4635
5218
  * <p>The name of the service mesh that the route resides in.</p>
4636
5219
  */
4637
5220
  meshName: string | undefined;
4638
5221
  /**
5222
+ * @public
4639
5223
  * <p>The name of the virtual router that the route is associated with.</p>
4640
5224
  */
4641
5225
  virtualRouterName: string | undefined;
4642
5226
  /**
5227
+ * @public
4643
5228
  * <p>The new route specification to apply. This overwrites the existing data.</p>
4644
5229
  */
4645
5230
  spec: RouteSpec | undefined;
4646
5231
  /**
5232
+ * @public
4647
5233
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
4648
5234
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
4649
5235
  */
4650
5236
  clientToken?: string;
4651
5237
  /**
5238
+ * @public
4652
5239
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4653
5240
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4654
5241
  */
@@ -4660,6 +5247,7 @@ export interface UpdateRouteInput {
4660
5247
  */
4661
5248
  export interface UpdateRouteOutput {
4662
5249
  /**
5250
+ * @public
4663
5251
  * <p>A full description of the route that was updated.</p>
4664
5252
  */
4665
5253
  route: RouteData | undefined;
@@ -4670,23 +5258,28 @@ export interface UpdateRouteOutput {
4670
5258
  */
4671
5259
  export interface UpdateVirtualRouterInput {
4672
5260
  /**
5261
+ * @public
4673
5262
  * <p>The name of the virtual router to update.</p>
4674
5263
  */
4675
5264
  virtualRouterName: string | undefined;
4676
5265
  /**
5266
+ * @public
4677
5267
  * <p>The name of the service mesh that the virtual router resides in.</p>
4678
5268
  */
4679
5269
  meshName: string | undefined;
4680
5270
  /**
5271
+ * @public
4681
5272
  * <p>The new virtual router specification to apply. This overwrites the existing data.</p>
4682
5273
  */
4683
5274
  spec: VirtualRouterSpec | undefined;
4684
5275
  /**
5276
+ * @public
4685
5277
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
4686
5278
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
4687
5279
  */
4688
5280
  clientToken?: string;
4689
5281
  /**
5282
+ * @public
4690
5283
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4691
5284
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4692
5285
  */
@@ -4698,6 +5291,7 @@ export interface UpdateVirtualRouterInput {
4698
5291
  */
4699
5292
  export interface UpdateVirtualRouterOutput {
4700
5293
  /**
5294
+ * @public
4701
5295
  * <p>A full description of the virtual router that was updated.</p>
4702
5296
  */
4703
5297
  virtualRouter: VirtualRouterData | undefined;
@@ -4708,6 +5302,7 @@ export interface UpdateVirtualRouterOutput {
4708
5302
  */
4709
5303
  export interface VirtualNodeServiceProvider {
4710
5304
  /**
5305
+ * @public
4711
5306
  * <p>The name of the virtual node that is acting as a service provider.</p>
4712
5307
  */
4713
5308
  virtualNodeName: string | undefined;
@@ -4718,6 +5313,7 @@ export interface VirtualNodeServiceProvider {
4718
5313
  */
4719
5314
  export interface VirtualRouterServiceProvider {
4720
5315
  /**
5316
+ * @public
4721
5317
  * <p>The name of the virtual router that is acting as a service provider.</p>
4722
5318
  */
4723
5319
  virtualRouterName: string | undefined;
@@ -4732,6 +5328,7 @@ export type VirtualServiceProvider = VirtualServiceProvider.VirtualNodeMember |
4732
5328
  */
4733
5329
  export declare namespace VirtualServiceProvider {
4734
5330
  /**
5331
+ * @public
4735
5332
  * <p>The virtual node associated with a virtual service.</p>
4736
5333
  */
4737
5334
  interface VirtualNodeMember {
@@ -4740,6 +5337,7 @@ export declare namespace VirtualServiceProvider {
4740
5337
  $unknown?: never;
4741
5338
  }
4742
5339
  /**
5340
+ * @public
4743
5341
  * <p>The virtual router associated with a virtual service.</p>
4744
5342
  */
4745
5343
  interface VirtualRouterMember {
@@ -4747,6 +5345,9 @@ export declare namespace VirtualServiceProvider {
4747
5345
  virtualRouter: VirtualRouterServiceProvider;
4748
5346
  $unknown?: never;
4749
5347
  }
5348
+ /**
5349
+ * @public
5350
+ */
4750
5351
  interface $UnknownMember {
4751
5352
  virtualNode?: never;
4752
5353
  virtualRouter?: never;
@@ -4765,6 +5366,7 @@ export declare namespace VirtualServiceProvider {
4765
5366
  */
4766
5367
  export interface VirtualServiceSpec {
4767
5368
  /**
5369
+ * @public
4768
5370
  * <p>The App Mesh object that is acting as the provider for a virtual service. You
4769
5371
  * can specify a single virtual node or virtual router.</p>
4770
5372
  */
@@ -4776,18 +5378,22 @@ export interface VirtualServiceSpec {
4776
5378
  */
4777
5379
  export interface CreateVirtualServiceInput {
4778
5380
  /**
5381
+ * @public
4779
5382
  * <p>The name to use for the virtual service.</p>
4780
5383
  */
4781
5384
  virtualServiceName: string | undefined;
4782
5385
  /**
5386
+ * @public
4783
5387
  * <p>The name of the service mesh to create the virtual service in.</p>
4784
5388
  */
4785
5389
  meshName: string | undefined;
4786
5390
  /**
5391
+ * @public
4787
5392
  * <p>The virtual service specification to apply.</p>
4788
5393
  */
4789
5394
  spec: VirtualServiceSpec | undefined;
4790
5395
  /**
5396
+ * @public
4791
5397
  * <p>Optional metadata that you can apply to the virtual service to assist with
4792
5398
  * categorization and organization. Each tag consists of a key and an optional value, both of
4793
5399
  * which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -4795,11 +5401,13 @@ export interface CreateVirtualServiceInput {
4795
5401
  */
4796
5402
  tags?: TagRef[];
4797
5403
  /**
5404
+ * @public
4798
5405
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
4799
5406
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
4800
5407
  */
4801
5408
  clientToken?: string;
4802
5409
  /**
5410
+ * @public
4803
5411
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then
4804
5412
  * the account that you specify must share the mesh with your account before you can create
4805
5413
  * the resource in the service mesh. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
@@ -4825,6 +5433,7 @@ export type VirtualServiceStatusCode = (typeof VirtualServiceStatusCode)[keyof t
4825
5433
  */
4826
5434
  export interface VirtualServiceStatus {
4827
5435
  /**
5436
+ * @public
4828
5437
  * <p>The current status of the virtual service.</p>
4829
5438
  */
4830
5439
  status: VirtualServiceStatusCode | string | undefined;
@@ -4835,22 +5444,27 @@ export interface VirtualServiceStatus {
4835
5444
  */
4836
5445
  export interface VirtualServiceData {
4837
5446
  /**
5447
+ * @public
4838
5448
  * <p>The name of the service mesh that the virtual service resides in.</p>
4839
5449
  */
4840
5450
  meshName: string | undefined;
4841
5451
  /**
5452
+ * @public
4842
5453
  * <p>The name of the virtual service.</p>
4843
5454
  */
4844
5455
  virtualServiceName: string | undefined;
4845
5456
  /**
5457
+ * @public
4846
5458
  * <p>The specifications of the virtual service.</p>
4847
5459
  */
4848
5460
  spec: VirtualServiceSpec | undefined;
4849
5461
  /**
5462
+ * @public
4850
5463
  * <p>An object that represents metadata for a resource.</p>
4851
5464
  */
4852
5465
  metadata: ResourceMetadata | undefined;
4853
5466
  /**
5467
+ * @public
4854
5468
  * <p>The current status of the virtual service.</p>
4855
5469
  */
4856
5470
  status: VirtualServiceStatus | undefined;
@@ -4861,6 +5475,7 @@ export interface VirtualServiceData {
4861
5475
  */
4862
5476
  export interface CreateVirtualServiceOutput {
4863
5477
  /**
5478
+ * @public
4864
5479
  * <p>The full description of your virtual service following the create call.</p>
4865
5480
  */
4866
5481
  virtualService: VirtualServiceData | undefined;
@@ -4871,14 +5486,17 @@ export interface CreateVirtualServiceOutput {
4871
5486
  */
4872
5487
  export interface DeleteVirtualServiceInput {
4873
5488
  /**
5489
+ * @public
4874
5490
  * <p>The name of the virtual service to delete.</p>
4875
5491
  */
4876
5492
  virtualServiceName: string | undefined;
4877
5493
  /**
5494
+ * @public
4878
5495
  * <p>The name of the service mesh to delete the virtual service in.</p>
4879
5496
  */
4880
5497
  meshName: string | undefined;
4881
5498
  /**
5499
+ * @public
4882
5500
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4883
5501
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4884
5502
  */
@@ -4890,6 +5508,7 @@ export interface DeleteVirtualServiceInput {
4890
5508
  */
4891
5509
  export interface DeleteVirtualServiceOutput {
4892
5510
  /**
5511
+ * @public
4893
5512
  * <p>The virtual service that was deleted.</p>
4894
5513
  */
4895
5514
  virtualService: VirtualServiceData | undefined;
@@ -4900,14 +5519,17 @@ export interface DeleteVirtualServiceOutput {
4900
5519
  */
4901
5520
  export interface DescribeVirtualServiceInput {
4902
5521
  /**
5522
+ * @public
4903
5523
  * <p>The name of the virtual service to describe.</p>
4904
5524
  */
4905
5525
  virtualServiceName: string | undefined;
4906
5526
  /**
5527
+ * @public
4907
5528
  * <p>The name of the service mesh that the virtual service resides in.</p>
4908
5529
  */
4909
5530
  meshName: string | undefined;
4910
5531
  /**
5532
+ * @public
4911
5533
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4912
5534
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4913
5535
  */
@@ -4919,6 +5541,7 @@ export interface DescribeVirtualServiceInput {
4919
5541
  */
4920
5542
  export interface DescribeVirtualServiceOutput {
4921
5543
  /**
5544
+ * @public
4922
5545
  * <p>The full description of your virtual service.</p>
4923
5546
  */
4924
5547
  virtualService: VirtualServiceData | undefined;
@@ -4929,10 +5552,12 @@ export interface DescribeVirtualServiceOutput {
4929
5552
  */
4930
5553
  export interface ListVirtualServicesInput {
4931
5554
  /**
5555
+ * @public
4932
5556
  * <p>The name of the service mesh to list virtual services in.</p>
4933
5557
  */
4934
5558
  meshName: string | undefined;
4935
5559
  /**
5560
+ * @public
4936
5561
  * <p>The <code>nextToken</code> value returned from a previous paginated
4937
5562
  * <code>ListVirtualServices</code> request where <code>limit</code> was used and the
4938
5563
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -4940,6 +5565,7 @@ export interface ListVirtualServicesInput {
4940
5565
  */
4941
5566
  nextToken?: string;
4942
5567
  /**
5568
+ * @public
4943
5569
  * <p>The maximum number of results returned by <code>ListVirtualServices</code> in paginated
4944
5570
  * output. When you use this parameter, <code>ListVirtualServices</code> returns only
4945
5571
  * <code>limit</code> results in a single page along with a <code>nextToken</code> response
@@ -4951,6 +5577,7 @@ export interface ListVirtualServicesInput {
4951
5577
  */
4952
5578
  limit?: number;
4953
5579
  /**
5580
+ * @public
4954
5581
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4955
5582
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4956
5583
  */
@@ -4962,36 +5589,44 @@ export interface ListVirtualServicesInput {
4962
5589
  */
4963
5590
  export interface VirtualServiceRef {
4964
5591
  /**
5592
+ * @public
4965
5593
  * <p>The name of the service mesh that the virtual service resides in.</p>
4966
5594
  */
4967
5595
  meshName: string | undefined;
4968
5596
  /**
5597
+ * @public
4969
5598
  * <p>The name of the virtual service.</p>
4970
5599
  */
4971
5600
  virtualServiceName: string | undefined;
4972
5601
  /**
5602
+ * @public
4973
5603
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
4974
5604
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4975
5605
  */
4976
5606
  meshOwner: string | undefined;
4977
5607
  /**
5608
+ * @public
4978
5609
  * <p>The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's
4979
5610
  * the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
4980
5611
  */
4981
5612
  resourceOwner: string | undefined;
4982
5613
  /**
5614
+ * @public
4983
5615
  * <p>The full Amazon Resource Name (ARN) for the virtual service.</p>
4984
5616
  */
4985
5617
  arn: string | undefined;
4986
5618
  /**
5619
+ * @public
4987
5620
  * <p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>
4988
5621
  */
4989
5622
  version: number | undefined;
4990
5623
  /**
5624
+ * @public
4991
5625
  * <p>The Unix epoch timestamp in seconds for when the resource was created.</p>
4992
5626
  */
4993
5627
  createdAt: Date | undefined;
4994
5628
  /**
5629
+ * @public
4995
5630
  * <p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>
4996
5631
  */
4997
5632
  lastUpdatedAt: Date | undefined;
@@ -5002,10 +5637,12 @@ export interface VirtualServiceRef {
5002
5637
  */
5003
5638
  export interface ListVirtualServicesOutput {
5004
5639
  /**
5640
+ * @public
5005
5641
  * <p>The list of existing virtual services for the specified service mesh.</p>
5006
5642
  */
5007
5643
  virtualServices: VirtualServiceRef[] | undefined;
5008
5644
  /**
5645
+ * @public
5009
5646
  * <p>The <code>nextToken</code> value to include in a future <code>ListVirtualServices</code>
5010
5647
  * request. When the results of a <code>ListVirtualServices</code> request exceed
5011
5648
  * <code>limit</code>, you can use this value to retrieve the next page of results. This
@@ -5019,24 +5656,29 @@ export interface ListVirtualServicesOutput {
5019
5656
  */
5020
5657
  export interface UpdateVirtualServiceInput {
5021
5658
  /**
5659
+ * @public
5022
5660
  * <p>The name of the virtual service to update.</p>
5023
5661
  */
5024
5662
  virtualServiceName: string | undefined;
5025
5663
  /**
5664
+ * @public
5026
5665
  * <p>The name of the service mesh that the virtual service resides in.</p>
5027
5666
  */
5028
5667
  meshName: string | undefined;
5029
5668
  /**
5669
+ * @public
5030
5670
  * <p>The new virtual service specification to apply. This overwrites the existing
5031
5671
  * data.</p>
5032
5672
  */
5033
5673
  spec: VirtualServiceSpec | undefined;
5034
5674
  /**
5675
+ * @public
5035
5676
  * <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the
5036
5677
  * request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>
5037
5678
  */
5038
5679
  clientToken?: string;
5039
5680
  /**
5681
+ * @public
5040
5682
  * <p>The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's
5041
5683
  * the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.</p>
5042
5684
  */
@@ -5048,6 +5690,7 @@ export interface UpdateVirtualServiceInput {
5048
5690
  */
5049
5691
  export interface UpdateVirtualServiceOutput {
5050
5692
  /**
5693
+ * @public
5051
5694
  * <p>A full description of the virtual service that was updated.</p>
5052
5695
  */
5053
5696
  virtualService: VirtualServiceData | undefined;
@@ -5058,10 +5701,12 @@ export interface UpdateVirtualServiceOutput {
5058
5701
  */
5059
5702
  export interface TagResourceInput {
5060
5703
  /**
5704
+ * @public
5061
5705
  * <p>The Amazon Resource Name (ARN) of the resource to add tags to.</p>
5062
5706
  */
5063
5707
  resourceArn: string | undefined;
5064
5708
  /**
5709
+ * @public
5065
5710
  * <p>The tags to add to the resource. A tag is an array of key-value pairs.
5066
5711
  * Tag keys can have a maximum character length of 128 characters, and tag values can have
5067
5712
  * a maximum length of 256 characters.</p>
@@ -5094,10 +5739,12 @@ export declare class TooManyTagsException extends __BaseException {
5094
5739
  */
5095
5740
  export interface UntagResourceInput {
5096
5741
  /**
5742
+ * @public
5097
5743
  * <p>The Amazon Resource Name (ARN) of the resource to delete tags from.</p>
5098
5744
  */
5099
5745
  resourceArn: string | undefined;
5100
5746
  /**
5747
+ * @public
5101
5748
  * <p>The keys of the tags to be removed.</p>
5102
5749
  */
5103
5750
  tagKeys: string[] | undefined;