@aws-sdk/client-direct-connect 3.379.1 → 3.385.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.
@@ -7,6 +7,7 @@ import { DirectConnectServiceException as __BaseException } from "./DirectConnec
7
7
  */
8
8
  export interface RouteFilterPrefix {
9
9
  /**
10
+ * @public
10
11
  * <p>The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.</p>
11
12
  */
12
13
  cidr?: string;
@@ -16,18 +17,22 @@ export interface RouteFilterPrefix {
16
17
  */
17
18
  export interface AcceptDirectConnectGatewayAssociationProposalRequest {
18
19
  /**
20
+ * @public
19
21
  * <p>The ID of the Direct Connect gateway.</p>
20
22
  */
21
23
  directConnectGatewayId: string | undefined;
22
24
  /**
25
+ * @public
23
26
  * <p>The ID of the request proposal.</p>
24
27
  */
25
28
  proposalId: string | undefined;
26
29
  /**
30
+ * @public
27
31
  * <p>The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.</p>
28
32
  */
29
33
  associatedGatewayOwnerAccount: string | undefined;
30
34
  /**
35
+ * @public
31
36
  * <p>Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.</p>
32
37
  * <p>For information about how to set the prefixes, see <a href="https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes">Allowed Prefixes</a> in the <i>Direct Connect User Guide</i>.</p>
33
38
  */
@@ -51,18 +56,22 @@ export type GatewayType = (typeof GatewayType)[keyof typeof GatewayType];
51
56
  */
52
57
  export interface AssociatedGateway {
53
58
  /**
59
+ * @public
54
60
  * <p>The ID of the associated gateway.</p>
55
61
  */
56
62
  id?: string;
57
63
  /**
64
+ * @public
58
65
  * <p>The type of associated gateway.</p>
59
66
  */
60
67
  type?: GatewayType | string;
61
68
  /**
69
+ * @public
62
70
  * <p>The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.</p>
63
71
  */
64
72
  ownerAccount?: string;
65
73
  /**
74
+ * @public
66
75
  * <p>The Region where the associated gateway is located.</p>
67
76
  */
68
77
  region?: string;
@@ -88,14 +97,17 @@ export type DirectConnectGatewayAssociationState = (typeof DirectConnectGatewayA
88
97
  */
89
98
  export interface DirectConnectGatewayAssociation {
90
99
  /**
100
+ * @public
91
101
  * <p>The ID of the Direct Connect gateway.</p>
92
102
  */
93
103
  directConnectGatewayId?: string;
94
104
  /**
105
+ * @public
95
106
  * <p>The ID of the Amazon Web Services account that owns the associated gateway.</p>
96
107
  */
97
108
  directConnectGatewayOwnerAccount?: string;
98
109
  /**
110
+ * @public
99
111
  * <p>The state of the association. The following are the possible values:</p>
100
112
  * <ul>
101
113
  * <li>
@@ -123,32 +135,39 @@ export interface DirectConnectGatewayAssociation {
123
135
  */
124
136
  associationState?: DirectConnectGatewayAssociationState | string;
125
137
  /**
138
+ * @public
126
139
  * <p>The error message if the state of an object failed to advance.</p>
127
140
  */
128
141
  stateChangeError?: string;
129
142
  /**
143
+ * @public
130
144
  * <p>Information about the associated gateway.</p>
131
145
  */
132
146
  associatedGateway?: AssociatedGateway;
133
147
  /**
148
+ * @public
134
149
  * <p>The ID of the Direct Connect gateway association.</p>
135
150
  */
136
151
  associationId?: string;
137
152
  /**
153
+ * @public
138
154
  * <p>The Amazon VPC prefixes to advertise to the Direct Connect gateway.</p>
139
155
  */
140
156
  allowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
141
157
  /**
158
+ * @public
142
159
  * <p>The ID of the virtual private gateway. Applies only to private virtual interfaces.</p>
143
160
  */
144
161
  virtualGatewayId?: string;
145
162
  /**
163
+ * @public
146
164
  * @deprecated
147
165
  *
148
166
  * <p>The Amazon Web Services Region where the virtual private gateway is located.</p>
149
167
  */
150
168
  virtualGatewayRegion?: string;
151
169
  /**
170
+ * @public
152
171
  * <p>The ID of the Amazon Web Services account that owns the virtual private gateway.</p>
153
172
  */
154
173
  virtualGatewayOwnerAccount?: string;
@@ -158,6 +177,7 @@ export interface DirectConnectGatewayAssociation {
158
177
  */
159
178
  export interface AcceptDirectConnectGatewayAssociationProposalResult {
160
179
  /**
180
+ * @public
161
181
  * <p>Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.</p>
162
182
  */
163
183
  directConnectGatewayAssociation?: DirectConnectGatewayAssociation;
@@ -204,10 +224,12 @@ export type AddressFamily = (typeof AddressFamily)[keyof typeof AddressFamily];
204
224
  */
205
225
  export interface CustomerAgreement {
206
226
  /**
227
+ * @public
207
228
  * <p>The name of the agreement.</p>
208
229
  */
209
230
  agreementName?: string;
210
231
  /**
232
+ * @public
211
233
  * <p>The status of the customer agreement. This will be either <code>signed</code> or <code>unsigned</code>
212
234
  * </p>
213
235
  */
@@ -218,6 +240,7 @@ export interface CustomerAgreement {
218
240
  */
219
241
  export interface AllocateConnectionOnInterconnectRequest {
220
242
  /**
243
+ * @public
221
244
  * <p>The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps,
222
245
  * 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners
223
246
  * who have met specific requirements
@@ -225,18 +248,22 @@ export interface AllocateConnectionOnInterconnectRequest {
225
248
  */
226
249
  bandwidth: string | undefined;
227
250
  /**
251
+ * @public
228
252
  * <p>The name of the provisioned connection.</p>
229
253
  */
230
254
  connectionName: string | undefined;
231
255
  /**
256
+ * @public
232
257
  * <p>The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.</p>
233
258
  */
234
259
  ownerAccount: string | undefined;
235
260
  /**
261
+ * @public
236
262
  * <p>The ID of the interconnect on which the connection will be provisioned.</p>
237
263
  */
238
264
  interconnectId: string | undefined;
239
265
  /**
266
+ * @public
240
267
  * <p>The dedicated VLAN provisioned to the connection.</p>
241
268
  */
242
269
  vlan: number | undefined;
@@ -279,14 +306,17 @@ export type HasLogicalRedundancy = (typeof HasLogicalRedundancy)[keyof typeof Ha
279
306
  */
280
307
  export interface MacSecKey {
281
308
  /**
309
+ * @public
282
310
  * <p>The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.</p>
283
311
  */
284
312
  secretARN?: string;
285
313
  /**
314
+ * @public
286
315
  * <p>The Connection Key Name (CKN) for the MAC Security secret key.</p>
287
316
  */
288
317
  ckn?: string;
289
318
  /**
319
+ * @public
290
320
  * <p>The state of the MAC Security (MACsec) secret key.</p>
291
321
  * <p>The possible values are:</p>
292
322
  * <ul>
@@ -310,6 +340,7 @@ export interface MacSecKey {
310
340
  */
311
341
  state?: string;
312
342
  /**
343
+ * @public
313
344
  * <p>The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.</p>
314
345
  */
315
346
  startOn?: string;
@@ -320,10 +351,12 @@ export interface MacSecKey {
320
351
  */
321
352
  export interface Tag {
322
353
  /**
354
+ * @public
323
355
  * <p>The key.</p>
324
356
  */
325
357
  key: string | undefined;
326
358
  /**
359
+ * @public
327
360
  * <p>The value.</p>
328
361
  */
329
362
  value?: string;
@@ -334,18 +367,22 @@ export interface Tag {
334
367
  */
335
368
  export interface Connection {
336
369
  /**
370
+ * @public
337
371
  * <p>The ID of the Amazon Web Services account that owns the connection.</p>
338
372
  */
339
373
  ownerAccount?: string;
340
374
  /**
375
+ * @public
341
376
  * <p>The ID of the connection.</p>
342
377
  */
343
378
  connectionId?: string;
344
379
  /**
380
+ * @public
345
381
  * <p>The name of the connection.</p>
346
382
  */
347
383
  connectionName?: string;
348
384
  /**
385
+ * @public
349
386
  * <p>The state of the connection. The following are the possible values:</p>
350
387
  * <ul>
351
388
  * <li>
@@ -388,79 +425,97 @@ export interface Connection {
388
425
  */
389
426
  connectionState?: ConnectionState | string;
390
427
  /**
428
+ * @public
391
429
  * <p>The Amazon Web Services Region where the connection is located.</p>
392
430
  */
393
431
  region?: string;
394
432
  /**
433
+ * @public
395
434
  * <p>The location of the connection.</p>
396
435
  */
397
436
  location?: string;
398
437
  /**
438
+ * @public
399
439
  * <p>The bandwidth of the connection.</p>
400
440
  */
401
441
  bandwidth?: string;
402
442
  /**
443
+ * @public
403
444
  * <p>The ID of the VLAN.</p>
404
445
  */
405
446
  vlan?: number;
406
447
  /**
448
+ * @public
407
449
  * <p>The name of the Direct Connect service provider associated with the connection.</p>
408
450
  */
409
451
  partnerName?: string;
410
452
  /**
453
+ * @public
411
454
  * <p>The time of the most recent call to <a>DescribeLoa</a> for this connection.</p>
412
455
  */
413
456
  loaIssueTime?: Date;
414
457
  /**
458
+ * @public
415
459
  * <p>The ID of the LAG.</p>
416
460
  */
417
461
  lagId?: string;
418
462
  /**
463
+ * @public
419
464
  * @deprecated
420
465
  *
421
466
  * <p>The Direct Connect endpoint on which the physical connection terminates.</p>
422
467
  */
423
468
  awsDevice?: string;
424
469
  /**
470
+ * @public
425
471
  * <p>Indicates whether jumbo frames are supported.</p>
426
472
  */
427
473
  jumboFrameCapable?: boolean;
428
474
  /**
475
+ * @public
429
476
  * <p>The Direct Connect endpoint that terminates the physical connection.</p>
430
477
  */
431
478
  awsDeviceV2?: string;
432
479
  /**
480
+ * @public
433
481
  * <p>The Direct Connect endpoint that terminates the logical connection. This device might be
434
482
  * different than the device that terminates the physical connection.</p>
435
483
  */
436
484
  awsLogicalDeviceId?: string;
437
485
  /**
486
+ * @public
438
487
  * <p>Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).</p>
439
488
  */
440
489
  hasLogicalRedundancy?: HasLogicalRedundancy | string;
441
490
  /**
491
+ * @public
442
492
  * <p>The tags associated with the connection.</p>
443
493
  */
444
494
  tags?: Tag[];
445
495
  /**
496
+ * @public
446
497
  * <p>The name of the service provider associated with the connection.</p>
447
498
  */
448
499
  providerName?: string;
449
500
  /**
501
+ * @public
450
502
  * <p>Indicates whether the connection supports MAC Security (MACsec).</p>
451
503
  */
452
504
  macSecCapable?: boolean;
453
505
  /**
506
+ * @public
454
507
  * <p>The MAC Security (MACsec) port link status of the connection.</p>
455
508
  * <p>The valid values are <code>Encryption Up</code>, which means that there is an active Connection Key Name, or <code>Encryption Down</code>.</p>
456
509
  */
457
510
  portEncryptionStatus?: string;
458
511
  /**
512
+ * @public
459
513
  * <p>The MAC Security (MACsec) connection encryption mode.</p>
460
514
  * <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>
461
515
  */
462
516
  encryptionMode?: string;
463
517
  /**
518
+ * @public
464
519
  * <p>The MAC Security (MACsec) security keys associated with the connection.</p>
465
520
  */
466
521
  macSecKeys?: MacSecKey[];
@@ -470,26 +525,32 @@ export interface Connection {
470
525
  */
471
526
  export interface AllocateHostedConnectionRequest {
472
527
  /**
528
+ * @public
473
529
  * <p>The ID of the interconnect or LAG.</p>
474
530
  */
475
531
  connectionId: string | undefined;
476
532
  /**
533
+ * @public
477
534
  * <p>The ID of the Amazon Web Services account ID of the customer for the connection.</p>
478
535
  */
479
536
  ownerAccount: string | undefined;
480
537
  /**
538
+ * @public
481
539
  * <p>The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection. </p>
482
540
  */
483
541
  bandwidth: string | undefined;
484
542
  /**
543
+ * @public
485
544
  * <p>The name of the hosted connection.</p>
486
545
  */
487
546
  connectionName: string | undefined;
488
547
  /**
548
+ * @public
489
549
  * <p>The dedicated VLAN provisioned to the hosted connection.</p>
490
550
  */
491
551
  vlan: number | undefined;
492
552
  /**
553
+ * @public
493
554
  * <p>The tags associated with the connection.</p>
494
555
  */
495
556
  tags?: Tag[];
@@ -524,39 +585,48 @@ export declare class TooManyTagsException extends __BaseException {
524
585
  */
525
586
  export interface NewPrivateVirtualInterfaceAllocation {
526
587
  /**
588
+ * @public
527
589
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
528
590
  */
529
591
  virtualInterfaceName: string | undefined;
530
592
  /**
593
+ * @public
531
594
  * <p>The ID of the VLAN.</p>
532
595
  */
533
596
  vlan: number | undefined;
534
597
  /**
598
+ * @public
535
599
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
536
600
  * <p>The valid values are 1-2147483647.</p>
537
601
  */
538
602
  asn: number | undefined;
539
603
  /**
604
+ * @public
540
605
  * <p>The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.</p>
541
606
  */
542
607
  mtu?: number;
543
608
  /**
609
+ * @public
544
610
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
545
611
  */
546
612
  authKey?: string;
547
613
  /**
614
+ * @public
548
615
  * <p>The IP address assigned to the Amazon interface.</p>
549
616
  */
550
617
  amazonAddress?: string;
551
618
  /**
619
+ * @public
552
620
  * <p>The address family for the BGP peer.</p>
553
621
  */
554
622
  addressFamily?: AddressFamily | string;
555
623
  /**
624
+ * @public
556
625
  * <p>The IP address assigned to the customer interface.</p>
557
626
  */
558
627
  customerAddress?: string;
559
628
  /**
629
+ * @public
560
630
  * <p>The tags associated with the private virtual interface.</p>
561
631
  */
562
632
  tags?: Tag[];
@@ -566,14 +636,17 @@ export interface NewPrivateVirtualInterfaceAllocation {
566
636
  */
567
637
  export interface AllocatePrivateVirtualInterfaceRequest {
568
638
  /**
639
+ * @public
569
640
  * <p>The ID of the connection on which the private virtual interface is provisioned.</p>
570
641
  */
571
642
  connectionId: string | undefined;
572
643
  /**
644
+ * @public
573
645
  * <p>The ID of the Amazon Web Services account that owns the virtual private interface.</p>
574
646
  */
575
647
  ownerAccount: string | undefined;
576
648
  /**
649
+ * @public
577
650
  * <p>Information about the private virtual interface.</p>
578
651
  */
579
652
  newPrivateVirtualInterfaceAllocation: NewPrivateVirtualInterfaceAllocation | undefined;
@@ -612,30 +685,37 @@ export type BGPStatus = (typeof BGPStatus)[keyof typeof BGPStatus];
612
685
  */
613
686
  export interface BGPPeer {
614
687
  /**
688
+ * @public
615
689
  * <p>The ID of the BGP peer.</p>
616
690
  */
617
691
  bgpPeerId?: string;
618
692
  /**
693
+ * @public
619
694
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
620
695
  */
621
696
  asn?: number;
622
697
  /**
698
+ * @public
623
699
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
624
700
  */
625
701
  authKey?: string;
626
702
  /**
703
+ * @public
627
704
  * <p>The address family for the BGP peer.</p>
628
705
  */
629
706
  addressFamily?: AddressFamily | string;
630
707
  /**
708
+ * @public
631
709
  * <p>The IP address assigned to the Amazon interface.</p>
632
710
  */
633
711
  amazonAddress?: string;
634
712
  /**
713
+ * @public
635
714
  * <p>The IP address assigned to the customer interface.</p>
636
715
  */
637
716
  customerAddress?: string;
638
717
  /**
718
+ * @public
639
719
  * <p>The state of the BGP peer. The following are the possible values:</p>
640
720
  * <ul>
641
721
  * <li>
@@ -662,6 +742,7 @@ export interface BGPPeer {
662
742
  */
663
743
  bgpPeerState?: BGPPeerState | string;
664
744
  /**
745
+ * @public
665
746
  * <p>The status of the BGP peer. The following are the possible values:</p>
666
747
  * <ul>
667
748
  * <li>
@@ -681,10 +762,12 @@ export interface BGPPeer {
681
762
  */
682
763
  bgpStatus?: BGPStatus | string;
683
764
  /**
765
+ * @public
684
766
  * <p>The Direct Connect endpoint that terminates the BGP peer.</p>
685
767
  */
686
768
  awsDeviceV2?: string;
687
769
  /**
770
+ * @public
688
771
  * <p>The Direct Connect endpoint that terminates the logical connection. This device might be
689
772
  * different than the device that terminates the physical connection.</p>
690
773
  */
@@ -715,59 +798,73 @@ export type VirtualInterfaceState = (typeof VirtualInterfaceState)[keyof typeof
715
798
  */
716
799
  export interface VirtualInterface {
717
800
  /**
801
+ * @public
718
802
  * <p>The ID of the Amazon Web Services account that owns the virtual interface.</p>
719
803
  */
720
804
  ownerAccount?: string;
721
805
  /**
806
+ * @public
722
807
  * <p>The ID of the virtual interface.</p>
723
808
  */
724
809
  virtualInterfaceId?: string;
725
810
  /**
811
+ * @public
726
812
  * <p>The location of the connection.</p>
727
813
  */
728
814
  location?: string;
729
815
  /**
816
+ * @public
730
817
  * <p>The ID of the connection.</p>
731
818
  */
732
819
  connectionId?: string;
733
820
  /**
821
+ * @public
734
822
  * <p>The type of virtual interface. The possible values are <code>private</code> and <code>public</code>.</p>
735
823
  */
736
824
  virtualInterfaceType?: string;
737
825
  /**
826
+ * @public
738
827
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
739
828
  */
740
829
  virtualInterfaceName?: string;
741
830
  /**
831
+ * @public
742
832
  * <p>The ID of the VLAN.</p>
743
833
  */
744
834
  vlan?: number;
745
835
  /**
836
+ * @public
746
837
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
747
838
  * <p>The valid values are 1-2147483647.</p>
748
839
  */
749
840
  asn?: number;
750
841
  /**
842
+ * @public
751
843
  * <p>The autonomous system number (ASN) for the Amazon side of the connection.</p>
752
844
  */
753
845
  amazonSideAsn?: number;
754
846
  /**
847
+ * @public
755
848
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
756
849
  */
757
850
  authKey?: string;
758
851
  /**
852
+ * @public
759
853
  * <p>The IP address assigned to the Amazon interface.</p>
760
854
  */
761
855
  amazonAddress?: string;
762
856
  /**
857
+ * @public
763
858
  * <p>The IP address assigned to the customer interface.</p>
764
859
  */
765
860
  customerAddress?: string;
766
861
  /**
862
+ * @public
767
863
  * <p>The address family for the BGP peer.</p>
768
864
  */
769
865
  addressFamily?: AddressFamily | string;
770
866
  /**
867
+ * @public
771
868
  * <p>The state of the virtual interface. The following are the possible values:</p>
772
869
  * <ul>
773
870
  * <li>
@@ -810,51 +907,63 @@ export interface VirtualInterface {
810
907
  */
811
908
  virtualInterfaceState?: VirtualInterfaceState | string;
812
909
  /**
910
+ * @public
813
911
  * <p>The customer router configuration.</p>
814
912
  */
815
913
  customerRouterConfig?: string;
816
914
  /**
915
+ * @public
817
916
  * <p>The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500</p>
818
917
  */
819
918
  mtu?: number;
820
919
  /**
920
+ * @public
821
921
  * <p>Indicates whether jumbo frames are supported.</p>
822
922
  */
823
923
  jumboFrameCapable?: boolean;
824
924
  /**
925
+ * @public
825
926
  * <p>The ID of the virtual private gateway. Applies only to private virtual interfaces.</p>
826
927
  */
827
928
  virtualGatewayId?: string;
828
929
  /**
930
+ * @public
829
931
  * <p>The ID of the Direct Connect gateway.</p>
830
932
  */
831
933
  directConnectGatewayId?: string;
832
934
  /**
935
+ * @public
833
936
  * <p>The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.</p>
834
937
  */
835
938
  routeFilterPrefixes?: RouteFilterPrefix[];
836
939
  /**
940
+ * @public
837
941
  * <p>The BGP peers configured on this virtual interface.</p>
838
942
  */
839
943
  bgpPeers?: BGPPeer[];
840
944
  /**
945
+ * @public
841
946
  * <p>The Amazon Web Services Region where the virtual interface is located.</p>
842
947
  */
843
948
  region?: string;
844
949
  /**
950
+ * @public
845
951
  * <p>The Direct Connect endpoint that terminates the physical connection.</p>
846
952
  */
847
953
  awsDeviceV2?: string;
848
954
  /**
955
+ * @public
849
956
  * <p>The Direct Connect endpoint that terminates the logical connection. This device might be
850
957
  * different than the device that terminates the physical connection.</p>
851
958
  */
852
959
  awsLogicalDeviceId?: string;
853
960
  /**
961
+ * @public
854
962
  * <p>The tags associated with the virtual interface.</p>
855
963
  */
856
964
  tags?: Tag[];
857
965
  /**
966
+ * @public
858
967
  * <p>Indicates whether SiteLink is enabled.</p>
859
968
  */
860
969
  siteLinkEnabled?: boolean;
@@ -865,39 +974,48 @@ export interface VirtualInterface {
865
974
  */
866
975
  export interface NewPublicVirtualInterfaceAllocation {
867
976
  /**
977
+ * @public
868
978
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
869
979
  */
870
980
  virtualInterfaceName: string | undefined;
871
981
  /**
982
+ * @public
872
983
  * <p>The ID of the VLAN.</p>
873
984
  */
874
985
  vlan: number | undefined;
875
986
  /**
987
+ * @public
876
988
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
877
989
  * <p>The valid values are 1-2147483647.</p>
878
990
  */
879
991
  asn: number | undefined;
880
992
  /**
993
+ * @public
881
994
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
882
995
  */
883
996
  authKey?: string;
884
997
  /**
998
+ * @public
885
999
  * <p>The IP address assigned to the Amazon interface.</p>
886
1000
  */
887
1001
  amazonAddress?: string;
888
1002
  /**
1003
+ * @public
889
1004
  * <p>The IP address assigned to the customer interface.</p>
890
1005
  */
891
1006
  customerAddress?: string;
892
1007
  /**
1008
+ * @public
893
1009
  * <p>The address family for the BGP peer.</p>
894
1010
  */
895
1011
  addressFamily?: AddressFamily | string;
896
1012
  /**
1013
+ * @public
897
1014
  * <p>The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.</p>
898
1015
  */
899
1016
  routeFilterPrefixes?: RouteFilterPrefix[];
900
1017
  /**
1018
+ * @public
901
1019
  * <p>The tags associated with the public virtual interface.</p>
902
1020
  */
903
1021
  tags?: Tag[];
@@ -907,14 +1025,17 @@ export interface NewPublicVirtualInterfaceAllocation {
907
1025
  */
908
1026
  export interface AllocatePublicVirtualInterfaceRequest {
909
1027
  /**
1028
+ * @public
910
1029
  * <p>The ID of the connection on which the public virtual interface is provisioned.</p>
911
1030
  */
912
1031
  connectionId: string | undefined;
913
1032
  /**
1033
+ * @public
914
1034
  * <p>The ID of the Amazon Web Services account that owns the public virtual interface.</p>
915
1035
  */
916
1036
  ownerAccount: string | undefined;
917
1037
  /**
1038
+ * @public
918
1039
  * <p>Information about the public virtual interface.</p>
919
1040
  */
920
1041
  newPublicVirtualInterfaceAllocation: NewPublicVirtualInterfaceAllocation | undefined;
@@ -925,39 +1046,48 @@ export interface AllocatePublicVirtualInterfaceRequest {
925
1046
  */
926
1047
  export interface NewTransitVirtualInterfaceAllocation {
927
1048
  /**
1049
+ * @public
928
1050
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
929
1051
  */
930
1052
  virtualInterfaceName?: string;
931
1053
  /**
1054
+ * @public
932
1055
  * <p>The ID of the VLAN.</p>
933
1056
  */
934
1057
  vlan?: number;
935
1058
  /**
1059
+ * @public
936
1060
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
937
1061
  * <p>The valid values are 1-2147483647.</p>
938
1062
  */
939
1063
  asn?: number;
940
1064
  /**
1065
+ * @public
941
1066
  * <p>The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500 </p>
942
1067
  */
943
1068
  mtu?: number;
944
1069
  /**
1070
+ * @public
945
1071
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
946
1072
  */
947
1073
  authKey?: string;
948
1074
  /**
1075
+ * @public
949
1076
  * <p>The IP address assigned to the Amazon interface.</p>
950
1077
  */
951
1078
  amazonAddress?: string;
952
1079
  /**
1080
+ * @public
953
1081
  * <p>The IP address assigned to the customer interface.</p>
954
1082
  */
955
1083
  customerAddress?: string;
956
1084
  /**
1085
+ * @public
957
1086
  * <p>The address family for the BGP peer.</p>
958
1087
  */
959
1088
  addressFamily?: AddressFamily | string;
960
1089
  /**
1090
+ * @public
961
1091
  * <p>The tags associated with the transitive virtual interface.</p>
962
1092
  */
963
1093
  tags?: Tag[];
@@ -967,14 +1097,17 @@ export interface NewTransitVirtualInterfaceAllocation {
967
1097
  */
968
1098
  export interface AllocateTransitVirtualInterfaceRequest {
969
1099
  /**
1100
+ * @public
970
1101
  * <p>The ID of the connection on which the transit virtual interface is provisioned.</p>
971
1102
  */
972
1103
  connectionId: string | undefined;
973
1104
  /**
1105
+ * @public
974
1106
  * <p>The ID of the Amazon Web Services account that owns the transit virtual interface.</p>
975
1107
  */
976
1108
  ownerAccount: string | undefined;
977
1109
  /**
1110
+ * @public
978
1111
  * <p>Information about the transit virtual interface.</p>
979
1112
  */
980
1113
  newTransitVirtualInterfaceAllocation: NewTransitVirtualInterfaceAllocation | undefined;
@@ -984,6 +1117,7 @@ export interface AllocateTransitVirtualInterfaceRequest {
984
1117
  */
985
1118
  export interface AllocateTransitVirtualInterfaceResult {
986
1119
  /**
1120
+ * @public
987
1121
  * <p>Information about a virtual interface.</p>
988
1122
  */
989
1123
  virtualInterface?: VirtualInterface;
@@ -993,10 +1127,12 @@ export interface AllocateTransitVirtualInterfaceResult {
993
1127
  */
994
1128
  export interface AssociateConnectionWithLagRequest {
995
1129
  /**
1130
+ * @public
996
1131
  * <p>The ID of the connection.</p>
997
1132
  */
998
1133
  connectionId: string | undefined;
999
1134
  /**
1135
+ * @public
1000
1136
  * <p>The ID of the LAG with which to associate the connection.</p>
1001
1137
  */
1002
1138
  lagId: string | undefined;
@@ -1006,10 +1142,12 @@ export interface AssociateConnectionWithLagRequest {
1006
1142
  */
1007
1143
  export interface AssociateHostedConnectionRequest {
1008
1144
  /**
1145
+ * @public
1009
1146
  * <p>The ID of the hosted connection.</p>
1010
1147
  */
1011
1148
  connectionId: string | undefined;
1012
1149
  /**
1150
+ * @public
1013
1151
  * <p>The ID of the interconnect or the LAG.</p>
1014
1152
  */
1015
1153
  parentConnectionId: string | undefined;
@@ -1019,17 +1157,20 @@ export interface AssociateHostedConnectionRequest {
1019
1157
  */
1020
1158
  export interface AssociateMacSecKeyRequest {
1021
1159
  /**
1160
+ * @public
1022
1161
  * <p>The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
1023
1162
  * <p>You can use <a>DescribeConnections</a> or <a>DescribeLags</a> to retrieve connection ID.</p>
1024
1163
  */
1025
1164
  connectionId: string | undefined;
1026
1165
  /**
1166
+ * @public
1027
1167
  * <p>The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.</p>
1028
1168
  * <p>You can use <a>DescribeConnections</a> or <a>DescribeLags</a> to retrieve the MAC Security (MACsec) secret key.</p>
1029
1169
  * <p>If you use this request parameter, you do not use the <code>ckn</code> and <code>cak</code> request parameters.</p>
1030
1170
  */
1031
1171
  secretARN?: string;
1032
1172
  /**
1173
+ * @public
1033
1174
  * <p>The MAC Security (MACsec) CKN to associate with the dedicated connection.</p>
1034
1175
  * <p>You can create the CKN/CAK pair using an industry standard tool.</p>
1035
1176
  * <p> The valid values are 64 hexadecimal characters (0-9, A-E).</p>
@@ -1037,6 +1178,7 @@ export interface AssociateMacSecKeyRequest {
1037
1178
  */
1038
1179
  ckn?: string;
1039
1180
  /**
1181
+ * @public
1040
1182
  * <p>The MAC Security (MACsec) CAK to associate with the dedicated connection.</p>
1041
1183
  * <p>You can create the CKN/CAK pair using an industry standard tool.</p>
1042
1184
  * <p> The valid values are 64 hexadecimal characters (0-9, A-E).</p>
@@ -1049,10 +1191,12 @@ export interface AssociateMacSecKeyRequest {
1049
1191
  */
1050
1192
  export interface AssociateMacSecKeyResponse {
1051
1193
  /**
1194
+ * @public
1052
1195
  * <p>The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
1053
1196
  */
1054
1197
  connectionId?: string;
1055
1198
  /**
1199
+ * @public
1056
1200
  * <p>The MAC Security (MACsec) security keys associated with the dedicated connection.</p>
1057
1201
  */
1058
1202
  macSecKeys?: MacSecKey[];
@@ -1062,10 +1206,12 @@ export interface AssociateMacSecKeyResponse {
1062
1206
  */
1063
1207
  export interface AssociateVirtualInterfaceRequest {
1064
1208
  /**
1209
+ * @public
1065
1210
  * <p>The ID of the virtual interface.</p>
1066
1211
  */
1067
1212
  virtualInterfaceId: string | undefined;
1068
1213
  /**
1214
+ * @public
1069
1215
  * <p>The ID of the LAG or connection.</p>
1070
1216
  */
1071
1217
  connectionId: string | undefined;
@@ -1075,6 +1221,7 @@ export interface AssociateVirtualInterfaceRequest {
1075
1221
  */
1076
1222
  export interface ConfirmConnectionRequest {
1077
1223
  /**
1224
+ * @public
1078
1225
  * <p>The ID of the hosted connection.</p>
1079
1226
  */
1080
1227
  connectionId: string | undefined;
@@ -1084,6 +1231,7 @@ export interface ConfirmConnectionRequest {
1084
1231
  */
1085
1232
  export interface ConfirmConnectionResponse {
1086
1233
  /**
1234
+ * @public
1087
1235
  * <p>The state of the connection. The following are the possible values:</p>
1088
1236
  * <ul>
1089
1237
  * <li>
@@ -1131,6 +1279,7 @@ export interface ConfirmConnectionResponse {
1131
1279
  */
1132
1280
  export interface ConfirmCustomerAgreementRequest {
1133
1281
  /**
1282
+ * @public
1134
1283
  * <p>
1135
1284
  *
1136
1285
  * The name of the customer agreement.
@@ -1144,6 +1293,7 @@ export interface ConfirmCustomerAgreementRequest {
1144
1293
  */
1145
1294
  export interface ConfirmCustomerAgreementResponse {
1146
1295
  /**
1296
+ * @public
1147
1297
  * <p>
1148
1298
  * The status of the customer agreement when the connection was created. This will be either <code>signed</code> or <code>unsigned</code>.
1149
1299
  * </p>
@@ -1155,14 +1305,17 @@ export interface ConfirmCustomerAgreementResponse {
1155
1305
  */
1156
1306
  export interface ConfirmPrivateVirtualInterfaceRequest {
1157
1307
  /**
1308
+ * @public
1158
1309
  * <p>The ID of the virtual interface.</p>
1159
1310
  */
1160
1311
  virtualInterfaceId: string | undefined;
1161
1312
  /**
1313
+ * @public
1162
1314
  * <p>The ID of the virtual private gateway.</p>
1163
1315
  */
1164
1316
  virtualGatewayId?: string;
1165
1317
  /**
1318
+ * @public
1166
1319
  * <p>The ID of the Direct Connect gateway.</p>
1167
1320
  */
1168
1321
  directConnectGatewayId?: string;
@@ -1172,6 +1325,7 @@ export interface ConfirmPrivateVirtualInterfaceRequest {
1172
1325
  */
1173
1326
  export interface ConfirmPrivateVirtualInterfaceResponse {
1174
1327
  /**
1328
+ * @public
1175
1329
  * <p>The state of the virtual interface. The following are the possible values:</p>
1176
1330
  * <ul>
1177
1331
  * <li>
@@ -1219,6 +1373,7 @@ export interface ConfirmPrivateVirtualInterfaceResponse {
1219
1373
  */
1220
1374
  export interface ConfirmPublicVirtualInterfaceRequest {
1221
1375
  /**
1376
+ * @public
1222
1377
  * <p>The ID of the virtual interface.</p>
1223
1378
  */
1224
1379
  virtualInterfaceId: string | undefined;
@@ -1228,6 +1383,7 @@ export interface ConfirmPublicVirtualInterfaceRequest {
1228
1383
  */
1229
1384
  export interface ConfirmPublicVirtualInterfaceResponse {
1230
1385
  /**
1386
+ * @public
1231
1387
  * <p>The state of the virtual interface. The following are the possible values:</p>
1232
1388
  * <ul>
1233
1389
  * <li>
@@ -1275,10 +1431,12 @@ export interface ConfirmPublicVirtualInterfaceResponse {
1275
1431
  */
1276
1432
  export interface ConfirmTransitVirtualInterfaceRequest {
1277
1433
  /**
1434
+ * @public
1278
1435
  * <p>The ID of the virtual interface.</p>
1279
1436
  */
1280
1437
  virtualInterfaceId: string | undefined;
1281
1438
  /**
1439
+ * @public
1282
1440
  * <p>The ID of the Direct Connect gateway.</p>
1283
1441
  */
1284
1442
  directConnectGatewayId: string | undefined;
@@ -1288,6 +1446,7 @@ export interface ConfirmTransitVirtualInterfaceRequest {
1288
1446
  */
1289
1447
  export interface ConfirmTransitVirtualInterfaceResponse {
1290
1448
  /**
1449
+ * @public
1291
1450
  * <p>The state of the virtual interface. The following are the possible values:</p>
1292
1451
  * <ul>
1293
1452
  * <li>
@@ -1335,6 +1494,7 @@ export interface ConfirmTransitVirtualInterfaceResponse {
1335
1494
  */
1336
1495
  export interface Connections {
1337
1496
  /**
1497
+ * @public
1338
1498
  * <p>The connections.</p>
1339
1499
  */
1340
1500
  connections?: Connection[];
@@ -1345,22 +1505,27 @@ export interface Connections {
1345
1505
  */
1346
1506
  export interface NewBGPPeer {
1347
1507
  /**
1508
+ * @public
1348
1509
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
1349
1510
  */
1350
1511
  asn?: number;
1351
1512
  /**
1513
+ * @public
1352
1514
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
1353
1515
  */
1354
1516
  authKey?: string;
1355
1517
  /**
1518
+ * @public
1356
1519
  * <p>The address family for the BGP peer.</p>
1357
1520
  */
1358
1521
  addressFamily?: AddressFamily | string;
1359
1522
  /**
1523
+ * @public
1360
1524
  * <p>The IP address assigned to the Amazon interface.</p>
1361
1525
  */
1362
1526
  amazonAddress?: string;
1363
1527
  /**
1528
+ * @public
1364
1529
  * <p>The IP address assigned to the customer interface.</p>
1365
1530
  */
1366
1531
  customerAddress?: string;
@@ -1370,10 +1535,12 @@ export interface NewBGPPeer {
1370
1535
  */
1371
1536
  export interface CreateBGPPeerRequest {
1372
1537
  /**
1538
+ * @public
1373
1539
  * <p>The ID of the virtual interface.</p>
1374
1540
  */
1375
1541
  virtualInterfaceId?: string;
1376
1542
  /**
1543
+ * @public
1377
1544
  * <p>Information about the BGP peer.</p>
1378
1545
  */
1379
1546
  newBGPPeer?: NewBGPPeer;
@@ -1383,6 +1550,7 @@ export interface CreateBGPPeerRequest {
1383
1550
  */
1384
1551
  export interface CreateBGPPeerResponse {
1385
1552
  /**
1553
+ * @public
1386
1554
  * <p>The virtual interface.</p>
1387
1555
  */
1388
1556
  virtualInterface?: VirtualInterface;
@@ -1392,30 +1560,37 @@ export interface CreateBGPPeerResponse {
1392
1560
  */
1393
1561
  export interface CreateConnectionRequest {
1394
1562
  /**
1563
+ * @public
1395
1564
  * <p>The location of the connection.</p>
1396
1565
  */
1397
1566
  location: string | undefined;
1398
1567
  /**
1568
+ * @public
1399
1569
  * <p>The bandwidth of the connection.</p>
1400
1570
  */
1401
1571
  bandwidth: string | undefined;
1402
1572
  /**
1573
+ * @public
1403
1574
  * <p>The name of the connection.</p>
1404
1575
  */
1405
1576
  connectionName: string | undefined;
1406
1577
  /**
1578
+ * @public
1407
1579
  * <p>The ID of the LAG.</p>
1408
1580
  */
1409
1581
  lagId?: string;
1410
1582
  /**
1583
+ * @public
1411
1584
  * <p>The tags to associate with the lag.</p>
1412
1585
  */
1413
1586
  tags?: Tag[];
1414
1587
  /**
1588
+ * @public
1415
1589
  * <p>The name of the service provider associated with the requested connection.</p>
1416
1590
  */
1417
1591
  providerName?: string;
1418
1592
  /**
1593
+ * @public
1419
1594
  * <p>Indicates whether you want the connection to support MAC Security (MACsec).</p>
1420
1595
  * <p>MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see <a href="https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites">MACsec prerequisties</a> in the <i>Direct Connect User Guide</i>.</p>
1421
1596
  */
@@ -1426,10 +1601,12 @@ export interface CreateConnectionRequest {
1426
1601
  */
1427
1602
  export interface CreateDirectConnectGatewayRequest {
1428
1603
  /**
1604
+ * @public
1429
1605
  * <p>The name of the Direct Connect gateway.</p>
1430
1606
  */
1431
1607
  directConnectGatewayName: string | undefined;
1432
1608
  /**
1609
+ * @public
1433
1610
  * <p>The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured
1434
1611
  * on the Amazon side of the connection. The ASN must be in the private range of 64,512 to
1435
1612
  * 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.</p>
@@ -1456,22 +1633,27 @@ export type DirectConnectGatewayState = (typeof DirectConnectGatewayState)[keyof
1456
1633
  */
1457
1634
  export interface DirectConnectGateway {
1458
1635
  /**
1636
+ * @public
1459
1637
  * <p>The ID of the Direct Connect gateway.</p>
1460
1638
  */
1461
1639
  directConnectGatewayId?: string;
1462
1640
  /**
1641
+ * @public
1463
1642
  * <p>The name of the Direct Connect gateway.</p>
1464
1643
  */
1465
1644
  directConnectGatewayName?: string;
1466
1645
  /**
1646
+ * @public
1467
1647
  * <p>The autonomous system number (ASN) for the Amazon side of the connection.</p>
1468
1648
  */
1469
1649
  amazonSideAsn?: number;
1470
1650
  /**
1651
+ * @public
1471
1652
  * <p>The ID of the Amazon Web Services account that owns the Direct Connect gateway.</p>
1472
1653
  */
1473
1654
  ownerAccount?: string;
1474
1655
  /**
1656
+ * @public
1475
1657
  * <p>The state of the Direct Connect gateway. The following are the possible values:</p>
1476
1658
  * <ul>
1477
1659
  * <li>
@@ -1494,6 +1676,7 @@ export interface DirectConnectGateway {
1494
1676
  */
1495
1677
  directConnectGatewayState?: DirectConnectGatewayState | string;
1496
1678
  /**
1679
+ * @public
1497
1680
  * <p>The error message if the state of an object failed to advance.</p>
1498
1681
  */
1499
1682
  stateChangeError?: string;
@@ -1503,6 +1686,7 @@ export interface DirectConnectGateway {
1503
1686
  */
1504
1687
  export interface CreateDirectConnectGatewayResult {
1505
1688
  /**
1689
+ * @public
1506
1690
  * <p>The Direct Connect gateway.</p>
1507
1691
  */
1508
1692
  directConnectGateway?: DirectConnectGateway;
@@ -1512,20 +1696,24 @@ export interface CreateDirectConnectGatewayResult {
1512
1696
  */
1513
1697
  export interface CreateDirectConnectGatewayAssociationRequest {
1514
1698
  /**
1699
+ * @public
1515
1700
  * <p>The ID of the Direct Connect gateway.</p>
1516
1701
  */
1517
1702
  directConnectGatewayId: string | undefined;
1518
1703
  /**
1704
+ * @public
1519
1705
  * <p>The ID of the virtual private gateway or transit gateway.</p>
1520
1706
  */
1521
1707
  gatewayId?: string;
1522
1708
  /**
1709
+ * @public
1523
1710
  * <p>The Amazon VPC prefixes to advertise to the Direct Connect gateway</p>
1524
1711
  * <p>This parameter is required when you create an association to a transit gateway.</p>
1525
1712
  * <p>For information about how to set the prefixes, see <a href="https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-vgw.html#allowed-prefixes">Allowed Prefixes</a> in the <i>Direct Connect User Guide</i>.</p>
1526
1713
  */
1527
1714
  addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
1528
1715
  /**
1716
+ * @public
1529
1717
  * <p>The ID of the virtual private gateway.</p>
1530
1718
  */
1531
1719
  virtualGatewayId?: string;
@@ -1535,6 +1723,7 @@ export interface CreateDirectConnectGatewayAssociationRequest {
1535
1723
  */
1536
1724
  export interface CreateDirectConnectGatewayAssociationResult {
1537
1725
  /**
1726
+ * @public
1538
1727
  * <p>The association to be created.</p>
1539
1728
  */
1540
1729
  directConnectGatewayAssociation?: DirectConnectGatewayAssociation;
@@ -1544,22 +1733,27 @@ export interface CreateDirectConnectGatewayAssociationResult {
1544
1733
  */
1545
1734
  export interface CreateDirectConnectGatewayAssociationProposalRequest {
1546
1735
  /**
1736
+ * @public
1547
1737
  * <p>The ID of the Direct Connect gateway.</p>
1548
1738
  */
1549
1739
  directConnectGatewayId: string | undefined;
1550
1740
  /**
1741
+ * @public
1551
1742
  * <p>The ID of the Amazon Web Services account that owns the Direct Connect gateway.</p>
1552
1743
  */
1553
1744
  directConnectGatewayOwnerAccount: string | undefined;
1554
1745
  /**
1746
+ * @public
1555
1747
  * <p>The ID of the virtual private gateway or transit gateway.</p>
1556
1748
  */
1557
1749
  gatewayId: string | undefined;
1558
1750
  /**
1751
+ * @public
1559
1752
  * <p>The Amazon VPC prefixes to advertise to the Direct Connect gateway.</p>
1560
1753
  */
1561
1754
  addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
1562
1755
  /**
1756
+ * @public
1563
1757
  * <p>The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.</p>
1564
1758
  */
1565
1759
  removeAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
@@ -1583,18 +1777,22 @@ export type DirectConnectGatewayAssociationProposalState = (typeof DirectConnect
1583
1777
  */
1584
1778
  export interface DirectConnectGatewayAssociationProposal {
1585
1779
  /**
1780
+ * @public
1586
1781
  * <p>The ID of the association proposal.</p>
1587
1782
  */
1588
1783
  proposalId?: string;
1589
1784
  /**
1785
+ * @public
1590
1786
  * <p>The ID of the Direct Connect gateway.</p>
1591
1787
  */
1592
1788
  directConnectGatewayId?: string;
1593
1789
  /**
1790
+ * @public
1594
1791
  * <p>The ID of the Amazon Web Services account that owns the Direct Connect gateway.</p>
1595
1792
  */
1596
1793
  directConnectGatewayOwnerAccount?: string;
1597
1794
  /**
1795
+ * @public
1598
1796
  * <p>The state of the proposal. The following are possible values:</p>
1599
1797
  * <ul>
1600
1798
  * <li>
@@ -1613,14 +1811,17 @@ export interface DirectConnectGatewayAssociationProposal {
1613
1811
  */
1614
1812
  proposalState?: DirectConnectGatewayAssociationProposalState | string;
1615
1813
  /**
1814
+ * @public
1616
1815
  * <p>Information about the associated gateway.</p>
1617
1816
  */
1618
1817
  associatedGateway?: AssociatedGateway;
1619
1818
  /**
1819
+ * @public
1620
1820
  * <p>The existing Amazon VPC prefixes advertised to the Direct Connect gateway.</p>
1621
1821
  */
1622
1822
  existingAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
1623
1823
  /**
1824
+ * @public
1624
1825
  * <p>The Amazon VPC prefixes to advertise to the Direct Connect gateway.</p>
1625
1826
  */
1626
1827
  requestedAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
@@ -1630,6 +1831,7 @@ export interface DirectConnectGatewayAssociationProposal {
1630
1831
  */
1631
1832
  export interface CreateDirectConnectGatewayAssociationProposalResult {
1632
1833
  /**
1834
+ * @public
1633
1835
  * <p>Information about the Direct Connect gateway proposal.</p>
1634
1836
  */
1635
1837
  directConnectGatewayAssociationProposal?: DirectConnectGatewayAssociationProposal;
@@ -1639,26 +1841,32 @@ export interface CreateDirectConnectGatewayAssociationProposalResult {
1639
1841
  */
1640
1842
  export interface CreateInterconnectRequest {
1641
1843
  /**
1844
+ * @public
1642
1845
  * <p>The name of the interconnect.</p>
1643
1846
  */
1644
1847
  interconnectName: string | undefined;
1645
1848
  /**
1849
+ * @public
1646
1850
  * <p>The port bandwidth, in Gbps. The possible values are 1 and 10.</p>
1647
1851
  */
1648
1852
  bandwidth: string | undefined;
1649
1853
  /**
1854
+ * @public
1650
1855
  * <p>The location of the interconnect.</p>
1651
1856
  */
1652
1857
  location: string | undefined;
1653
1858
  /**
1859
+ * @public
1654
1860
  * <p>The ID of the LAG.</p>
1655
1861
  */
1656
1862
  lagId?: string;
1657
1863
  /**
1864
+ * @public
1658
1865
  * <p>The tags to associate with the interconnect.</p>
1659
1866
  */
1660
1867
  tags?: Tag[];
1661
1868
  /**
1869
+ * @public
1662
1870
  * <p>The name of the service provider associated with the interconnect.</p>
1663
1871
  */
1664
1872
  providerName?: string;
@@ -1686,14 +1894,17 @@ export type InterconnectState = (typeof InterconnectState)[keyof typeof Intercon
1686
1894
  */
1687
1895
  export interface Interconnect {
1688
1896
  /**
1897
+ * @public
1689
1898
  * <p>The ID of the interconnect.</p>
1690
1899
  */
1691
1900
  interconnectId?: string;
1692
1901
  /**
1902
+ * @public
1693
1903
  * <p>The name of the interconnect.</p>
1694
1904
  */
1695
1905
  interconnectName?: string;
1696
1906
  /**
1907
+ * @public
1697
1908
  * <p>The state of the interconnect. The following are the possible values:</p>
1698
1909
  * <ul>
1699
1910
  * <li>
@@ -1729,53 +1940,65 @@ export interface Interconnect {
1729
1940
  */
1730
1941
  interconnectState?: InterconnectState | string;
1731
1942
  /**
1943
+ * @public
1732
1944
  * <p>The Amazon Web Services Region where the connection is located.</p>
1733
1945
  */
1734
1946
  region?: string;
1735
1947
  /**
1948
+ * @public
1736
1949
  * <p>The location of the connection.</p>
1737
1950
  */
1738
1951
  location?: string;
1739
1952
  /**
1953
+ * @public
1740
1954
  * <p>The bandwidth of the connection.</p>
1741
1955
  */
1742
1956
  bandwidth?: string;
1743
1957
  /**
1958
+ * @public
1744
1959
  * <p>The time of the most recent call to <a>DescribeLoa</a> for this connection.</p>
1745
1960
  */
1746
1961
  loaIssueTime?: Date;
1747
1962
  /**
1963
+ * @public
1748
1964
  * <p>The ID of the LAG.</p>
1749
1965
  */
1750
1966
  lagId?: string;
1751
1967
  /**
1968
+ * @public
1752
1969
  * @deprecated
1753
1970
  *
1754
1971
  * <p>The Direct Connect endpoint on which the physical connection terminates.</p>
1755
1972
  */
1756
1973
  awsDevice?: string;
1757
1974
  /**
1975
+ * @public
1758
1976
  * <p>Indicates whether jumbo frames are supported.</p>
1759
1977
  */
1760
1978
  jumboFrameCapable?: boolean;
1761
1979
  /**
1980
+ * @public
1762
1981
  * <p>The Direct Connect endpoint that terminates the physical connection.</p>
1763
1982
  */
1764
1983
  awsDeviceV2?: string;
1765
1984
  /**
1985
+ * @public
1766
1986
  * <p>The Direct Connect endpoint that terminates the logical connection. This device might be
1767
1987
  * different than the device that terminates the physical connection.</p>
1768
1988
  */
1769
1989
  awsLogicalDeviceId?: string;
1770
1990
  /**
1991
+ * @public
1771
1992
  * <p>Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).</p>
1772
1993
  */
1773
1994
  hasLogicalRedundancy?: HasLogicalRedundancy | string;
1774
1995
  /**
1996
+ * @public
1775
1997
  * <p>The tags associated with the interconnect.</p>
1776
1998
  */
1777
1999
  tags?: Tag[];
1778
2000
  /**
2001
+ * @public
1779
2002
  * <p>The name of the service provider associated with the interconnect.</p>
1780
2003
  */
1781
2004
  providerName?: string;
@@ -1785,40 +2008,49 @@ export interface Interconnect {
1785
2008
  */
1786
2009
  export interface CreateLagRequest {
1787
2010
  /**
2011
+ * @public
1788
2012
  * <p>The number of physical dedicated connections initially provisioned and bundled by the
1789
2013
  * LAG. You can have a maximum of four connections when the port speed is 1G or 10G, or two when the port speed is 100G. </p>
1790
2014
  */
1791
2015
  numberOfConnections: number | undefined;
1792
2016
  /**
2017
+ * @public
1793
2018
  * <p>The location for the LAG.</p>
1794
2019
  */
1795
2020
  location: string | undefined;
1796
2021
  /**
2022
+ * @public
1797
2023
  * <p>The bandwidth of the individual physical dedicated connections bundled by the LAG. The
1798
2024
  * possible values are 1Gbps and 10Gbps. </p>
1799
2025
  */
1800
2026
  connectionsBandwidth: string | undefined;
1801
2027
  /**
2028
+ * @public
1802
2029
  * <p>The name of the LAG.</p>
1803
2030
  */
1804
2031
  lagName: string | undefined;
1805
2032
  /**
2033
+ * @public
1806
2034
  * <p>The ID of an existing dedicated connection to migrate to the LAG.</p>
1807
2035
  */
1808
2036
  connectionId?: string;
1809
2037
  /**
2038
+ * @public
1810
2039
  * <p>The tags to associate with the LAG.</p>
1811
2040
  */
1812
2041
  tags?: Tag[];
1813
2042
  /**
2043
+ * @public
1814
2044
  * <p>The tags to associate with the automtically created LAGs.</p>
1815
2045
  */
1816
2046
  childConnectionTags?: Tag[];
1817
2047
  /**
2048
+ * @public
1818
2049
  * <p>The name of the service provider associated with the LAG.</p>
1819
2050
  */
1820
2051
  providerName?: string;
1821
2052
  /**
2053
+ * @public
1822
2054
  * <p>Indicates whether the connection will support MAC Security (MACsec).</p>
1823
2055
  * <note>
1824
2056
  * <p>All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see <a href="https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-mac-sec-getting-started.html#mac-sec-prerequisites">MACsec prerequisties</a> in the <i>Direct Connect User Guide</i>.</p>
@@ -1849,27 +2081,33 @@ export type LagState = (typeof LagState)[keyof typeof LagState];
1849
2081
  */
1850
2082
  export interface Lag {
1851
2083
  /**
2084
+ * @public
1852
2085
  * <p>The individual bandwidth of the physical connections bundled by the LAG. The possible
1853
2086
  * values are 1Gbps and 10Gbps. </p>
1854
2087
  */
1855
2088
  connectionsBandwidth?: string;
1856
2089
  /**
2090
+ * @public
1857
2091
  * <p>The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.</p>
1858
2092
  */
1859
2093
  numberOfConnections?: number;
1860
2094
  /**
2095
+ * @public
1861
2096
  * <p>The ID of the LAG.</p>
1862
2097
  */
1863
2098
  lagId?: string;
1864
2099
  /**
2100
+ * @public
1865
2101
  * <p>The ID of the Amazon Web Services account that owns the LAG.</p>
1866
2102
  */
1867
2103
  ownerAccount?: string;
1868
2104
  /**
2105
+ * @public
1869
2106
  * <p>The name of the LAG.</p>
1870
2107
  */
1871
2108
  lagName?: string;
1872
2109
  /**
2110
+ * @public
1873
2111
  * <p>The state of the LAG. The following are the possible values:</p>
1874
2112
  * <ul>
1875
2113
  * <li>
@@ -1905,66 +2143,81 @@ export interface Lag {
1905
2143
  */
1906
2144
  lagState?: LagState | string;
1907
2145
  /**
2146
+ * @public
1908
2147
  * <p>The location of the LAG.</p>
1909
2148
  */
1910
2149
  location?: string;
1911
2150
  /**
2151
+ * @public
1912
2152
  * <p>The Amazon Web Services Region where the connection is located.</p>
1913
2153
  */
1914
2154
  region?: string;
1915
2155
  /**
2156
+ * @public
1916
2157
  * <p>The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.</p>
1917
2158
  */
1918
2159
  minimumLinks?: number;
1919
2160
  /**
2161
+ * @public
1920
2162
  * @deprecated
1921
2163
  *
1922
2164
  * <p>The Direct Connect endpoint that hosts the LAG.</p>
1923
2165
  */
1924
2166
  awsDevice?: string;
1925
2167
  /**
2168
+ * @public
1926
2169
  * <p>The Direct Connect endpoint that hosts the LAG.</p>
1927
2170
  */
1928
2171
  awsDeviceV2?: string;
1929
2172
  /**
2173
+ * @public
1930
2174
  * <p>The Direct Connect endpoint that terminates the logical connection. This device might be
1931
2175
  * different than the device that terminates the physical connection.</p>
1932
2176
  */
1933
2177
  awsLogicalDeviceId?: string;
1934
2178
  /**
2179
+ * @public
1935
2180
  * <p>The connections bundled by the LAG.</p>
1936
2181
  */
1937
2182
  connections?: Connection[];
1938
2183
  /**
2184
+ * @public
1939
2185
  * <p>Indicates whether the LAG can host other connections.</p>
1940
2186
  */
1941
2187
  allowsHostedConnections?: boolean;
1942
2188
  /**
2189
+ * @public
1943
2190
  * <p>Indicates whether jumbo frames are supported.</p>
1944
2191
  */
1945
2192
  jumboFrameCapable?: boolean;
1946
2193
  /**
2194
+ * @public
1947
2195
  * <p>Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).</p>
1948
2196
  */
1949
2197
  hasLogicalRedundancy?: HasLogicalRedundancy | string;
1950
2198
  /**
2199
+ * @public
1951
2200
  * <p>The tags associated with the LAG.</p>
1952
2201
  */
1953
2202
  tags?: Tag[];
1954
2203
  /**
2204
+ * @public
1955
2205
  * <p>The name of the service provider associated with the LAG.</p>
1956
2206
  */
1957
2207
  providerName?: string;
1958
2208
  /**
2209
+ * @public
1959
2210
  * <p>Indicates whether the LAG supports MAC Security (MACsec).</p>
1960
2211
  */
1961
2212
  macSecCapable?: boolean;
1962
2213
  /**
2214
+ * @public
1963
2215
  * <p>The LAG MAC Security (MACsec) encryption mode.</p>
1964
2216
  * <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>
1965
2217
  */
1966
2218
  encryptionMode?: string;
1967
2219
  /**
2220
+ * @public
1968
2221
  * <p>The MAC Security (MACsec) security keys associated with the LAG.</p>
1969
2222
  */
1970
2223
  macSecKeys?: MacSecKey[];
@@ -1975,51 +2228,63 @@ export interface Lag {
1975
2228
  */
1976
2229
  export interface NewPrivateVirtualInterface {
1977
2230
  /**
2231
+ * @public
1978
2232
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
1979
2233
  */
1980
2234
  virtualInterfaceName: string | undefined;
1981
2235
  /**
2236
+ * @public
1982
2237
  * <p>The ID of the VLAN.</p>
1983
2238
  */
1984
2239
  vlan: number | undefined;
1985
2240
  /**
2241
+ * @public
1986
2242
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
1987
2243
  * <p>The valid values are 1-2147483647.</p>
1988
2244
  */
1989
2245
  asn: number | undefined;
1990
2246
  /**
2247
+ * @public
1991
2248
  * <p>The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.</p>
1992
2249
  */
1993
2250
  mtu?: number;
1994
2251
  /**
2252
+ * @public
1995
2253
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
1996
2254
  */
1997
2255
  authKey?: string;
1998
2256
  /**
2257
+ * @public
1999
2258
  * <p>The IP address assigned to the Amazon interface.</p>
2000
2259
  */
2001
2260
  amazonAddress?: string;
2002
2261
  /**
2262
+ * @public
2003
2263
  * <p>The IP address assigned to the customer interface.</p>
2004
2264
  */
2005
2265
  customerAddress?: string;
2006
2266
  /**
2267
+ * @public
2007
2268
  * <p>The address family for the BGP peer.</p>
2008
2269
  */
2009
2270
  addressFamily?: AddressFamily | string;
2010
2271
  /**
2272
+ * @public
2011
2273
  * <p>The ID of the virtual private gateway.</p>
2012
2274
  */
2013
2275
  virtualGatewayId?: string;
2014
2276
  /**
2277
+ * @public
2015
2278
  * <p>The ID of the Direct Connect gateway.</p>
2016
2279
  */
2017
2280
  directConnectGatewayId?: string;
2018
2281
  /**
2282
+ * @public
2019
2283
  * <p>The tags associated with the private virtual interface.</p>
2020
2284
  */
2021
2285
  tags?: Tag[];
2022
2286
  /**
2287
+ * @public
2023
2288
  * <p>Indicates whether to enable or disable SiteLink.</p>
2024
2289
  */
2025
2290
  enableSiteLink?: boolean;
@@ -2029,10 +2294,12 @@ export interface NewPrivateVirtualInterface {
2029
2294
  */
2030
2295
  export interface CreatePrivateVirtualInterfaceRequest {
2031
2296
  /**
2297
+ * @public
2032
2298
  * <p>The ID of the connection.</p>
2033
2299
  */
2034
2300
  connectionId: string | undefined;
2035
2301
  /**
2302
+ * @public
2036
2303
  * <p>Information about the private virtual interface.</p>
2037
2304
  */
2038
2305
  newPrivateVirtualInterface: NewPrivateVirtualInterface | undefined;
@@ -2043,39 +2310,48 @@ export interface CreatePrivateVirtualInterfaceRequest {
2043
2310
  */
2044
2311
  export interface NewPublicVirtualInterface {
2045
2312
  /**
2313
+ * @public
2046
2314
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
2047
2315
  */
2048
2316
  virtualInterfaceName: string | undefined;
2049
2317
  /**
2318
+ * @public
2050
2319
  * <p>The ID of the VLAN.</p>
2051
2320
  */
2052
2321
  vlan: number | undefined;
2053
2322
  /**
2323
+ * @public
2054
2324
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
2055
2325
  * <p>The valid values are 1-2147483647.</p>
2056
2326
  */
2057
2327
  asn: number | undefined;
2058
2328
  /**
2329
+ * @public
2059
2330
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
2060
2331
  */
2061
2332
  authKey?: string;
2062
2333
  /**
2334
+ * @public
2063
2335
  * <p>The IP address assigned to the Amazon interface.</p>
2064
2336
  */
2065
2337
  amazonAddress?: string;
2066
2338
  /**
2339
+ * @public
2067
2340
  * <p>The IP address assigned to the customer interface.</p>
2068
2341
  */
2069
2342
  customerAddress?: string;
2070
2343
  /**
2344
+ * @public
2071
2345
  * <p>The address family for the BGP peer.</p>
2072
2346
  */
2073
2347
  addressFamily?: AddressFamily | string;
2074
2348
  /**
2349
+ * @public
2075
2350
  * <p>The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.</p>
2076
2351
  */
2077
2352
  routeFilterPrefixes?: RouteFilterPrefix[];
2078
2353
  /**
2354
+ * @public
2079
2355
  * <p>The tags associated with the public virtual interface.</p>
2080
2356
  */
2081
2357
  tags?: Tag[];
@@ -2085,10 +2361,12 @@ export interface NewPublicVirtualInterface {
2085
2361
  */
2086
2362
  export interface CreatePublicVirtualInterfaceRequest {
2087
2363
  /**
2364
+ * @public
2088
2365
  * <p>The ID of the connection.</p>
2089
2366
  */
2090
2367
  connectionId: string | undefined;
2091
2368
  /**
2369
+ * @public
2092
2370
  * <p>Information about the public virtual interface.</p>
2093
2371
  */
2094
2372
  newPublicVirtualInterface: NewPublicVirtualInterface | undefined;
@@ -2099,47 +2377,58 @@ export interface CreatePublicVirtualInterfaceRequest {
2099
2377
  */
2100
2378
  export interface NewTransitVirtualInterface {
2101
2379
  /**
2380
+ * @public
2102
2381
  * <p>The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).</p>
2103
2382
  */
2104
2383
  virtualInterfaceName?: string;
2105
2384
  /**
2385
+ * @public
2106
2386
  * <p>The ID of the VLAN.</p>
2107
2387
  */
2108
2388
  vlan?: number;
2109
2389
  /**
2390
+ * @public
2110
2391
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
2111
2392
  * <p>The valid values are 1-2147483647.</p>
2112
2393
  */
2113
2394
  asn?: number;
2114
2395
  /**
2396
+ * @public
2115
2397
  * <p>The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.</p>
2116
2398
  */
2117
2399
  mtu?: number;
2118
2400
  /**
2401
+ * @public
2119
2402
  * <p>The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.</p>
2120
2403
  */
2121
2404
  authKey?: string;
2122
2405
  /**
2406
+ * @public
2123
2407
  * <p>The IP address assigned to the Amazon interface.</p>
2124
2408
  */
2125
2409
  amazonAddress?: string;
2126
2410
  /**
2411
+ * @public
2127
2412
  * <p>The IP address assigned to the customer interface.</p>
2128
2413
  */
2129
2414
  customerAddress?: string;
2130
2415
  /**
2416
+ * @public
2131
2417
  * <p>The address family for the BGP peer.</p>
2132
2418
  */
2133
2419
  addressFamily?: AddressFamily | string;
2134
2420
  /**
2421
+ * @public
2135
2422
  * <p>The ID of the Direct Connect gateway.</p>
2136
2423
  */
2137
2424
  directConnectGatewayId?: string;
2138
2425
  /**
2426
+ * @public
2139
2427
  * <p>The tags associated with the transitive virtual interface.</p>
2140
2428
  */
2141
2429
  tags?: Tag[];
2142
2430
  /**
2431
+ * @public
2143
2432
  * <p>Indicates whether to enable or disable SiteLink.</p>
2144
2433
  */
2145
2434
  enableSiteLink?: boolean;
@@ -2149,10 +2438,12 @@ export interface NewTransitVirtualInterface {
2149
2438
  */
2150
2439
  export interface CreateTransitVirtualInterfaceRequest {
2151
2440
  /**
2441
+ * @public
2152
2442
  * <p>The ID of the connection.</p>
2153
2443
  */
2154
2444
  connectionId: string | undefined;
2155
2445
  /**
2446
+ * @public
2156
2447
  * <p>Information about the transit virtual interface.</p>
2157
2448
  */
2158
2449
  newTransitVirtualInterface: NewTransitVirtualInterface | undefined;
@@ -2162,6 +2453,7 @@ export interface CreateTransitVirtualInterfaceRequest {
2162
2453
  */
2163
2454
  export interface CreateTransitVirtualInterfaceResult {
2164
2455
  /**
2456
+ * @public
2165
2457
  * <p>Information about a virtual interface.</p>
2166
2458
  */
2167
2459
  virtualInterface?: VirtualInterface;
@@ -2171,18 +2463,22 @@ export interface CreateTransitVirtualInterfaceResult {
2171
2463
  */
2172
2464
  export interface DeleteBGPPeerRequest {
2173
2465
  /**
2466
+ * @public
2174
2467
  * <p>The ID of the virtual interface.</p>
2175
2468
  */
2176
2469
  virtualInterfaceId?: string;
2177
2470
  /**
2471
+ * @public
2178
2472
  * <p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p>
2179
2473
  */
2180
2474
  asn?: number;
2181
2475
  /**
2476
+ * @public
2182
2477
  * <p>The IP address assigned to the customer interface.</p>
2183
2478
  */
2184
2479
  customerAddress?: string;
2185
2480
  /**
2481
+ * @public
2186
2482
  * <p>The ID of the BGP peer.</p>
2187
2483
  */
2188
2484
  bgpPeerId?: string;
@@ -2192,6 +2488,7 @@ export interface DeleteBGPPeerRequest {
2192
2488
  */
2193
2489
  export interface DeleteBGPPeerResponse {
2194
2490
  /**
2491
+ * @public
2195
2492
  * <p>The virtual interface.</p>
2196
2493
  */
2197
2494
  virtualInterface?: VirtualInterface;
@@ -2201,6 +2498,7 @@ export interface DeleteBGPPeerResponse {
2201
2498
  */
2202
2499
  export interface DeleteConnectionRequest {
2203
2500
  /**
2501
+ * @public
2204
2502
  * <p>The ID of the connection.</p>
2205
2503
  */
2206
2504
  connectionId: string | undefined;
@@ -2210,6 +2508,7 @@ export interface DeleteConnectionRequest {
2210
2508
  */
2211
2509
  export interface DeleteDirectConnectGatewayRequest {
2212
2510
  /**
2511
+ * @public
2213
2512
  * <p>The ID of the Direct Connect gateway.</p>
2214
2513
  */
2215
2514
  directConnectGatewayId: string | undefined;
@@ -2219,6 +2518,7 @@ export interface DeleteDirectConnectGatewayRequest {
2219
2518
  */
2220
2519
  export interface DeleteDirectConnectGatewayResult {
2221
2520
  /**
2521
+ * @public
2222
2522
  * <p>The Direct Connect gateway.</p>
2223
2523
  */
2224
2524
  directConnectGateway?: DirectConnectGateway;
@@ -2228,14 +2528,17 @@ export interface DeleteDirectConnectGatewayResult {
2228
2528
  */
2229
2529
  export interface DeleteDirectConnectGatewayAssociationRequest {
2230
2530
  /**
2531
+ * @public
2231
2532
  * <p>The ID of the Direct Connect gateway association.</p>
2232
2533
  */
2233
2534
  associationId?: string;
2234
2535
  /**
2536
+ * @public
2235
2537
  * <p>The ID of the Direct Connect gateway.</p>
2236
2538
  */
2237
2539
  directConnectGatewayId?: string;
2238
2540
  /**
2541
+ * @public
2239
2542
  * <p>The ID of the virtual private gateway.</p>
2240
2543
  */
2241
2544
  virtualGatewayId?: string;
@@ -2245,6 +2548,7 @@ export interface DeleteDirectConnectGatewayAssociationRequest {
2245
2548
  */
2246
2549
  export interface DeleteDirectConnectGatewayAssociationResult {
2247
2550
  /**
2551
+ * @public
2248
2552
  * <p>Information about the deleted association.</p>
2249
2553
  */
2250
2554
  directConnectGatewayAssociation?: DirectConnectGatewayAssociation;
@@ -2254,6 +2558,7 @@ export interface DeleteDirectConnectGatewayAssociationResult {
2254
2558
  */
2255
2559
  export interface DeleteDirectConnectGatewayAssociationProposalRequest {
2256
2560
  /**
2561
+ * @public
2257
2562
  * <p>The ID of the proposal.</p>
2258
2563
  */
2259
2564
  proposalId: string | undefined;
@@ -2263,6 +2568,7 @@ export interface DeleteDirectConnectGatewayAssociationProposalRequest {
2263
2568
  */
2264
2569
  export interface DeleteDirectConnectGatewayAssociationProposalResult {
2265
2570
  /**
2571
+ * @public
2266
2572
  * <p>The ID of the associated gateway.</p>
2267
2573
  */
2268
2574
  directConnectGatewayAssociationProposal?: DirectConnectGatewayAssociationProposal;
@@ -2272,6 +2578,7 @@ export interface DeleteDirectConnectGatewayAssociationProposalResult {
2272
2578
  */
2273
2579
  export interface DeleteInterconnectRequest {
2274
2580
  /**
2581
+ * @public
2275
2582
  * <p>The ID of the interconnect.</p>
2276
2583
  */
2277
2584
  interconnectId: string | undefined;
@@ -2281,6 +2588,7 @@ export interface DeleteInterconnectRequest {
2281
2588
  */
2282
2589
  export interface DeleteInterconnectResponse {
2283
2590
  /**
2591
+ * @public
2284
2592
  * <p>The state of the interconnect. The following are the possible values:</p>
2285
2593
  * <ul>
2286
2594
  * <li>
@@ -2321,6 +2629,7 @@ export interface DeleteInterconnectResponse {
2321
2629
  */
2322
2630
  export interface DeleteLagRequest {
2323
2631
  /**
2632
+ * @public
2324
2633
  * <p>The ID of the LAG.</p>
2325
2634
  */
2326
2635
  lagId: string | undefined;
@@ -2330,6 +2639,7 @@ export interface DeleteLagRequest {
2330
2639
  */
2331
2640
  export interface DeleteVirtualInterfaceRequest {
2332
2641
  /**
2642
+ * @public
2333
2643
  * <p>The ID of the virtual interface.</p>
2334
2644
  */
2335
2645
  virtualInterfaceId: string | undefined;
@@ -2339,6 +2649,7 @@ export interface DeleteVirtualInterfaceRequest {
2339
2649
  */
2340
2650
  export interface DeleteVirtualInterfaceResponse {
2341
2651
  /**
2652
+ * @public
2342
2653
  * <p>The state of the virtual interface. The following are the possible values:</p>
2343
2654
  * <ul>
2344
2655
  * <li>
@@ -2397,15 +2708,18 @@ export type LoaContentType = (typeof LoaContentType)[keyof typeof LoaContentType
2397
2708
  */
2398
2709
  export interface DescribeConnectionLoaRequest {
2399
2710
  /**
2711
+ * @public
2400
2712
  * <p>The ID of the connection.</p>
2401
2713
  */
2402
2714
  connectionId: string | undefined;
2403
2715
  /**
2716
+ * @public
2404
2717
  * <p>The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter,
2405
2718
  * the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p>
2406
2719
  */
2407
2720
  providerName?: string;
2408
2721
  /**
2722
+ * @public
2409
2723
  * <p>The standard media type for the LOA-CFA document. The only supported value is application/pdf.</p>
2410
2724
  */
2411
2725
  loaContentType?: LoaContentType | string;
@@ -2416,10 +2730,12 @@ export interface DescribeConnectionLoaRequest {
2416
2730
  */
2417
2731
  export interface Loa {
2418
2732
  /**
2733
+ * @public
2419
2734
  * <p>The binary contents of the LOA-CFA document.</p>
2420
2735
  */
2421
2736
  loaContent?: Uint8Array;
2422
2737
  /**
2738
+ * @public
2423
2739
  * <p>The standard media type for the LOA-CFA document. The only supported value is application/pdf.</p>
2424
2740
  */
2425
2741
  loaContentType?: LoaContentType | string;
@@ -2429,6 +2745,7 @@ export interface Loa {
2429
2745
  */
2430
2746
  export interface DescribeConnectionLoaResponse {
2431
2747
  /**
2748
+ * @public
2432
2749
  * <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).</p>
2433
2750
  */
2434
2751
  loa?: Loa;
@@ -2438,6 +2755,7 @@ export interface DescribeConnectionLoaResponse {
2438
2755
  */
2439
2756
  export interface DescribeConnectionsRequest {
2440
2757
  /**
2758
+ * @public
2441
2759
  * <p>The ID of the connection.</p>
2442
2760
  */
2443
2761
  connectionId?: string;
@@ -2447,6 +2765,7 @@ export interface DescribeConnectionsRequest {
2447
2765
  */
2448
2766
  export interface DescribeConnectionsOnInterconnectRequest {
2449
2767
  /**
2768
+ * @public
2450
2769
  * <p>The ID of the interconnect.</p>
2451
2770
  */
2452
2771
  interconnectId: string | undefined;
@@ -2469,10 +2788,12 @@ export type NniPartnerType = (typeof NniPartnerType)[keyof typeof NniPartnerType
2469
2788
  */
2470
2789
  export interface DescribeCustomerMetadataResponse {
2471
2790
  /**
2791
+ * @public
2472
2792
  * <p>The list of customer agreements.</p>
2473
2793
  */
2474
2794
  agreements?: CustomerAgreement[];
2475
2795
  /**
2796
+ * @public
2476
2797
  * <p>The type of network-to-network interface (NNI) partner. The partner type will be one of the following:</p>
2477
2798
  * <ul>
2478
2799
  * <li>
@@ -2493,18 +2814,22 @@ export interface DescribeCustomerMetadataResponse {
2493
2814
  */
2494
2815
  export interface DescribeDirectConnectGatewayAssociationProposalsRequest {
2495
2816
  /**
2817
+ * @public
2496
2818
  * <p>The ID of the Direct Connect gateway.</p>
2497
2819
  */
2498
2820
  directConnectGatewayId?: string;
2499
2821
  /**
2822
+ * @public
2500
2823
  * <p>The ID of the proposal.</p>
2501
2824
  */
2502
2825
  proposalId?: string;
2503
2826
  /**
2827
+ * @public
2504
2828
  * <p>The ID of the associated gateway.</p>
2505
2829
  */
2506
2830
  associatedGatewayId?: string;
2507
2831
  /**
2832
+ * @public
2508
2833
  * <p>The maximum number of results to return with a single call.
2509
2834
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
2510
2835
  * <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are
@@ -2512,6 +2837,7 @@ export interface DescribeDirectConnectGatewayAssociationProposalsRequest {
2512
2837
  */
2513
2838
  maxResults?: number;
2514
2839
  /**
2840
+ * @public
2515
2841
  * <p>The token for the next page of results.</p>
2516
2842
  */
2517
2843
  nextToken?: string;
@@ -2521,10 +2847,12 @@ export interface DescribeDirectConnectGatewayAssociationProposalsRequest {
2521
2847
  */
2522
2848
  export interface DescribeDirectConnectGatewayAssociationProposalsResult {
2523
2849
  /**
2850
+ * @public
2524
2851
  * <p>Describes the Direct Connect gateway association proposals.</p>
2525
2852
  */
2526
2853
  directConnectGatewayAssociationProposals?: DirectConnectGatewayAssociationProposal[];
2527
2854
  /**
2855
+ * @public
2528
2856
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
2529
2857
  */
2530
2858
  nextToken?: string;
@@ -2534,18 +2862,22 @@ export interface DescribeDirectConnectGatewayAssociationProposalsResult {
2534
2862
  */
2535
2863
  export interface DescribeDirectConnectGatewayAssociationsRequest {
2536
2864
  /**
2865
+ * @public
2537
2866
  * <p>The ID of the Direct Connect gateway association.</p>
2538
2867
  */
2539
2868
  associationId?: string;
2540
2869
  /**
2870
+ * @public
2541
2871
  * <p>The ID of the associated gateway.</p>
2542
2872
  */
2543
2873
  associatedGatewayId?: string;
2544
2874
  /**
2875
+ * @public
2545
2876
  * <p>The ID of the Direct Connect gateway.</p>
2546
2877
  */
2547
2878
  directConnectGatewayId?: string;
2548
2879
  /**
2880
+ * @public
2549
2881
  * <p>The maximum number of results to return with a single call.
2550
2882
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
2551
2883
  * <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are
@@ -2553,10 +2885,12 @@ export interface DescribeDirectConnectGatewayAssociationsRequest {
2553
2885
  */
2554
2886
  maxResults?: number;
2555
2887
  /**
2888
+ * @public
2556
2889
  * <p>The token provided in the previous call to retrieve the next page.</p>
2557
2890
  */
2558
2891
  nextToken?: string;
2559
2892
  /**
2893
+ * @public
2560
2894
  * <p>The ID of the virtual private gateway or transit gateway.</p>
2561
2895
  */
2562
2896
  virtualGatewayId?: string;
@@ -2566,10 +2900,12 @@ export interface DescribeDirectConnectGatewayAssociationsRequest {
2566
2900
  */
2567
2901
  export interface DescribeDirectConnectGatewayAssociationsResult {
2568
2902
  /**
2903
+ * @public
2569
2904
  * <p>Information about the associations.</p>
2570
2905
  */
2571
2906
  directConnectGatewayAssociations?: DirectConnectGatewayAssociation[];
2572
2907
  /**
2908
+ * @public
2573
2909
  * <p>The token to retrieve the next page.</p>
2574
2910
  */
2575
2911
  nextToken?: string;
@@ -2579,14 +2915,17 @@ export interface DescribeDirectConnectGatewayAssociationsResult {
2579
2915
  */
2580
2916
  export interface DescribeDirectConnectGatewayAttachmentsRequest {
2581
2917
  /**
2918
+ * @public
2582
2919
  * <p>The ID of the Direct Connect gateway.</p>
2583
2920
  */
2584
2921
  directConnectGatewayId?: string;
2585
2922
  /**
2923
+ * @public
2586
2924
  * <p>The ID of the virtual interface.</p>
2587
2925
  */
2588
2926
  virtualInterfaceId?: string;
2589
2927
  /**
2928
+ * @public
2590
2929
  * <p>The maximum number of results to return with a single call.
2591
2930
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
2592
2931
  * <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are
@@ -2594,6 +2933,7 @@ export interface DescribeDirectConnectGatewayAttachmentsRequest {
2594
2933
  */
2595
2934
  maxResults?: number;
2596
2935
  /**
2936
+ * @public
2597
2937
  * <p>The token provided in the previous call to retrieve the next page.</p>
2598
2938
  */
2599
2939
  nextToken?: string;
@@ -2630,22 +2970,27 @@ export type DirectConnectGatewayAttachmentType = (typeof DirectConnectGatewayAtt
2630
2970
  */
2631
2971
  export interface DirectConnectGatewayAttachment {
2632
2972
  /**
2973
+ * @public
2633
2974
  * <p>The ID of the Direct Connect gateway.</p>
2634
2975
  */
2635
2976
  directConnectGatewayId?: string;
2636
2977
  /**
2978
+ * @public
2637
2979
  * <p>The ID of the virtual interface.</p>
2638
2980
  */
2639
2981
  virtualInterfaceId?: string;
2640
2982
  /**
2983
+ * @public
2641
2984
  * <p>The Amazon Web Services Region where the virtual interface is located.</p>
2642
2985
  */
2643
2986
  virtualInterfaceRegion?: string;
2644
2987
  /**
2988
+ * @public
2645
2989
  * <p>The ID of the Amazon Web Services account that owns the virtual interface.</p>
2646
2990
  */
2647
2991
  virtualInterfaceOwnerAccount?: string;
2648
2992
  /**
2993
+ * @public
2649
2994
  * <p>The state of the attachment. The following are the possible values:</p>
2650
2995
  * <ul>
2651
2996
  * <li>
@@ -2668,10 +3013,12 @@ export interface DirectConnectGatewayAttachment {
2668
3013
  */
2669
3014
  attachmentState?: DirectConnectGatewayAttachmentState | string;
2670
3015
  /**
3016
+ * @public
2671
3017
  * <p>The type of attachment.</p>
2672
3018
  */
2673
3019
  attachmentType?: DirectConnectGatewayAttachmentType | string;
2674
3020
  /**
3021
+ * @public
2675
3022
  * <p>The error message if the state of an object failed to advance.</p>
2676
3023
  */
2677
3024
  stateChangeError?: string;
@@ -2681,10 +3028,12 @@ export interface DirectConnectGatewayAttachment {
2681
3028
  */
2682
3029
  export interface DescribeDirectConnectGatewayAttachmentsResult {
2683
3030
  /**
3031
+ * @public
2684
3032
  * <p>The attachments.</p>
2685
3033
  */
2686
3034
  directConnectGatewayAttachments?: DirectConnectGatewayAttachment[];
2687
3035
  /**
3036
+ * @public
2688
3037
  * <p>The token to retrieve the next page.</p>
2689
3038
  */
2690
3039
  nextToken?: string;
@@ -2694,10 +3043,12 @@ export interface DescribeDirectConnectGatewayAttachmentsResult {
2694
3043
  */
2695
3044
  export interface DescribeDirectConnectGatewaysRequest {
2696
3045
  /**
3046
+ * @public
2697
3047
  * <p>The ID of the Direct Connect gateway.</p>
2698
3048
  */
2699
3049
  directConnectGatewayId?: string;
2700
3050
  /**
3051
+ * @public
2701
3052
  * <p>The maximum number of results to return with a single call.
2702
3053
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
2703
3054
  * <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are
@@ -2705,6 +3056,7 @@ export interface DescribeDirectConnectGatewaysRequest {
2705
3056
  */
2706
3057
  maxResults?: number;
2707
3058
  /**
3059
+ * @public
2708
3060
  * <p>The token provided in the previous call to retrieve the next page.</p>
2709
3061
  */
2710
3062
  nextToken?: string;
@@ -2714,10 +3066,12 @@ export interface DescribeDirectConnectGatewaysRequest {
2714
3066
  */
2715
3067
  export interface DescribeDirectConnectGatewaysResult {
2716
3068
  /**
3069
+ * @public
2717
3070
  * <p>The Direct Connect gateways.</p>
2718
3071
  */
2719
3072
  directConnectGateways?: DirectConnectGateway[];
2720
3073
  /**
3074
+ * @public
2721
3075
  * <p>The token to retrieve the next page.</p>
2722
3076
  */
2723
3077
  nextToken?: string;
@@ -2727,6 +3081,7 @@ export interface DescribeDirectConnectGatewaysResult {
2727
3081
  */
2728
3082
  export interface DescribeHostedConnectionsRequest {
2729
3083
  /**
3084
+ * @public
2730
3085
  * <p>The ID of the interconnect or LAG.</p>
2731
3086
  */
2732
3087
  connectionId: string | undefined;
@@ -2736,14 +3091,17 @@ export interface DescribeHostedConnectionsRequest {
2736
3091
  */
2737
3092
  export interface DescribeInterconnectLoaRequest {
2738
3093
  /**
3094
+ * @public
2739
3095
  * <p>The ID of the interconnect.</p>
2740
3096
  */
2741
3097
  interconnectId: string | undefined;
2742
3098
  /**
3099
+ * @public
2743
3100
  * <p>The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p>
2744
3101
  */
2745
3102
  providerName?: string;
2746
3103
  /**
3104
+ * @public
2747
3105
  * <p>The standard media type for the LOA-CFA document. The only supported value is application/pdf.</p>
2748
3106
  */
2749
3107
  loaContentType?: LoaContentType | string;
@@ -2753,6 +3111,7 @@ export interface DescribeInterconnectLoaRequest {
2753
3111
  */
2754
3112
  export interface DescribeInterconnectLoaResponse {
2755
3113
  /**
3114
+ * @public
2756
3115
  * <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).</p>
2757
3116
  */
2758
3117
  loa?: Loa;
@@ -2762,6 +3121,7 @@ export interface DescribeInterconnectLoaResponse {
2762
3121
  */
2763
3122
  export interface DescribeInterconnectsRequest {
2764
3123
  /**
3124
+ * @public
2765
3125
  * <p>The ID of the interconnect.</p>
2766
3126
  */
2767
3127
  interconnectId?: string;
@@ -2771,6 +3131,7 @@ export interface DescribeInterconnectsRequest {
2771
3131
  */
2772
3132
  export interface Interconnects {
2773
3133
  /**
3134
+ * @public
2774
3135
  * <p>The interconnects.</p>
2775
3136
  */
2776
3137
  interconnects?: Interconnect[];
@@ -2780,6 +3141,7 @@ export interface Interconnects {
2780
3141
  */
2781
3142
  export interface DescribeLagsRequest {
2782
3143
  /**
3144
+ * @public
2783
3145
  * <p>The ID of the LAG.</p>
2784
3146
  */
2785
3147
  lagId?: string;
@@ -2789,6 +3151,7 @@ export interface DescribeLagsRequest {
2789
3151
  */
2790
3152
  export interface Lags {
2791
3153
  /**
3154
+ * @public
2792
3155
  * <p>The LAGs.</p>
2793
3156
  */
2794
3157
  lags?: Lag[];
@@ -2798,15 +3161,18 @@ export interface Lags {
2798
3161
  */
2799
3162
  export interface DescribeLoaRequest {
2800
3163
  /**
3164
+ * @public
2801
3165
  * <p>The ID of a connection, LAG, or interconnect.</p>
2802
3166
  */
2803
3167
  connectionId: string | undefined;
2804
3168
  /**
3169
+ * @public
2805
3170
  * <p>The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the
2806
3171
  * LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p>
2807
3172
  */
2808
3173
  providerName?: string;
2809
3174
  /**
3175
+ * @public
2810
3176
  * <p>The standard media type for the LOA-CFA document. The only supported value is application/pdf.</p>
2811
3177
  */
2812
3178
  loaContentType?: LoaContentType | string;
@@ -2817,26 +3183,32 @@ export interface DescribeLoaRequest {
2817
3183
  */
2818
3184
  export interface Location {
2819
3185
  /**
3186
+ * @public
2820
3187
  * <p>The code for the location.</p>
2821
3188
  */
2822
3189
  locationCode?: string;
2823
3190
  /**
3191
+ * @public
2824
3192
  * <p>The name of the location. This includes the name of the colocation partner and the physical site of the building.</p>
2825
3193
  */
2826
3194
  locationName?: string;
2827
3195
  /**
3196
+ * @public
2828
3197
  * <p>The Amazon Web Services Region for the location.</p>
2829
3198
  */
2830
3199
  region?: string;
2831
3200
  /**
3201
+ * @public
2832
3202
  * <p>The available port speeds for the location.</p>
2833
3203
  */
2834
3204
  availablePortSpeeds?: string[];
2835
3205
  /**
3206
+ * @public
2836
3207
  * <p>The name of the service provider for the location.</p>
2837
3208
  */
2838
3209
  availableProviders?: string[];
2839
3210
  /**
3211
+ * @public
2840
3212
  * <p>The available MAC Security (MACsec) port speeds for the location.</p>
2841
3213
  */
2842
3214
  availableMacSecPortSpeeds?: string[];
@@ -2846,6 +3218,7 @@ export interface Location {
2846
3218
  */
2847
3219
  export interface Locations {
2848
3220
  /**
3221
+ * @public
2849
3222
  * <p>The locations.</p>
2850
3223
  */
2851
3224
  locations?: Location[];
@@ -2856,10 +3229,12 @@ export interface Locations {
2856
3229
  */
2857
3230
  export interface DescribeRouterConfigurationRequest {
2858
3231
  /**
3232
+ * @public
2859
3233
  * <p>The ID of the virtual interface.</p>
2860
3234
  */
2861
3235
  virtualInterfaceId: string | undefined;
2862
3236
  /**
3237
+ * @public
2863
3238
  * <p>Identifies the router by a combination of vendor, platform, and software version. For example, <code>CiscoSystemsInc-2900SeriesRouters-IOS124</code>.</p>
2864
3239
  */
2865
3240
  routerTypeIdentifier?: string;
@@ -2870,26 +3245,32 @@ export interface DescribeRouterConfigurationRequest {
2870
3245
  */
2871
3246
  export interface RouterType {
2872
3247
  /**
3248
+ * @public
2873
3249
  * <p>The vendor for the virtual interface's router.</p>
2874
3250
  */
2875
3251
  vendor?: string;
2876
3252
  /**
3253
+ * @public
2877
3254
  * <p>The virtual interface router platform.</p>
2878
3255
  */
2879
3256
  platform?: string;
2880
3257
  /**
3258
+ * @public
2881
3259
  * <p>The router software. </p>
2882
3260
  */
2883
3261
  software?: string;
2884
3262
  /**
3263
+ * @public
2885
3264
  * <p>The template for the virtual interface's router.</p>
2886
3265
  */
2887
3266
  xsltTemplateName?: string;
2888
3267
  /**
3268
+ * @public
2889
3269
  * <p>The MAC Security (MACsec) template for the virtual interface's router.</p>
2890
3270
  */
2891
3271
  xsltTemplateNameForMacSec?: string;
2892
3272
  /**
3273
+ * @public
2893
3274
  * <p>Identifies the router by a combination of vendor, platform, and software version. For example, <code>CiscoSystemsInc-2900SeriesRouters-IOS124</code>.</p>
2894
3275
  */
2895
3276
  routerTypeIdentifier?: string;
@@ -2899,18 +3280,22 @@ export interface RouterType {
2899
3280
  */
2900
3281
  export interface DescribeRouterConfigurationResponse {
2901
3282
  /**
3283
+ * @public
2902
3284
  * <p>The customer router configuration.</p>
2903
3285
  */
2904
3286
  customerRouterConfig?: string;
2905
3287
  /**
3288
+ * @public
2906
3289
  * <p>The details about the router.</p>
2907
3290
  */
2908
3291
  router?: RouterType;
2909
3292
  /**
3293
+ * @public
2910
3294
  * <p>The ID assigned to the virtual interface.</p>
2911
3295
  */
2912
3296
  virtualInterfaceId?: string;
2913
3297
  /**
3298
+ * @public
2914
3299
  * <p>Provides the details about a virtual interface's router.</p>
2915
3300
  */
2916
3301
  virtualInterfaceName?: string;
@@ -2920,6 +3305,7 @@ export interface DescribeRouterConfigurationResponse {
2920
3305
  */
2921
3306
  export interface DescribeTagsRequest {
2922
3307
  /**
3308
+ * @public
2923
3309
  * <p>The Amazon Resource Names (ARNs) of the resources.</p>
2924
3310
  */
2925
3311
  resourceArns: string[] | undefined;
@@ -2930,10 +3316,12 @@ export interface DescribeTagsRequest {
2930
3316
  */
2931
3317
  export interface ResourceTag {
2932
3318
  /**
3319
+ * @public
2933
3320
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2934
3321
  */
2935
3322
  resourceArn?: string;
2936
3323
  /**
3324
+ * @public
2937
3325
  * <p>The tags.</p>
2938
3326
  */
2939
3327
  tags?: Tag[];
@@ -2943,6 +3331,7 @@ export interface ResourceTag {
2943
3331
  */
2944
3332
  export interface DescribeTagsResponse {
2945
3333
  /**
3334
+ * @public
2946
3335
  * <p>Information about the tags.</p>
2947
3336
  */
2948
3337
  resourceTags?: ResourceTag[];
@@ -2953,10 +3342,12 @@ export interface DescribeTagsResponse {
2953
3342
  */
2954
3343
  export interface VirtualGateway {
2955
3344
  /**
3345
+ * @public
2956
3346
  * <p>The ID of the virtual private gateway.</p>
2957
3347
  */
2958
3348
  virtualGatewayId?: string;
2959
3349
  /**
3350
+ * @public
2960
3351
  * <p>The state of the virtual private gateway. The following are the possible values:</p>
2961
3352
  * <ul>
2962
3353
  * <li>
@@ -2984,6 +3375,7 @@ export interface VirtualGateway {
2984
3375
  */
2985
3376
  export interface VirtualGateways {
2986
3377
  /**
3378
+ * @public
2987
3379
  * <p>The virtual private gateways.</p>
2988
3380
  */
2989
3381
  virtualGateways?: VirtualGateway[];
@@ -2993,10 +3385,12 @@ export interface VirtualGateways {
2993
3385
  */
2994
3386
  export interface DescribeVirtualInterfacesRequest {
2995
3387
  /**
3388
+ * @public
2996
3389
  * <p>The ID of the connection.</p>
2997
3390
  */
2998
3391
  connectionId?: string;
2999
3392
  /**
3393
+ * @public
3000
3394
  * <p>The ID of the virtual interface.</p>
3001
3395
  */
3002
3396
  virtualInterfaceId?: string;
@@ -3006,6 +3400,7 @@ export interface DescribeVirtualInterfacesRequest {
3006
3400
  */
3007
3401
  export interface VirtualInterfaces {
3008
3402
  /**
3403
+ * @public
3009
3404
  * <p>The virtual interfaces</p>
3010
3405
  */
3011
3406
  virtualInterfaces?: VirtualInterface[];
@@ -3015,10 +3410,12 @@ export interface VirtualInterfaces {
3015
3410
  */
3016
3411
  export interface DisassociateConnectionFromLagRequest {
3017
3412
  /**
3413
+ * @public
3018
3414
  * <p>The ID of the connection.</p>
3019
3415
  */
3020
3416
  connectionId: string | undefined;
3021
3417
  /**
3418
+ * @public
3022
3419
  * <p>The ID of the LAG.</p>
3023
3420
  */
3024
3421
  lagId: string | undefined;
@@ -3028,11 +3425,13 @@ export interface DisassociateConnectionFromLagRequest {
3028
3425
  */
3029
3426
  export interface DisassociateMacSecKeyRequest {
3030
3427
  /**
3428
+ * @public
3031
3429
  * <p>The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
3032
3430
  * <p>You can use <a>DescribeConnections</a> or <a>DescribeLags</a> to retrieve connection ID.</p>
3033
3431
  */
3034
3432
  connectionId: string | undefined;
3035
3433
  /**
3434
+ * @public
3036
3435
  * <p>The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.</p>
3037
3436
  * <p>You can use <a>DescribeConnections</a> to retrieve the ARN of the MAC Security (MACsec) secret key.</p>
3038
3437
  */
@@ -3043,10 +3442,12 @@ export interface DisassociateMacSecKeyRequest {
3043
3442
  */
3044
3443
  export interface DisassociateMacSecKeyResponse {
3045
3444
  /**
3445
+ * @public
3046
3446
  * <p>The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).</p>
3047
3447
  */
3048
3448
  connectionId?: string;
3049
3449
  /**
3450
+ * @public
3050
3451
  * <p>The MAC Security (MACsec) security keys no longer associated with the dedicated connection.</p>
3051
3452
  */
3052
3453
  macSecKeys?: MacSecKey[];
@@ -3056,22 +3457,27 @@ export interface DisassociateMacSecKeyResponse {
3056
3457
  */
3057
3458
  export interface ListVirtualInterfaceTestHistoryRequest {
3058
3459
  /**
3460
+ * @public
3059
3461
  * <p>The ID of the virtual interface failover test.</p>
3060
3462
  */
3061
3463
  testId?: string;
3062
3464
  /**
3465
+ * @public
3063
3466
  * <p>The ID of the virtual interface that was tested.</p>
3064
3467
  */
3065
3468
  virtualInterfaceId?: string;
3066
3469
  /**
3470
+ * @public
3067
3471
  * <p>The BGP peers that were placed in the DOWN state during the virtual interface failover test.</p>
3068
3472
  */
3069
3473
  bgpPeers?: string[];
3070
3474
  /**
3475
+ * @public
3071
3476
  * <p>The status of the virtual interface failover test.</p>
3072
3477
  */
3073
3478
  status?: string;
3074
3479
  /**
3480
+ * @public
3075
3481
  * <p>The maximum number of results to return with a single call.
3076
3482
  * To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
3077
3483
  * <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are
@@ -3079,6 +3485,7 @@ export interface ListVirtualInterfaceTestHistoryRequest {
3079
3485
  */
3080
3486
  maxResults?: number;
3081
3487
  /**
3488
+ * @public
3082
3489
  * <p>The token for the next page of results.</p>
3083
3490
  */
3084
3491
  nextToken?: string;
@@ -3089,34 +3496,42 @@ export interface ListVirtualInterfaceTestHistoryRequest {
3089
3496
  */
3090
3497
  export interface VirtualInterfaceTestHistory {
3091
3498
  /**
3499
+ * @public
3092
3500
  * <p>The ID of the virtual interface failover test.</p>
3093
3501
  */
3094
3502
  testId?: string;
3095
3503
  /**
3504
+ * @public
3096
3505
  * <p>The ID of the tested virtual interface.</p>
3097
3506
  */
3098
3507
  virtualInterfaceId?: string;
3099
3508
  /**
3509
+ * @public
3100
3510
  * <p>The BGP peers that were put in the DOWN state as part of the virtual interface failover test.</p>
3101
3511
  */
3102
3512
  bgpPeers?: string[];
3103
3513
  /**
3514
+ * @public
3104
3515
  * <p>The status of the virtual interface failover test.</p>
3105
3516
  */
3106
3517
  status?: string;
3107
3518
  /**
3519
+ * @public
3108
3520
  * <p>The owner ID of the tested virtual interface.</p>
3109
3521
  */
3110
3522
  ownerAccount?: string;
3111
3523
  /**
3524
+ * @public
3112
3525
  * <p>The time that the virtual interface failover test ran in minutes.</p>
3113
3526
  */
3114
3527
  testDurationInMinutes?: number;
3115
3528
  /**
3529
+ * @public
3116
3530
  * <p>The time that the virtual interface moves to the DOWN state.</p>
3117
3531
  */
3118
3532
  startTime?: Date;
3119
3533
  /**
3534
+ * @public
3120
3535
  * <p>The time that the virtual interface moves out of the DOWN state.</p>
3121
3536
  */
3122
3537
  endTime?: Date;
@@ -3126,10 +3541,12 @@ export interface VirtualInterfaceTestHistory {
3126
3541
  */
3127
3542
  export interface ListVirtualInterfaceTestHistoryResponse {
3128
3543
  /**
3544
+ * @public
3129
3545
  * <p>The ID of the tested virtual interface.</p>
3130
3546
  */
3131
3547
  virtualInterfaceTestHistory?: VirtualInterfaceTestHistory[];
3132
3548
  /**
3549
+ * @public
3133
3550
  * <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
3134
3551
  */
3135
3552
  nextToken?: string;
@@ -3139,14 +3556,17 @@ export interface ListVirtualInterfaceTestHistoryResponse {
3139
3556
  */
3140
3557
  export interface StartBgpFailoverTestRequest {
3141
3558
  /**
3559
+ * @public
3142
3560
  * <p>The ID of the virtual interface you want to test.</p>
3143
3561
  */
3144
3562
  virtualInterfaceId: string | undefined;
3145
3563
  /**
3564
+ * @public
3146
3565
  * <p>The BGP peers to place in the DOWN state.</p>
3147
3566
  */
3148
3567
  bgpPeers?: string[];
3149
3568
  /**
3569
+ * @public
3150
3570
  * <p>The time in minutes that the virtual interface failover test will last.</p>
3151
3571
  * <p>Maximum value: 4,320 minutes (72 hours).</p>
3152
3572
  * <p>Default: 180 minutes (3 hours).</p>
@@ -3158,6 +3578,7 @@ export interface StartBgpFailoverTestRequest {
3158
3578
  */
3159
3579
  export interface StartBgpFailoverTestResponse {
3160
3580
  /**
3581
+ * @public
3161
3582
  * <p>Information about the virtual interface failover test.</p>
3162
3583
  */
3163
3584
  virtualInterfaceTest?: VirtualInterfaceTestHistory;
@@ -3167,6 +3588,7 @@ export interface StartBgpFailoverTestResponse {
3167
3588
  */
3168
3589
  export interface StopBgpFailoverTestRequest {
3169
3590
  /**
3591
+ * @public
3170
3592
  * <p>The ID of the virtual interface you no longer want to test.</p>
3171
3593
  */
3172
3594
  virtualInterfaceId: string | undefined;
@@ -3176,6 +3598,7 @@ export interface StopBgpFailoverTestRequest {
3176
3598
  */
3177
3599
  export interface StopBgpFailoverTestResponse {
3178
3600
  /**
3601
+ * @public
3179
3602
  * <p>Information about the virtual interface failover test.</p>
3180
3603
  */
3181
3604
  virtualInterfaceTest?: VirtualInterfaceTestHistory;
@@ -3185,10 +3608,12 @@ export interface StopBgpFailoverTestResponse {
3185
3608
  */
3186
3609
  export interface TagResourceRequest {
3187
3610
  /**
3611
+ * @public
3188
3612
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
3189
3613
  */
3190
3614
  resourceArn: string | undefined;
3191
3615
  /**
3616
+ * @public
3192
3617
  * <p>The tags to add.</p>
3193
3618
  */
3194
3619
  tags: Tag[] | undefined;
@@ -3203,10 +3628,12 @@ export interface TagResourceResponse {
3203
3628
  */
3204
3629
  export interface UntagResourceRequest {
3205
3630
  /**
3631
+ * @public
3206
3632
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
3207
3633
  */
3208
3634
  resourceArn: string | undefined;
3209
3635
  /**
3636
+ * @public
3210
3637
  * <p>The tag keys of the tags to remove.</p>
3211
3638
  */
3212
3639
  tagKeys: string[] | undefined;
@@ -3221,15 +3648,18 @@ export interface UntagResourceResponse {
3221
3648
  */
3222
3649
  export interface UpdateConnectionRequest {
3223
3650
  /**
3651
+ * @public
3224
3652
  * <p>The ID of the dedicated connection.</p>
3225
3653
  * <p>You can use <a>DescribeConnections</a> to retrieve the connection ID.</p>
3226
3654
  */
3227
3655
  connectionId: string | undefined;
3228
3656
  /**
3657
+ * @public
3229
3658
  * <p>The name of the connection.</p>
3230
3659
  */
3231
3660
  connectionName?: string;
3232
3661
  /**
3662
+ * @public
3233
3663
  * <p>The connection MAC Security (MACsec) encryption mode.</p>
3234
3664
  * <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>
3235
3665
  */
@@ -3240,10 +3670,12 @@ export interface UpdateConnectionRequest {
3240
3670
  */
3241
3671
  export interface UpdateDirectConnectGatewayRequest {
3242
3672
  /**
3673
+ * @public
3243
3674
  * <p>The ID of the Direct Connect gateway to update.</p>
3244
3675
  */
3245
3676
  directConnectGatewayId: string | undefined;
3246
3677
  /**
3678
+ * @public
3247
3679
  * <p>The new name for the Direct Connect gateway.</p>
3248
3680
  */
3249
3681
  newDirectConnectGatewayName: string | undefined;
@@ -3253,6 +3685,7 @@ export interface UpdateDirectConnectGatewayRequest {
3253
3685
  */
3254
3686
  export interface UpdateDirectConnectGatewayResponse {
3255
3687
  /**
3688
+ * @public
3256
3689
  * <p>Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.</p>
3257
3690
  */
3258
3691
  directConnectGateway?: DirectConnectGateway;
@@ -3262,14 +3695,17 @@ export interface UpdateDirectConnectGatewayResponse {
3262
3695
  */
3263
3696
  export interface UpdateDirectConnectGatewayAssociationRequest {
3264
3697
  /**
3698
+ * @public
3265
3699
  * <p>The ID of the Direct Connect gateway association.</p>
3266
3700
  */
3267
3701
  associationId?: string;
3268
3702
  /**
3703
+ * @public
3269
3704
  * <p>The Amazon VPC prefixes to advertise to the Direct Connect gateway.</p>
3270
3705
  */
3271
3706
  addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
3272
3707
  /**
3708
+ * @public
3273
3709
  * <p>The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.</p>
3274
3710
  */
3275
3711
  removeAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[];
@@ -3279,6 +3715,7 @@ export interface UpdateDirectConnectGatewayAssociationRequest {
3279
3715
  */
3280
3716
  export interface UpdateDirectConnectGatewayAssociationResult {
3281
3717
  /**
3718
+ * @public
3282
3719
  * <p>Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.</p>
3283
3720
  */
3284
3721
  directConnectGatewayAssociation?: DirectConnectGatewayAssociation;
@@ -3288,18 +3725,22 @@ export interface UpdateDirectConnectGatewayAssociationResult {
3288
3725
  */
3289
3726
  export interface UpdateLagRequest {
3290
3727
  /**
3728
+ * @public
3291
3729
  * <p>The ID of the LAG.</p>
3292
3730
  */
3293
3731
  lagId: string | undefined;
3294
3732
  /**
3733
+ * @public
3295
3734
  * <p>The name of the LAG.</p>
3296
3735
  */
3297
3736
  lagName?: string;
3298
3737
  /**
3738
+ * @public
3299
3739
  * <p>The minimum number of physical connections that must be operational for the LAG itself to be operational.</p>
3300
3740
  */
3301
3741
  minimumLinks?: number;
3302
3742
  /**
3743
+ * @public
3303
3744
  * <p>The LAG MAC Security (MACsec) encryption mode.</p>
3304
3745
  * <p>Amazon Web Services applies the value to all connections which are part of the LAG.</p>
3305
3746
  */
@@ -3310,18 +3751,22 @@ export interface UpdateLagRequest {
3310
3751
  */
3311
3752
  export interface UpdateVirtualInterfaceAttributesRequest {
3312
3753
  /**
3754
+ * @public
3313
3755
  * <p>The ID of the virtual private interface.</p>
3314
3756
  */
3315
3757
  virtualInterfaceId: string | undefined;
3316
3758
  /**
3759
+ * @public
3317
3760
  * <p>The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.</p>
3318
3761
  */
3319
3762
  mtu?: number;
3320
3763
  /**
3764
+ * @public
3321
3765
  * <p>Indicates whether to enable or disable SiteLink.</p>
3322
3766
  */
3323
3767
  enableSiteLink?: boolean;
3324
3768
  /**
3769
+ * @public
3325
3770
  * <p>The name of the virtual private interface.</p>
3326
3771
  */
3327
3772
  virtualInterfaceName?: string;