@aws-sdk/client-global-accelerator 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.
@@ -9,11 +9,13 @@ import { GlobalAcceleratorServiceException as __BaseException } from "./GlobalAc
9
9
  */
10
10
  export interface AcceleratorEvent {
11
11
  /**
12
+ * @public
12
13
  * <p>A string that contains an <code>Event</code> message describing changes or errors
13
14
  * when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>
14
15
  */
15
16
  Message?: string;
16
17
  /**
18
+ * @public
17
19
  * <p>A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>
18
20
  */
19
21
  Timestamp?: Date;
@@ -48,16 +50,19 @@ export type IpAddressFamily = (typeof IpAddressFamily)[keyof typeof IpAddressFam
48
50
  */
49
51
  export interface IpSet {
50
52
  /**
53
+ * @public
51
54
  * @deprecated
52
55
  *
53
56
  * <p>IpFamily is deprecated and has been replaced by IpAddressFamily.</p>
54
57
  */
55
58
  IpFamily?: string;
56
59
  /**
60
+ * @public
57
61
  * <p>The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.</p>
58
62
  */
59
63
  IpAddresses?: string[];
60
64
  /**
65
+ * @public
61
66
  * <p>The types of IP addresses included in this IP set. </p>
62
67
  */
63
68
  IpAddressFamily?: IpAddressFamily | string;
@@ -81,28 +86,34 @@ export type AcceleratorStatus = (typeof AcceleratorStatus)[keyof typeof Accelera
81
86
  */
82
87
  export interface Accelerator {
83
88
  /**
89
+ * @public
84
90
  * <p>The Amazon Resource Name (ARN) of the accelerator.</p>
85
91
  */
86
92
  AcceleratorArn?: string;
87
93
  /**
94
+ * @public
88
95
  * <p>The name of the accelerator. The name must contain only alphanumeric characters or
89
96
  * hyphens (-), and must not begin or end with a hyphen.</p>
90
97
  */
91
98
  Name?: string;
92
99
  /**
100
+ * @public
93
101
  * <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
94
102
  */
95
103
  IpAddressType?: IpAddressType | string;
96
104
  /**
105
+ * @public
97
106
  * <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p>
98
107
  * <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
99
108
  */
100
109
  Enabled?: boolean;
101
110
  /**
111
+ * @public
102
112
  * <p>The static IP addresses that Global Accelerator associates with the accelerator.</p>
103
113
  */
104
114
  IpSets?: IpSet[];
105
115
  /**
116
+ * @public
106
117
  * <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.</p>
107
118
  * <p>The naming convention for the DNS name for an accelerator is the following: A lowercase letter a,
108
119
  * followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
@@ -114,18 +125,22 @@ export interface Accelerator {
114
125
  */
115
126
  DnsName?: string;
116
127
  /**
128
+ * @public
117
129
  * <p>Describes the deployment status of the accelerator.</p>
118
130
  */
119
131
  Status?: AcceleratorStatus | string;
120
132
  /**
133
+ * @public
121
134
  * <p>The date and time that the accelerator was created.</p>
122
135
  */
123
136
  CreatedTime?: Date;
124
137
  /**
138
+ * @public
125
139
  * <p>The date and time that the accelerator was last modified.</p>
126
140
  */
127
141
  LastModifiedTime?: Date;
128
142
  /**
143
+ * @public
129
144
  * <p>The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:
130
145
  * two IPv4 addresses and two IPv6 addresses.</p>
131
146
  * <p>The naming convention for the dual-stack DNS name is the following: A lowercase letter a,
@@ -137,6 +152,7 @@ export interface Accelerator {
137
152
  */
138
153
  DualStackDnsName?: string;
139
154
  /**
155
+ * @public
140
156
  * <p>A history of changes that you make to an accelerator in Global Accelerator.</p>
141
157
  */
142
158
  Events?: AcceleratorEvent[];
@@ -147,6 +163,7 @@ export interface Accelerator {
147
163
  */
148
164
  export interface AcceleratorAttributes {
149
165
  /**
166
+ * @public
150
167
  * <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
151
168
  * <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
152
169
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow logs</a> in
@@ -154,12 +171,14 @@ export interface AcceleratorAttributes {
154
171
  */
155
172
  FlowLogsEnabled?: boolean;
156
173
  /**
174
+ * @public
157
175
  * <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
158
176
  * <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
159
177
  * bucket.</p>
160
178
  */
161
179
  FlowLogsS3Bucket?: string;
162
180
  /**
181
+ * @public
163
182
  * <p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
164
183
  * <code>FlowLogsEnabled</code> is <code>true</code>.</p>
165
184
  * <p>If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:</p>
@@ -212,6 +231,7 @@ export declare class AccessDeniedException extends __BaseException {
212
231
  */
213
232
  export interface CustomRoutingEndpointConfiguration {
214
233
  /**
234
+ * @public
215
235
  * <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC)
216
236
  * subnet ID. </p>
217
237
  */
@@ -222,10 +242,12 @@ export interface CustomRoutingEndpointConfiguration {
222
242
  */
223
243
  export interface AddCustomRoutingEndpointsRequest {
224
244
  /**
245
+ * @public
225
246
  * <p>The list of endpoint objects to add to a custom routing accelerator.</p>
226
247
  */
227
248
  EndpointConfigurations: CustomRoutingEndpointConfiguration[] | undefined;
228
249
  /**
250
+ * @public
229
251
  * <p>The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.</p>
230
252
  */
231
253
  EndpointGroupArn: string | undefined;
@@ -237,6 +259,7 @@ export interface AddCustomRoutingEndpointsRequest {
237
259
  */
238
260
  export interface CustomRoutingEndpointDescription {
239
261
  /**
262
+ * @public
240
263
  * <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC)
241
264
  * subnet ID. </p>
242
265
  */
@@ -247,10 +270,12 @@ export interface CustomRoutingEndpointDescription {
247
270
  */
248
271
  export interface AddCustomRoutingEndpointsResponse {
249
272
  /**
273
+ * @public
250
274
  * <p>The endpoint objects added to the custom routing accelerator.</p>
251
275
  */
252
276
  EndpointDescriptions?: CustomRoutingEndpointDescription[];
253
277
  /**
278
+ * @public
254
279
  * <p>The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.</p>
255
280
  */
256
281
  EndpointGroupArn?: string;
@@ -339,6 +364,7 @@ export declare class LimitExceededException extends __BaseException {
339
364
  */
340
365
  export interface EndpointConfiguration {
341
366
  /**
367
+ * @public
342
368
  * <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
343
369
  * Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
344
370
  * allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active
@@ -347,6 +373,7 @@ export interface EndpointConfiguration {
347
373
  */
348
374
  EndpointId?: string;
349
375
  /**
376
+ * @public
350
377
  * <p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic
351
378
  * based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The
352
379
  * result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second
@@ -355,6 +382,7 @@ export interface EndpointConfiguration {
355
382
  */
356
383
  Weight?: number;
357
384
  /**
385
+ * @public
358
386
  * <p>Indicates whether client IP address preservation is enabled for an endpoint.
359
387
  * The value is true or false. The default value is true for new accelerators. </p>
360
388
  * <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as
@@ -374,10 +402,12 @@ export interface EndpointConfiguration {
374
402
  */
375
403
  export interface AddEndpointsRequest {
376
404
  /**
405
+ * @public
377
406
  * <p>The list of endpoint objects.</p>
378
407
  */
379
408
  EndpointConfigurations: EndpointConfiguration[] | undefined;
380
409
  /**
410
+ * @public
381
411
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
382
412
  */
383
413
  EndpointGroupArn: string | undefined;
@@ -402,6 +432,7 @@ export type HealthState = (typeof HealthState)[keyof typeof HealthState];
402
432
  */
403
433
  export interface EndpointDescription {
404
434
  /**
435
+ * @public
405
436
  * <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
406
437
  * Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
407
438
  * allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p>
@@ -409,6 +440,7 @@ export interface EndpointDescription {
409
440
  */
410
441
  EndpointId?: string;
411
442
  /**
443
+ * @public
412
444
  * <p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic
413
445
  * based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The
414
446
  * result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second
@@ -417,14 +449,17 @@ export interface EndpointDescription {
417
449
  */
418
450
  Weight?: number;
419
451
  /**
452
+ * @public
420
453
  * <p>The health status of the endpoint.</p>
421
454
  */
422
455
  HealthState?: HealthState | string;
423
456
  /**
457
+ * @public
424
458
  * <p>Returns a null result.</p>
425
459
  */
426
460
  HealthReason?: string;
427
461
  /**
462
+ * @public
428
463
  * <p>Indicates whether client IP address preservation is enabled for an endpoint.
429
464
  * The value is true or false. The default value is true for new accelerators. </p>
430
465
  * <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as
@@ -443,10 +478,12 @@ export interface EndpointDescription {
443
478
  */
444
479
  export interface AddEndpointsResponse {
445
480
  /**
481
+ * @public
446
482
  * <p>The list of endpoint objects.</p>
447
483
  */
448
484
  EndpointDescriptions?: EndpointDescription[];
449
485
  /**
486
+ * @public
450
487
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
451
488
  */
452
489
  EndpointGroupArn?: string;
@@ -469,6 +506,7 @@ export declare class TransactionInProgressException extends __BaseException {
469
506
  */
470
507
  export interface AdvertiseByoipCidrRequest {
471
508
  /**
509
+ * @public
472
510
  * <p>The address range, in CIDR notation. This must be the exact range that you provisioned.
473
511
  * You can't advertise only a portion of the provisioned range.</p>
474
512
  */
@@ -482,11 +520,13 @@ export interface AdvertiseByoipCidrRequest {
482
520
  */
483
521
  export interface ByoipCidrEvent {
484
522
  /**
523
+ * @public
485
524
  * <p>A string that contains an <code>Event</code> message describing changes that you make in the status
486
525
  * of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).</p>
487
526
  */
488
527
  Message?: string;
489
528
  /**
529
+ * @public
490
530
  * <p>A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through
491
531
  * bring your own IP address (BYOIP).</p>
492
532
  */
@@ -588,14 +628,17 @@ export type ByoipCidrState = (typeof ByoipCidrState)[keyof typeof ByoipCidrState
588
628
  */
589
629
  export interface ByoipCidr {
590
630
  /**
631
+ * @public
591
632
  * <p>The address range, in CIDR notation.</p>
592
633
  */
593
634
  Cidr?: string;
594
635
  /**
636
+ * @public
595
637
  * <p>The state of the address pool.</p>
596
638
  */
597
639
  State?: ByoipCidrState | string;
598
640
  /**
641
+ * @public
599
642
  * <p>A history of status changes for an IP address range that you bring to Global Accelerator
600
643
  * through bring your own IP address (BYOIP).</p>
601
644
  */
@@ -606,6 +649,7 @@ export interface ByoipCidr {
606
649
  */
607
650
  export interface AdvertiseByoipCidrResponse {
608
651
  /**
652
+ * @public
609
653
  * <p>Information about the address range.</p>
610
654
  */
611
655
  ByoipCidr?: ByoipCidr;
@@ -642,14 +686,17 @@ export declare class IncorrectCidrStateException extends __BaseException {
642
686
  */
643
687
  export interface AllowCustomRoutingTrafficRequest {
644
688
  /**
689
+ * @public
645
690
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
646
691
  */
647
692
  EndpointGroupArn: string | undefined;
648
693
  /**
694
+ * @public
649
695
  * <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.</p>
650
696
  */
651
697
  EndpointId: string | undefined;
652
698
  /**
699
+ * @public
653
700
  * <p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive
654
701
  * traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.</p>
655
702
  * <p>
@@ -658,10 +705,12 @@ export interface AllowCustomRoutingTrafficRequest {
658
705
  */
659
706
  DestinationAddresses?: string[];
660
707
  /**
708
+ * @public
661
709
  * <p>A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.</p>
662
710
  */
663
711
  DestinationPorts?: number[];
664
712
  /**
713
+ * @public
665
714
  * <p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic
666
715
  * from a custom routing accelerator. The value is TRUE or FALSE. </p>
667
716
  * <p>When set to TRUE, <i>all</i> destinations in the custom routing VPC subnet can receive traffic. Note
@@ -710,10 +759,12 @@ export declare class AssociatedListenerFoundException extends __BaseException {
710
759
  */
711
760
  export interface CidrAuthorizationContext {
712
761
  /**
762
+ * @public
713
763
  * <p>The plain-text authorization message for the prefix and account.</p>
714
764
  */
715
765
  Message: string | undefined;
716
766
  /**
767
+ * @public
717
768
  * <p>The signed authorization message for the prefix and account.</p>
718
769
  */
719
770
  Signature: string | undefined;
@@ -736,10 +787,12 @@ export type ClientAffinity = (typeof ClientAffinity)[keyof typeof ClientAffinity
736
787
  */
737
788
  export interface Tag {
738
789
  /**
790
+ * @public
739
791
  * <p>A string that contains a <code>Tag</code> key.</p>
740
792
  */
741
793
  Key: string | undefined;
742
794
  /**
795
+ * @public
743
796
  * <p>A string that contains a <code>Tag</code> value.</p>
744
797
  */
745
798
  Value: string | undefined;
@@ -749,15 +802,18 @@ export interface Tag {
749
802
  */
750
803
  export interface CreateAcceleratorRequest {
751
804
  /**
805
+ * @public
752
806
  * <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
753
807
  * periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
754
808
  */
755
809
  Name: string | undefined;
756
810
  /**
811
+ * @public
757
812
  * <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
758
813
  */
759
814
  IpAddressType?: IpAddressType | string;
760
815
  /**
816
+ * @public
761
817
  * <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
762
818
  * from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
763
819
  * <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
@@ -773,16 +829,19 @@ export interface CreateAcceleratorRequest {
773
829
  */
774
830
  IpAddresses?: string[];
775
831
  /**
832
+ * @public
776
833
  * <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
777
834
  * <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
778
835
  */
779
836
  Enabled?: boolean;
780
837
  /**
838
+ * @public
781
839
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the
782
840
  * uniqueness—of an accelerator.</p>
783
841
  */
784
842
  IdempotencyToken?: string;
785
843
  /**
844
+ * @public
786
845
  * <p>Create tags for an accelerator.</p>
787
846
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
788
847
  * in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
@@ -794,6 +853,7 @@ export interface CreateAcceleratorRequest {
794
853
  */
795
854
  export interface CreateAcceleratorResponse {
796
855
  /**
856
+ * @public
797
857
  * <p>The accelerator that is created by specifying a listener and the supported IP address types.</p>
798
858
  */
799
859
  Accelerator?: Accelerator;
@@ -803,15 +863,18 @@ export interface CreateAcceleratorResponse {
803
863
  */
804
864
  export interface CreateCustomRoutingAcceleratorRequest {
805
865
  /**
866
+ * @public
806
867
  * <p>The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain
807
868
  * only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>
808
869
  */
809
870
  Name: string | undefined;
810
871
  /**
872
+ * @public
811
873
  * <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
812
874
  */
813
875
  IpAddressType?: IpAddressType | string;
814
876
  /**
877
+ * @public
815
878
  * <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
816
879
  * from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
817
880
  * <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
@@ -827,16 +890,19 @@ export interface CreateCustomRoutingAcceleratorRequest {
827
890
  */
828
891
  IpAddresses?: string[];
829
892
  /**
893
+ * @public
830
894
  * <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
831
895
  * <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
832
896
  */
833
897
  Enabled?: boolean;
834
898
  /**
899
+ * @public
835
900
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that
836
901
  * is, the uniqueness—of the request.</p>
837
902
  */
838
903
  IdempotencyToken?: string;
839
904
  /**
905
+ * @public
840
906
  * <p>Create tags for an accelerator.</p>
841
907
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
842
908
  * in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
@@ -861,28 +927,34 @@ export type CustomRoutingAcceleratorStatus = (typeof CustomRoutingAcceleratorSta
861
927
  */
862
928
  export interface CustomRoutingAccelerator {
863
929
  /**
930
+ * @public
864
931
  * <p>The Amazon Resource Name (ARN) of the custom routing accelerator.</p>
865
932
  */
866
933
  AcceleratorArn?: string;
867
934
  /**
935
+ * @public
868
936
  * <p>The name of the accelerator. The name must contain only alphanumeric characters or
869
937
  * hyphens (-), and must not begin or end with a hyphen.</p>
870
938
  */
871
939
  Name?: string;
872
940
  /**
941
+ * @public
873
942
  * <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
874
943
  */
875
944
  IpAddressType?: IpAddressType | string;
876
945
  /**
946
+ * @public
877
947
  * <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p>
878
948
  * <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
879
949
  */
880
950
  Enabled?: boolean;
881
951
  /**
952
+ * @public
882
953
  * <p>The static IP addresses that Global Accelerator associates with the accelerator.</p>
883
954
  */
884
955
  IpSets?: IpSet[];
885
956
  /**
957
+ * @public
886
958
  * <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. </p>
887
959
  * <p>The naming convention for the DNS name is the following: A lowercase letter a,
888
960
  * followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
@@ -895,14 +967,17 @@ export interface CustomRoutingAccelerator {
895
967
  */
896
968
  DnsName?: string;
897
969
  /**
970
+ * @public
898
971
  * <p>Describes the deployment status of the accelerator.</p>
899
972
  */
900
973
  Status?: CustomRoutingAcceleratorStatus | string;
901
974
  /**
975
+ * @public
902
976
  * <p>The date and time that the accelerator was created.</p>
903
977
  */
904
978
  CreatedTime?: Date;
905
979
  /**
980
+ * @public
906
981
  * <p>The date and time that the accelerator was last modified.</p>
907
982
  */
908
983
  LastModifiedTime?: Date;
@@ -912,6 +987,7 @@ export interface CustomRoutingAccelerator {
912
987
  */
913
988
  export interface CreateCustomRoutingAcceleratorResponse {
914
989
  /**
990
+ * @public
915
991
  * <p>The accelerator that is created.</p>
916
992
  */
917
993
  Accelerator?: CustomRoutingAccelerator;
@@ -935,14 +1011,17 @@ export type CustomRoutingProtocol = (typeof CustomRoutingProtocol)[keyof typeof
935
1011
  */
936
1012
  export interface CustomRoutingDestinationConfiguration {
937
1013
  /**
1014
+ * @public
938
1015
  * <p>The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.</p>
939
1016
  */
940
1017
  FromPort: number | undefined;
941
1018
  /**
1019
+ * @public
942
1020
  * <p>The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.</p>
943
1021
  */
944
1022
  ToPort: number | undefined;
945
1023
  /**
1024
+ * @public
946
1025
  * <p>The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.</p>
947
1026
  */
948
1027
  Protocols: (CustomRoutingProtocol | string)[] | undefined;
@@ -952,20 +1031,24 @@ export interface CustomRoutingDestinationConfiguration {
952
1031
  */
953
1032
  export interface CreateCustomRoutingEndpointGroupRequest {
954
1033
  /**
1034
+ * @public
955
1035
  * <p>The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.</p>
956
1036
  */
957
1037
  ListenerArn: string | undefined;
958
1038
  /**
1039
+ * @public
959
1040
  * <p>The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a
960
1041
  * specific Region.</p>
961
1042
  */
962
1043
  EndpointGroupRegion: string | undefined;
963
1044
  /**
1045
+ * @public
964
1046
  * <p>Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept
965
1047
  * client traffic on.</p>
966
1048
  */
967
1049
  DestinationConfigurations: CustomRoutingDestinationConfiguration[] | undefined;
968
1050
  /**
1051
+ * @public
969
1052
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the
970
1053
  * uniqueness—of the request.</p>
971
1054
  */
@@ -990,14 +1073,17 @@ export type Protocol = (typeof Protocol)[keyof typeof Protocol];
990
1073
  */
991
1074
  export interface CustomRoutingDestinationDescription {
992
1075
  /**
1076
+ * @public
993
1077
  * <p>The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.</p>
994
1078
  */
995
1079
  FromPort?: number;
996
1080
  /**
1081
+ * @public
997
1082
  * <p>The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.</p>
998
1083
  */
999
1084
  ToPort?: number;
1000
1085
  /**
1086
+ * @public
1001
1087
  * <p>The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.</p>
1002
1088
  */
1003
1089
  Protocols?: (Protocol | string)[];
@@ -1009,19 +1095,23 @@ export interface CustomRoutingDestinationDescription {
1009
1095
  */
1010
1096
  export interface CustomRoutingEndpointGroup {
1011
1097
  /**
1098
+ * @public
1012
1099
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
1013
1100
  */
1014
1101
  EndpointGroupArn?: string;
1015
1102
  /**
1103
+ * @public
1016
1104
  * <p>The Amazon Web Services Region where the endpoint group is located.</p>
1017
1105
  */
1018
1106
  EndpointGroupRegion?: string;
1019
1107
  /**
1108
+ * @public
1020
1109
  * <p>For a custom routing accelerator, describes the port range and protocol for all endpoints
1021
1110
  * (virtual private cloud subnets) in an endpoint group to accept client traffic on.</p>
1022
1111
  */
1023
1112
  DestinationDescriptions?: CustomRoutingDestinationDescription[];
1024
1113
  /**
1114
+ * @public
1025
1115
  * <p>For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an
1026
1116
  * endpoint group to accept client traffic on.</p>
1027
1117
  */
@@ -1032,6 +1122,7 @@ export interface CustomRoutingEndpointGroup {
1032
1122
  */
1033
1123
  export interface CreateCustomRoutingEndpointGroupResponse {
1034
1124
  /**
1125
+ * @public
1035
1126
  * <p>The information about the endpoint group created for a custom routing accelerator.</p>
1036
1127
  */
1037
1128
  EndpointGroup?: CustomRoutingEndpointGroup;
@@ -1081,10 +1172,12 @@ export declare class ListenerNotFoundException extends __BaseException {
1081
1172
  */
1082
1173
  export interface PortRange {
1083
1174
  /**
1175
+ * @public
1084
1176
  * <p>The first port in the range of ports, inclusive.</p>
1085
1177
  */
1086
1178
  FromPort?: number;
1087
1179
  /**
1180
+ * @public
1088
1181
  * <p>The last port in the range of ports, inclusive.</p>
1089
1182
  */
1090
1183
  ToPort?: number;
@@ -1094,16 +1187,19 @@ export interface PortRange {
1094
1187
  */
1095
1188
  export interface CreateCustomRoutingListenerRequest {
1096
1189
  /**
1190
+ * @public
1097
1191
  * <p>The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.</p>
1098
1192
  */
1099
1193
  AcceleratorArn: string | undefined;
1100
1194
  /**
1195
+ * @public
1101
1196
  * <p>The port range to support for connections from clients to your accelerator.</p>
1102
1197
  * <p>Separately, you set port ranges for endpoints. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html">About
1103
1198
  * endpoints for custom routing accelerators</a>.</p>
1104
1199
  */
1105
1200
  PortRanges: PortRange[] | undefined;
1106
1201
  /**
1202
+ * @public
1107
1203
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the
1108
1204
  * uniqueness—of the request.</p>
1109
1205
  */
@@ -1115,10 +1211,12 @@ export interface CreateCustomRoutingListenerRequest {
1115
1211
  */
1116
1212
  export interface CustomRoutingListener {
1117
1213
  /**
1214
+ * @public
1118
1215
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
1119
1216
  */
1120
1217
  ListenerArn?: string;
1121
1218
  /**
1219
+ * @public
1122
1220
  * <p>The port range to support for connections from clients to your accelerator.</p>
1123
1221
  * <p>Separately, you set port ranges for endpoints. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html">About
1124
1222
  * endpoints for custom routing accelerators</a>.</p>
@@ -1130,6 +1228,7 @@ export interface CustomRoutingListener {
1130
1228
  */
1131
1229
  export interface CreateCustomRoutingListenerResponse {
1132
1230
  /**
1231
+ * @public
1133
1232
  * <p>The listener that you've created for a custom routing accelerator.</p>
1134
1233
  */
1135
1234
  Listener?: CustomRoutingListener;
@@ -1158,11 +1257,13 @@ export type HealthCheckProtocol = (typeof HealthCheckProtocol)[keyof typeof Heal
1158
1257
  */
1159
1258
  export interface PortOverride {
1160
1259
  /**
1260
+ * @public
1161
1261
  * <p>The listener port that you want to map to a specific endpoint port. This is the port that user traffic
1162
1262
  * arrives to the Global Accelerator on.</p>
1163
1263
  */
1164
1264
  ListenerPort?: number;
1165
1265
  /**
1266
+ * @public
1166
1267
  * <p>The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint,
1167
1268
  * such as the Application Load Balancer or Amazon EC2 instance.</p>
1168
1269
  */
@@ -1173,19 +1274,23 @@ export interface PortOverride {
1173
1274
  */
1174
1275
  export interface CreateEndpointGroupRequest {
1175
1276
  /**
1277
+ * @public
1176
1278
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
1177
1279
  */
1178
1280
  ListenerArn: string | undefined;
1179
1281
  /**
1282
+ * @public
1180
1283
  * <p>The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a
1181
1284
  * specific Region.</p>
1182
1285
  */
1183
1286
  EndpointGroupRegion: string | undefined;
1184
1287
  /**
1288
+ * @public
1185
1289
  * <p>The list of endpoint objects.</p>
1186
1290
  */
1187
1291
  EndpointConfigurations?: EndpointConfiguration[];
1188
1292
  /**
1293
+ * @public
1189
1294
  * <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
1190
1295
  * this listener. </p>
1191
1296
  * <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
@@ -1194,36 +1299,43 @@ export interface CreateEndpointGroupRequest {
1194
1299
  */
1195
1300
  TrafficDialPercentage?: number;
1196
1301
  /**
1302
+ * @public
1197
1303
  * <p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port
1198
1304
  * is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the
1199
1305
  * first port in the list.</p>
1200
1306
  */
1201
1307
  HealthCheckPort?: number;
1202
1308
  /**
1309
+ * @public
1203
1310
  * <p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default
1204
1311
  * value is TCP.</p>
1205
1312
  */
1206
1313
  HealthCheckProtocol?: HealthCheckProtocol | string;
1207
1314
  /**
1315
+ * @public
1208
1316
  * <p>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The
1209
1317
  * default value is slash (/).</p>
1210
1318
  */
1211
1319
  HealthCheckPath?: string;
1212
1320
  /**
1321
+ * @public
1213
1322
  * <p>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</p>
1214
1323
  */
1215
1324
  HealthCheckIntervalSeconds?: number;
1216
1325
  /**
1326
+ * @public
1217
1327
  * <p>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an
1218
1328
  * unhealthy endpoint to healthy. The default value is 3.</p>
1219
1329
  */
1220
1330
  ThresholdCount?: number;
1221
1331
  /**
1332
+ * @public
1222
1333
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the
1223
1334
  * uniqueness—of the request.</p>
1224
1335
  */
1225
1336
  IdempotencyToken?: string;
1226
1337
  /**
1338
+ * @public
1227
1339
  * <p>Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.
1228
1340
  * For example, you can create a port override in which the listener
1229
1341
  * receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
@@ -1240,18 +1352,22 @@ export interface CreateEndpointGroupRequest {
1240
1352
  */
1241
1353
  export interface EndpointGroup {
1242
1354
  /**
1355
+ * @public
1243
1356
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
1244
1357
  */
1245
1358
  EndpointGroupArn?: string;
1246
1359
  /**
1360
+ * @public
1247
1361
  * <p>The Amazon Web Services Region where the endpoint group is located.</p>
1248
1362
  */
1249
1363
  EndpointGroupRegion?: string;
1250
1364
  /**
1365
+ * @public
1251
1366
  * <p>The list of endpoint objects.</p>
1252
1367
  */
1253
1368
  EndpointDescriptions?: EndpointDescription[];
1254
1369
  /**
1370
+ * @public
1255
1371
  * <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
1256
1372
  * this listener. </p>
1257
1373
  * <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
@@ -1260,6 +1376,7 @@ export interface EndpointGroup {
1260
1376
  */
1261
1377
  TrafficDialPercentage?: number;
1262
1378
  /**
1379
+ * @public
1263
1380
  * <p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p>
1264
1381
  *
1265
1382
  * <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a
@@ -1267,25 +1384,30 @@ export interface EndpointGroup {
1267
1384
  */
1268
1385
  HealthCheckPort?: number;
1269
1386
  /**
1387
+ * @public
1270
1388
  * <p>The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default
1271
1389
  * value is TCP.</p>
1272
1390
  */
1273
1391
  HealthCheckProtocol?: HealthCheckProtocol | string;
1274
1392
  /**
1393
+ * @public
1275
1394
  * <p>If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the
1276
1395
  * endpoints for health checks. The default is slash (/).</p>
1277
1396
  */
1278
1397
  HealthCheckPath?: string;
1279
1398
  /**
1399
+ * @public
1280
1400
  * <p>The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.</p>
1281
1401
  */
1282
1402
  HealthCheckIntervalSeconds?: number;
1283
1403
  /**
1404
+ * @public
1284
1405
  * <p>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an
1285
1406
  * unhealthy endpoint to healthy. The default value is 3.</p>
1286
1407
  */
1287
1408
  ThresholdCount?: number;
1288
1409
  /**
1410
+ * @public
1289
1411
  * <p>Allows you to override the destination ports used to route traffic to an endpoint.
1290
1412
  * Using a port override lets you map a list of external destination ports (that your
1291
1413
  * users send traffic to) to a list of internal destination ports that you want an application
@@ -1298,6 +1420,7 @@ export interface EndpointGroup {
1298
1420
  */
1299
1421
  export interface CreateEndpointGroupResponse {
1300
1422
  /**
1423
+ * @public
1301
1424
  * <p>The information about the endpoint group that was created.</p>
1302
1425
  */
1303
1426
  EndpointGroup?: EndpointGroup;
@@ -1307,18 +1430,22 @@ export interface CreateEndpointGroupResponse {
1307
1430
  */
1308
1431
  export interface CreateListenerRequest {
1309
1432
  /**
1433
+ * @public
1310
1434
  * <p>The Amazon Resource Name (ARN) of your accelerator.</p>
1311
1435
  */
1312
1436
  AcceleratorArn: string | undefined;
1313
1437
  /**
1438
+ * @public
1314
1439
  * <p>The list of port ranges to support for connections from clients to your accelerator.</p>
1315
1440
  */
1316
1441
  PortRanges: PortRange[] | undefined;
1317
1442
  /**
1443
+ * @public
1318
1444
  * <p>The protocol for connections from clients to your accelerator.</p>
1319
1445
  */
1320
1446
  Protocol: Protocol | string | undefined;
1321
1447
  /**
1448
+ * @public
1322
1449
  * <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
1323
1450
  * regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
1324
1451
  * route each client to the same specific endpoint.</p>
@@ -1334,6 +1461,7 @@ export interface CreateListenerRequest {
1334
1461
  */
1335
1462
  ClientAffinity?: ClientAffinity | string;
1336
1463
  /**
1464
+ * @public
1337
1465
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the
1338
1466
  * uniqueness—of the request.</p>
1339
1467
  */
@@ -1345,18 +1473,22 @@ export interface CreateListenerRequest {
1345
1473
  */
1346
1474
  export interface Listener {
1347
1475
  /**
1476
+ * @public
1348
1477
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
1349
1478
  */
1350
1479
  ListenerArn?: string;
1351
1480
  /**
1481
+ * @public
1352
1482
  * <p>The list of port ranges for the connections from clients to the accelerator.</p>
1353
1483
  */
1354
1484
  PortRanges?: PortRange[];
1355
1485
  /**
1486
+ * @public
1356
1487
  * <p>The protocol for the connections from clients to the accelerator.</p>
1357
1488
  */
1358
1489
  Protocol?: Protocol | string;
1359
1490
  /**
1491
+ * @public
1360
1492
  * <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
1361
1493
  * regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
1362
1494
  * route each client to the same specific endpoint.</p>
@@ -1377,6 +1509,7 @@ export interface Listener {
1377
1509
  */
1378
1510
  export interface CreateListenerResponse {
1379
1511
  /**
1512
+ * @public
1380
1513
  * <p>The listener that you've created.</p>
1381
1514
  */
1382
1515
  Listener?: Listener;
@@ -1387,6 +1520,7 @@ export interface CreateListenerResponse {
1387
1520
  */
1388
1521
  export interface CustomRoutingAcceleratorAttributes {
1389
1522
  /**
1523
+ * @public
1390
1524
  * <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
1391
1525
  * <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
1392
1526
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow logs</a> in
@@ -1394,12 +1528,14 @@ export interface CustomRoutingAcceleratorAttributes {
1394
1528
  */
1395
1529
  FlowLogsEnabled?: boolean;
1396
1530
  /**
1531
+ * @public
1397
1532
  * <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
1398
1533
  * <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
1399
1534
  * bucket.</p>
1400
1535
  */
1401
1536
  FlowLogsS3Bucket?: string;
1402
1537
  /**
1538
+ * @public
1403
1539
  * <p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
1404
1540
  * <code>FlowLogsEnabled</code> is <code>true</code>.</p>
1405
1541
  * <p>If you don’t specify a prefix, the flow logs are stored in the
@@ -1425,6 +1561,7 @@ export type CustomRoutingDestinationTrafficState = (typeof CustomRoutingDestinat
1425
1561
  */
1426
1562
  export interface DeleteAcceleratorRequest {
1427
1563
  /**
1564
+ * @public
1428
1565
  * <p>The Amazon Resource Name (ARN) of an accelerator.</p>
1429
1566
  */
1430
1567
  AcceleratorArn: string | undefined;
@@ -1434,6 +1571,7 @@ export interface DeleteAcceleratorRequest {
1434
1571
  */
1435
1572
  export interface DeleteCustomRoutingAcceleratorRequest {
1436
1573
  /**
1574
+ * @public
1437
1575
  * <p>The Amazon Resource Name (ARN) of the custom routing accelerator to delete.</p>
1438
1576
  */
1439
1577
  AcceleratorArn: string | undefined;
@@ -1443,6 +1581,7 @@ export interface DeleteCustomRoutingAcceleratorRequest {
1443
1581
  */
1444
1582
  export interface DeleteCustomRoutingEndpointGroupRequest {
1445
1583
  /**
1584
+ * @public
1446
1585
  * <p>The Amazon Resource Name (ARN) of the endpoint group to delete.</p>
1447
1586
  */
1448
1587
  EndpointGroupArn: string | undefined;
@@ -1452,6 +1591,7 @@ export interface DeleteCustomRoutingEndpointGroupRequest {
1452
1591
  */
1453
1592
  export interface DeleteCustomRoutingListenerRequest {
1454
1593
  /**
1594
+ * @public
1455
1595
  * <p>The Amazon Resource Name (ARN) of the listener to delete.</p>
1456
1596
  */
1457
1597
  ListenerArn: string | undefined;
@@ -1461,6 +1601,7 @@ export interface DeleteCustomRoutingListenerRequest {
1461
1601
  */
1462
1602
  export interface DeleteEndpointGroupRequest {
1463
1603
  /**
1604
+ * @public
1464
1605
  * <p>The Amazon Resource Name (ARN) of the endpoint group to delete.</p>
1465
1606
  */
1466
1607
  EndpointGroupArn: string | undefined;
@@ -1470,6 +1611,7 @@ export interface DeleteEndpointGroupRequest {
1470
1611
  */
1471
1612
  export interface DeleteListenerRequest {
1472
1613
  /**
1614
+ * @public
1473
1615
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
1474
1616
  */
1475
1617
  ListenerArn: string | undefined;
@@ -1479,25 +1621,30 @@ export interface DeleteListenerRequest {
1479
1621
  */
1480
1622
  export interface DenyCustomRoutingTrafficRequest {
1481
1623
  /**
1624
+ * @public
1482
1625
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
1483
1626
  */
1484
1627
  EndpointGroupArn: string | undefined;
1485
1628
  /**
1629
+ * @public
1486
1630
  * <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.</p>
1487
1631
  */
1488
1632
  EndpointId: string | undefined;
1489
1633
  /**
1634
+ * @public
1490
1635
  * <p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving
1491
1636
  * traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the
1492
1637
  * endpoint group.</p>
1493
1638
  */
1494
1639
  DestinationAddresses?: string[];
1495
1640
  /**
1641
+ * @public
1496
1642
  * <p>A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from
1497
1643
  * receiving traffic.</p>
1498
1644
  */
1499
1645
  DestinationPorts?: number[];
1500
1646
  /**
1647
+ * @public
1501
1648
  * <p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint <i>cannot</i>
1502
1649
  * receive traffic from a custom routing accelerator. The value is TRUE or FALSE. </p>
1503
1650
  * <p>When set to TRUE, <i>no</i> destinations in the custom routing VPC subnet can receive traffic. Note
@@ -1514,6 +1661,7 @@ export interface DenyCustomRoutingTrafficRequest {
1514
1661
  */
1515
1662
  export interface DeprovisionByoipCidrRequest {
1516
1663
  /**
1664
+ * @public
1517
1665
  * <p>The address range, in CIDR notation. The prefix must be the same prefix that you specified
1518
1666
  * when you provisioned the address range.</p>
1519
1667
  */
@@ -1524,6 +1672,7 @@ export interface DeprovisionByoipCidrRequest {
1524
1672
  */
1525
1673
  export interface DeprovisionByoipCidrResponse {
1526
1674
  /**
1675
+ * @public
1527
1676
  * <p>Information about the address range.</p>
1528
1677
  */
1529
1678
  ByoipCidr?: ByoipCidr;
@@ -1533,6 +1682,7 @@ export interface DeprovisionByoipCidrResponse {
1533
1682
  */
1534
1683
  export interface DescribeAcceleratorRequest {
1535
1684
  /**
1685
+ * @public
1536
1686
  * <p>The Amazon Resource Name (ARN) of the accelerator to describe.</p>
1537
1687
  */
1538
1688
  AcceleratorArn: string | undefined;
@@ -1542,6 +1692,7 @@ export interface DescribeAcceleratorRequest {
1542
1692
  */
1543
1693
  export interface DescribeAcceleratorResponse {
1544
1694
  /**
1695
+ * @public
1545
1696
  * <p>The description of the accelerator.</p>
1546
1697
  */
1547
1698
  Accelerator?: Accelerator;
@@ -1551,6 +1702,7 @@ export interface DescribeAcceleratorResponse {
1551
1702
  */
1552
1703
  export interface DescribeAcceleratorAttributesRequest {
1553
1704
  /**
1705
+ * @public
1554
1706
  * <p>The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.</p>
1555
1707
  */
1556
1708
  AcceleratorArn: string | undefined;
@@ -1560,6 +1712,7 @@ export interface DescribeAcceleratorAttributesRequest {
1560
1712
  */
1561
1713
  export interface DescribeAcceleratorAttributesResponse {
1562
1714
  /**
1715
+ * @public
1563
1716
  * <p>The attributes of the accelerator.</p>
1564
1717
  */
1565
1718
  AcceleratorAttributes?: AcceleratorAttributes;
@@ -1569,6 +1722,7 @@ export interface DescribeAcceleratorAttributesResponse {
1569
1722
  */
1570
1723
  export interface DescribeCustomRoutingAcceleratorRequest {
1571
1724
  /**
1725
+ * @public
1572
1726
  * <p>The Amazon Resource Name (ARN) of the accelerator to describe.</p>
1573
1727
  */
1574
1728
  AcceleratorArn: string | undefined;
@@ -1578,6 +1732,7 @@ export interface DescribeCustomRoutingAcceleratorRequest {
1578
1732
  */
1579
1733
  export interface DescribeCustomRoutingAcceleratorResponse {
1580
1734
  /**
1735
+ * @public
1581
1736
  * <p>The description of the custom routing accelerator.</p>
1582
1737
  */
1583
1738
  Accelerator?: CustomRoutingAccelerator;
@@ -1587,6 +1742,7 @@ export interface DescribeCustomRoutingAcceleratorResponse {
1587
1742
  */
1588
1743
  export interface DescribeCustomRoutingAcceleratorAttributesRequest {
1589
1744
  /**
1745
+ * @public
1590
1746
  * <p>The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.</p>
1591
1747
  */
1592
1748
  AcceleratorArn: string | undefined;
@@ -1596,6 +1752,7 @@ export interface DescribeCustomRoutingAcceleratorAttributesRequest {
1596
1752
  */
1597
1753
  export interface DescribeCustomRoutingAcceleratorAttributesResponse {
1598
1754
  /**
1755
+ * @public
1599
1756
  * <p>The attributes of the custom routing accelerator.</p>
1600
1757
  */
1601
1758
  AcceleratorAttributes?: CustomRoutingAcceleratorAttributes;
@@ -1605,6 +1762,7 @@ export interface DescribeCustomRoutingAcceleratorAttributesResponse {
1605
1762
  */
1606
1763
  export interface DescribeCustomRoutingEndpointGroupRequest {
1607
1764
  /**
1765
+ * @public
1608
1766
  * <p>The Amazon Resource Name (ARN) of the endpoint group to describe.</p>
1609
1767
  */
1610
1768
  EndpointGroupArn: string | undefined;
@@ -1614,6 +1772,7 @@ export interface DescribeCustomRoutingEndpointGroupRequest {
1614
1772
  */
1615
1773
  export interface DescribeCustomRoutingEndpointGroupResponse {
1616
1774
  /**
1775
+ * @public
1617
1776
  * <p>The description of an endpoint group for a custom routing accelerator.</p>
1618
1777
  */
1619
1778
  EndpointGroup?: CustomRoutingEndpointGroup;
@@ -1623,6 +1782,7 @@ export interface DescribeCustomRoutingEndpointGroupResponse {
1623
1782
  */
1624
1783
  export interface DescribeCustomRoutingListenerRequest {
1625
1784
  /**
1785
+ * @public
1626
1786
  * <p>The Amazon Resource Name (ARN) of the listener to describe.</p>
1627
1787
  */
1628
1788
  ListenerArn: string | undefined;
@@ -1632,6 +1792,7 @@ export interface DescribeCustomRoutingListenerRequest {
1632
1792
  */
1633
1793
  export interface DescribeCustomRoutingListenerResponse {
1634
1794
  /**
1795
+ * @public
1635
1796
  * <p>The description of a listener for a custom routing accelerator.</p>
1636
1797
  */
1637
1798
  Listener?: CustomRoutingListener;
@@ -1641,6 +1802,7 @@ export interface DescribeCustomRoutingListenerResponse {
1641
1802
  */
1642
1803
  export interface DescribeEndpointGroupRequest {
1643
1804
  /**
1805
+ * @public
1644
1806
  * <p>The Amazon Resource Name (ARN) of the endpoint group to describe.</p>
1645
1807
  */
1646
1808
  EndpointGroupArn: string | undefined;
@@ -1650,6 +1812,7 @@ export interface DescribeEndpointGroupRequest {
1650
1812
  */
1651
1813
  export interface DescribeEndpointGroupResponse {
1652
1814
  /**
1815
+ * @public
1653
1816
  * <p>The description of an endpoint group.</p>
1654
1817
  */
1655
1818
  EndpointGroup?: EndpointGroup;
@@ -1659,6 +1822,7 @@ export interface DescribeEndpointGroupResponse {
1659
1822
  */
1660
1823
  export interface DescribeListenerRequest {
1661
1824
  /**
1825
+ * @public
1662
1826
  * <p>The Amazon Resource Name (ARN) of the listener to describe.</p>
1663
1827
  */
1664
1828
  ListenerArn: string | undefined;
@@ -1668,6 +1832,7 @@ export interface DescribeListenerRequest {
1668
1832
  */
1669
1833
  export interface DescribeListenerResponse {
1670
1834
  /**
1835
+ * @public
1671
1836
  * <p>The description of a listener.</p>
1672
1837
  */
1673
1838
  Listener?: Listener;
@@ -1678,10 +1843,12 @@ export interface DescribeListenerResponse {
1678
1843
  */
1679
1844
  export interface SocketAddress {
1680
1845
  /**
1846
+ * @public
1681
1847
  * <p>The IP address for the socket address.</p>
1682
1848
  */
1683
1849
  IpAddress?: string;
1684
1850
  /**
1851
+ * @public
1685
1852
  * <p>The port for the socket address.</p>
1686
1853
  */
1687
1854
  Port?: number;
@@ -1692,36 +1859,44 @@ export interface SocketAddress {
1692
1859
  */
1693
1860
  export interface DestinationPortMapping {
1694
1861
  /**
1862
+ * @public
1695
1863
  * <p>The Amazon Resource Name (ARN) of the custom routing accelerator
1696
1864
  * that you have port mappings for.</p>
1697
1865
  */
1698
1866
  AcceleratorArn?: string;
1699
1867
  /**
1868
+ * @public
1700
1869
  * <p>The IP address/port combinations (sockets) that map to a given destination socket
1701
1870
  * address.</p>
1702
1871
  */
1703
1872
  AcceleratorSocketAddresses?: SocketAddress[];
1704
1873
  /**
1874
+ * @public
1705
1875
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
1706
1876
  */
1707
1877
  EndpointGroupArn?: string;
1708
1878
  /**
1879
+ * @public
1709
1880
  * <p>The ID for the virtual private cloud (VPC) subnet.</p>
1710
1881
  */
1711
1882
  EndpointId?: string;
1712
1883
  /**
1884
+ * @public
1713
1885
  * <p>The Amazon Web Services Region for the endpoint group.</p>
1714
1886
  */
1715
1887
  EndpointGroupRegion?: string;
1716
1888
  /**
1889
+ * @public
1717
1890
  * <p>The endpoint IP address/port combination for traffic received on the accelerator socket address.</p>
1718
1891
  */
1719
1892
  DestinationSocketAddress?: SocketAddress;
1720
1893
  /**
1894
+ * @public
1721
1895
  * <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
1722
1896
  */
1723
1897
  IpAddressType?: IpAddressType | string;
1724
1898
  /**
1899
+ * @public
1725
1900
  * <p>Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if
1726
1901
  * traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.</p>
1727
1902
  */
@@ -1733,6 +1908,7 @@ export interface DestinationPortMapping {
1733
1908
  */
1734
1909
  export interface EndpointIdentifier {
1735
1910
  /**
1911
+ * @public
1736
1912
  * <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
1737
1913
  * Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
1738
1914
  * allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p>
@@ -1740,6 +1916,7 @@ export interface EndpointIdentifier {
1740
1916
  */
1741
1917
  EndpointId: string | undefined;
1742
1918
  /**
1919
+ * @public
1743
1920
  * <p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. </p>
1744
1921
  * <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as
1745
1922
  * traffic travels to applications on the endpoint fronted by the accelerator.</p>
@@ -1777,10 +1954,12 @@ export declare class InvalidNextTokenException extends __BaseException {
1777
1954
  */
1778
1955
  export interface ListAcceleratorsRequest {
1779
1956
  /**
1957
+ * @public
1780
1958
  * <p>The number of Global Accelerator objects that you want to return with this call. The default value is 10.</p>
1781
1959
  */
1782
1960
  MaxResults?: number;
1783
1961
  /**
1962
+ * @public
1784
1963
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1785
1964
  */
1786
1965
  NextToken?: string;
@@ -1790,10 +1969,12 @@ export interface ListAcceleratorsRequest {
1790
1969
  */
1791
1970
  export interface ListAcceleratorsResponse {
1792
1971
  /**
1972
+ * @public
1793
1973
  * <p>The list of accelerators for a customer account.</p>
1794
1974
  */
1795
1975
  Accelerators?: Accelerator[];
1796
1976
  /**
1977
+ * @public
1797
1978
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1798
1979
  */
1799
1980
  NextToken?: string;
@@ -1803,11 +1984,13 @@ export interface ListAcceleratorsResponse {
1803
1984
  */
1804
1985
  export interface ListByoipCidrsRequest {
1805
1986
  /**
1987
+ * @public
1806
1988
  * <p>The maximum number of results to return with a single call. To retrieve the remaining results, make
1807
1989
  * another call with the returned <code>nextToken</code> value.</p>
1808
1990
  */
1809
1991
  MaxResults?: number;
1810
1992
  /**
1993
+ * @public
1811
1994
  * <p>The token for the next page of results.</p>
1812
1995
  */
1813
1996
  NextToken?: string;
@@ -1817,10 +2000,12 @@ export interface ListByoipCidrsRequest {
1817
2000
  */
1818
2001
  export interface ListByoipCidrsResponse {
1819
2002
  /**
2003
+ * @public
1820
2004
  * <p>Information about your address ranges.</p>
1821
2005
  */
1822
2006
  ByoipCidrs?: ByoipCidr[];
1823
2007
  /**
2008
+ * @public
1824
2009
  * <p>The token for the next page of results.</p>
1825
2010
  */
1826
2011
  NextToken?: string;
@@ -1830,10 +2015,12 @@ export interface ListByoipCidrsResponse {
1830
2015
  */
1831
2016
  export interface ListCustomRoutingAcceleratorsRequest {
1832
2017
  /**
2018
+ * @public
1833
2019
  * <p>The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.</p>
1834
2020
  */
1835
2021
  MaxResults?: number;
1836
2022
  /**
2023
+ * @public
1837
2024
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1838
2025
  */
1839
2026
  NextToken?: string;
@@ -1843,10 +2030,12 @@ export interface ListCustomRoutingAcceleratorsRequest {
1843
2030
  */
1844
2031
  export interface ListCustomRoutingAcceleratorsResponse {
1845
2032
  /**
2033
+ * @public
1846
2034
  * <p>The list of custom routing accelerators for a customer account.</p>
1847
2035
  */
1848
2036
  Accelerators?: CustomRoutingAccelerator[];
1849
2037
  /**
2038
+ * @public
1850
2039
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1851
2040
  */
1852
2041
  NextToken?: string;
@@ -1856,14 +2045,17 @@ export interface ListCustomRoutingAcceleratorsResponse {
1856
2045
  */
1857
2046
  export interface ListCustomRoutingEndpointGroupsRequest {
1858
2047
  /**
2048
+ * @public
1859
2049
  * <p>The Amazon Resource Name (ARN) of the listener to list endpoint groups for.</p>
1860
2050
  */
1861
2051
  ListenerArn: string | undefined;
1862
2052
  /**
2053
+ * @public
1863
2054
  * <p>The number of endpoint group objects that you want to return with this call. The default value is 10.</p>
1864
2055
  */
1865
2056
  MaxResults?: number;
1866
2057
  /**
2058
+ * @public
1867
2059
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1868
2060
  */
1869
2061
  NextToken?: string;
@@ -1873,10 +2065,12 @@ export interface ListCustomRoutingEndpointGroupsRequest {
1873
2065
  */
1874
2066
  export interface ListCustomRoutingEndpointGroupsResponse {
1875
2067
  /**
2068
+ * @public
1876
2069
  * <p>The list of the endpoint groups associated with a listener for a custom routing accelerator.</p>
1877
2070
  */
1878
2071
  EndpointGroups?: CustomRoutingEndpointGroup[];
1879
2072
  /**
2073
+ * @public
1880
2074
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1881
2075
  */
1882
2076
  NextToken?: string;
@@ -1886,14 +2080,17 @@ export interface ListCustomRoutingEndpointGroupsResponse {
1886
2080
  */
1887
2081
  export interface ListCustomRoutingListenersRequest {
1888
2082
  /**
2083
+ * @public
1889
2084
  * <p>The Amazon Resource Name (ARN) of the accelerator to list listeners for.</p>
1890
2085
  */
1891
2086
  AcceleratorArn: string | undefined;
1892
2087
  /**
2088
+ * @public
1893
2089
  * <p>The number of listener objects that you want to return with this call. The default value is 10.</p>
1894
2090
  */
1895
2091
  MaxResults?: number;
1896
2092
  /**
2093
+ * @public
1897
2094
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1898
2095
  */
1899
2096
  NextToken?: string;
@@ -1903,10 +2100,12 @@ export interface ListCustomRoutingListenersRequest {
1903
2100
  */
1904
2101
  export interface ListCustomRoutingListenersResponse {
1905
2102
  /**
2103
+ * @public
1906
2104
  * <p>The list of listeners for a custom routing accelerator.</p>
1907
2105
  */
1908
2106
  Listeners?: CustomRoutingListener[];
1909
2107
  /**
2108
+ * @public
1910
2109
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1911
2110
  */
1912
2111
  NextToken?: string;
@@ -1916,18 +2115,22 @@ export interface ListCustomRoutingListenersResponse {
1916
2115
  */
1917
2116
  export interface ListCustomRoutingPortMappingsRequest {
1918
2117
  /**
2118
+ * @public
1919
2119
  * <p>The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.</p>
1920
2120
  */
1921
2121
  AcceleratorArn: string | undefined;
1922
2122
  /**
2123
+ * @public
1923
2124
  * <p>The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.</p>
1924
2125
  */
1925
2126
  EndpointGroupArn?: string;
1926
2127
  /**
2128
+ * @public
1927
2129
  * <p>The number of destination port mappings that you want to return with this call. The default value is 10.</p>
1928
2130
  */
1929
2131
  MaxResults?: number;
1930
2132
  /**
2133
+ * @public
1931
2134
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1932
2135
  */
1933
2136
  NextToken?: string;
@@ -1941,26 +2144,32 @@ export interface ListCustomRoutingPortMappingsRequest {
1941
2144
  */
1942
2145
  export interface PortMapping {
1943
2146
  /**
2147
+ * @public
1944
2148
  * <p>The accelerator port.</p>
1945
2149
  */
1946
2150
  AcceleratorPort?: number;
1947
2151
  /**
2152
+ * @public
1948
2153
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
1949
2154
  */
1950
2155
  EndpointGroupArn?: string;
1951
2156
  /**
2157
+ * @public
1952
2158
  * <p>The IP address of the VPC subnet (the subnet ID).</p>
1953
2159
  */
1954
2160
  EndpointId?: string;
1955
2161
  /**
2162
+ * @public
1956
2163
  * <p>The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.</p>
1957
2164
  */
1958
2165
  DestinationSocketAddress?: SocketAddress;
1959
2166
  /**
2167
+ * @public
1960
2168
  * <p>The protocols supported by the endpoint group.</p>
1961
2169
  */
1962
2170
  Protocols?: (CustomRoutingProtocol | string)[];
1963
2171
  /**
2172
+ * @public
1964
2173
  * <p>Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if
1965
2174
  * traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.</p>
1966
2175
  */
@@ -1971,10 +2180,12 @@ export interface PortMapping {
1971
2180
  */
1972
2181
  export interface ListCustomRoutingPortMappingsResponse {
1973
2182
  /**
2183
+ * @public
1974
2184
  * <p>The port mappings for a custom routing accelerator.</p>
1975
2185
  */
1976
2186
  PortMappings?: PortMapping[];
1977
2187
  /**
2188
+ * @public
1978
2189
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
1979
2190
  */
1980
2191
  NextToken?: string;
@@ -1984,19 +2195,23 @@ export interface ListCustomRoutingPortMappingsResponse {
1984
2195
  */
1985
2196
  export interface ListCustomRoutingPortMappingsByDestinationRequest {
1986
2197
  /**
2198
+ * @public
1987
2199
  * <p>The ID for the virtual private cloud (VPC) subnet.</p>
1988
2200
  */
1989
2201
  EndpointId: string | undefined;
1990
2202
  /**
2203
+ * @public
1991
2204
  * <p>The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port
1992
2205
  * mappings.</p>
1993
2206
  */
1994
2207
  DestinationAddress: string | undefined;
1995
2208
  /**
2209
+ * @public
1996
2210
  * <p>The number of destination port mappings that you want to return with this call. The default value is 10.</p>
1997
2211
  */
1998
2212
  MaxResults?: number;
1999
2213
  /**
2214
+ * @public
2000
2215
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
2001
2216
  */
2002
2217
  NextToken?: string;
@@ -2006,10 +2221,12 @@ export interface ListCustomRoutingPortMappingsByDestinationRequest {
2006
2221
  */
2007
2222
  export interface ListCustomRoutingPortMappingsByDestinationResponse {
2008
2223
  /**
2224
+ * @public
2009
2225
  * <p>The port mappings for the endpoint IP address that you specified in the request.</p>
2010
2226
  */
2011
2227
  DestinationPortMappings?: DestinationPortMapping[];
2012
2228
  /**
2229
+ * @public
2013
2230
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
2014
2231
  */
2015
2232
  NextToken?: string;
@@ -2019,14 +2236,17 @@ export interface ListCustomRoutingPortMappingsByDestinationResponse {
2019
2236
  */
2020
2237
  export interface ListEndpointGroupsRequest {
2021
2238
  /**
2239
+ * @public
2022
2240
  * <p>The Amazon Resource Name (ARN) of the listener.</p>
2023
2241
  */
2024
2242
  ListenerArn: string | undefined;
2025
2243
  /**
2244
+ * @public
2026
2245
  * <p>The number of endpoint group objects that you want to return with this call. The default value is 10.</p>
2027
2246
  */
2028
2247
  MaxResults?: number;
2029
2248
  /**
2249
+ * @public
2030
2250
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
2031
2251
  */
2032
2252
  NextToken?: string;
@@ -2036,10 +2256,12 @@ export interface ListEndpointGroupsRequest {
2036
2256
  */
2037
2257
  export interface ListEndpointGroupsResponse {
2038
2258
  /**
2259
+ * @public
2039
2260
  * <p>The list of the endpoint groups associated with a listener.</p>
2040
2261
  */
2041
2262
  EndpointGroups?: EndpointGroup[];
2042
2263
  /**
2264
+ * @public
2043
2265
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
2044
2266
  */
2045
2267
  NextToken?: string;
@@ -2049,14 +2271,17 @@ export interface ListEndpointGroupsResponse {
2049
2271
  */
2050
2272
  export interface ListListenersRequest {
2051
2273
  /**
2274
+ * @public
2052
2275
  * <p>The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.</p>
2053
2276
  */
2054
2277
  AcceleratorArn: string | undefined;
2055
2278
  /**
2279
+ * @public
2056
2280
  * <p>The number of listener objects that you want to return with this call. The default value is 10.</p>
2057
2281
  */
2058
2282
  MaxResults?: number;
2059
2283
  /**
2284
+ * @public
2060
2285
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
2061
2286
  */
2062
2287
  NextToken?: string;
@@ -2066,10 +2291,12 @@ export interface ListListenersRequest {
2066
2291
  */
2067
2292
  export interface ListListenersResponse {
2068
2293
  /**
2294
+ * @public
2069
2295
  * <p>The list of listeners for an accelerator.</p>
2070
2296
  */
2071
2297
  Listeners?: Listener[];
2072
2298
  /**
2299
+ * @public
2073
2300
  * <p>The token for the next set of results. You receive this token from a previous call.</p>
2074
2301
  */
2075
2302
  NextToken?: string;
@@ -2079,6 +2306,7 @@ export interface ListListenersResponse {
2079
2306
  */
2080
2307
  export interface ListTagsForResourceRequest {
2081
2308
  /**
2309
+ * @public
2082
2310
  * <p>The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.</p>
2083
2311
  */
2084
2312
  ResourceArn: string | undefined;
@@ -2088,6 +2316,7 @@ export interface ListTagsForResourceRequest {
2088
2316
  */
2089
2317
  export interface ListTagsForResourceResponse {
2090
2318
  /**
2319
+ * @public
2091
2320
  * <p>Root level tag for the Tags parameters.</p>
2092
2321
  */
2093
2322
  Tags?: Tag[];
@@ -2097,12 +2326,14 @@ export interface ListTagsForResourceResponse {
2097
2326
  */
2098
2327
  export interface ProvisionByoipCidrRequest {
2099
2328
  /**
2329
+ * @public
2100
2330
  * <p>The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can
2101
2331
  * specify is /24. The address range cannot overlap with another address range that you've brought
2102
2332
  * to this or another Region.</p>
2103
2333
  */
2104
2334
  Cidr: string | undefined;
2105
2335
  /**
2336
+ * @public
2106
2337
  * <p>A signed document that proves that you are authorized to bring the specified IP address range to
2107
2338
  * Amazon using BYOIP.
2108
2339
  * </p>
@@ -2114,6 +2345,7 @@ export interface ProvisionByoipCidrRequest {
2114
2345
  */
2115
2346
  export interface ProvisionByoipCidrResponse {
2116
2347
  /**
2348
+ * @public
2117
2349
  * <p>Information about the address range.</p>
2118
2350
  */
2119
2351
  ByoipCidr?: ByoipCidr;
@@ -2123,11 +2355,13 @@ export interface ProvisionByoipCidrResponse {
2123
2355
  */
2124
2356
  export interface RemoveCustomRoutingEndpointsRequest {
2125
2357
  /**
2358
+ * @public
2126
2359
  * <p>The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC)
2127
2360
  * subnet IDs. </p>
2128
2361
  */
2129
2362
  EndpointIds: string[] | undefined;
2130
2363
  /**
2364
+ * @public
2131
2365
  * <p>The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.</p>
2132
2366
  */
2133
2367
  EndpointGroupArn: string | undefined;
@@ -2137,10 +2371,12 @@ export interface RemoveCustomRoutingEndpointsRequest {
2137
2371
  */
2138
2372
  export interface RemoveEndpointsRequest {
2139
2373
  /**
2374
+ * @public
2140
2375
  * <p>The identifiers of the endpoints that you want to remove.</p>
2141
2376
  */
2142
2377
  EndpointIdentifiers: EndpointIdentifier[] | undefined;
2143
2378
  /**
2379
+ * @public
2144
2380
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
2145
2381
  */
2146
2382
  EndpointGroupArn: string | undefined;
@@ -2150,10 +2386,12 @@ export interface RemoveEndpointsRequest {
2150
2386
  */
2151
2387
  export interface TagResourceRequest {
2152
2388
  /**
2389
+ * @public
2153
2390
  * <p>The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.</p>
2154
2391
  */
2155
2392
  ResourceArn: string | undefined;
2156
2393
  /**
2394
+ * @public
2157
2395
  * <p>The tags to add to a resource. A tag consists of a key and a value that you define.</p>
2158
2396
  */
2159
2397
  Tags: Tag[] | undefined;
@@ -2168,10 +2406,12 @@ export interface TagResourceResponse {
2168
2406
  */
2169
2407
  export interface UntagResourceRequest {
2170
2408
  /**
2409
+ * @public
2171
2410
  * <p>The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.</p>
2172
2411
  */
2173
2412
  ResourceArn: string | undefined;
2174
2413
  /**
2414
+ * @public
2175
2415
  * <p>The tag key pairs that you want to remove from the specified resources.</p>
2176
2416
  */
2177
2417
  TagKeys: string[] | undefined;
@@ -2186,19 +2426,23 @@ export interface UntagResourceResponse {
2186
2426
  */
2187
2427
  export interface UpdateAcceleratorRequest {
2188
2428
  /**
2429
+ * @public
2189
2430
  * <p>The Amazon Resource Name (ARN) of the accelerator to update.</p>
2190
2431
  */
2191
2432
  AcceleratorArn: string | undefined;
2192
2433
  /**
2434
+ * @public
2193
2435
  * <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
2194
2436
  * periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
2195
2437
  */
2196
2438
  Name?: string;
2197
2439
  /**
2440
+ * @public
2198
2441
  * <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
2199
2442
  */
2200
2443
  IpAddressType?: IpAddressType | string;
2201
2444
  /**
2445
+ * @public
2202
2446
  * <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
2203
2447
  * <p>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
2204
2448
  */
@@ -2209,6 +2453,7 @@ export interface UpdateAcceleratorRequest {
2209
2453
  */
2210
2454
  export interface UpdateAcceleratorResponse {
2211
2455
  /**
2456
+ * @public
2212
2457
  * <p>Information about the updated accelerator.</p>
2213
2458
  */
2214
2459
  Accelerator?: Accelerator;
@@ -2218,10 +2463,12 @@ export interface UpdateAcceleratorResponse {
2218
2463
  */
2219
2464
  export interface UpdateAcceleratorAttributesRequest {
2220
2465
  /**
2466
+ * @public
2221
2467
  * <p>The Amazon Resource Name (ARN) of the accelerator that you want to update.</p>
2222
2468
  */
2223
2469
  AcceleratorArn: string | undefined;
2224
2470
  /**
2471
+ * @public
2225
2472
  * <p>Update whether flow logs are enabled. The default value is false. If the value is true,
2226
2473
  * <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
2227
2474
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow Logs</a> in
@@ -2229,12 +2476,14 @@ export interface UpdateAcceleratorAttributesRequest {
2229
2476
  */
2230
2477
  FlowLogsEnabled?: boolean;
2231
2478
  /**
2479
+ * @public
2232
2480
  * <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
2233
2481
  * <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
2234
2482
  * bucket.</p>
2235
2483
  */
2236
2484
  FlowLogsS3Bucket?: string;
2237
2485
  /**
2486
+ * @public
2238
2487
  * <p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
2239
2488
  * <code>FlowLogsEnabled</code> is <code>true</code>. </p>
2240
2489
  * <p>If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//),
@@ -2248,6 +2497,7 @@ export interface UpdateAcceleratorAttributesRequest {
2248
2497
  */
2249
2498
  export interface UpdateAcceleratorAttributesResponse {
2250
2499
  /**
2500
+ * @public
2251
2501
  * <p>Updated attributes for the accelerator.</p>
2252
2502
  */
2253
2503
  AcceleratorAttributes?: AcceleratorAttributes;
@@ -2257,19 +2507,23 @@ export interface UpdateAcceleratorAttributesResponse {
2257
2507
  */
2258
2508
  export interface UpdateCustomRoutingAcceleratorRequest {
2259
2509
  /**
2510
+ * @public
2260
2511
  * <p>The Amazon Resource Name (ARN) of the accelerator to update.</p>
2261
2512
  */
2262
2513
  AcceleratorArn: string | undefined;
2263
2514
  /**
2515
+ * @public
2264
2516
  * <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
2265
2517
  * periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
2266
2518
  */
2267
2519
  Name?: string;
2268
2520
  /**
2521
+ * @public
2269
2522
  * <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
2270
2523
  */
2271
2524
  IpAddressType?: IpAddressType | string;
2272
2525
  /**
2526
+ * @public
2273
2527
  * <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
2274
2528
  * <p>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
2275
2529
  */
@@ -2280,6 +2534,7 @@ export interface UpdateCustomRoutingAcceleratorRequest {
2280
2534
  */
2281
2535
  export interface UpdateCustomRoutingAcceleratorResponse {
2282
2536
  /**
2537
+ * @public
2283
2538
  * <p>Information about the updated custom routing accelerator.</p>
2284
2539
  */
2285
2540
  Accelerator?: CustomRoutingAccelerator;
@@ -2289,10 +2544,12 @@ export interface UpdateCustomRoutingAcceleratorResponse {
2289
2544
  */
2290
2545
  export interface UpdateCustomRoutingAcceleratorAttributesRequest {
2291
2546
  /**
2547
+ * @public
2292
2548
  * <p>The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.</p>
2293
2549
  */
2294
2550
  AcceleratorArn: string | undefined;
2295
2551
  /**
2552
+ * @public
2296
2553
  * <p>Update whether flow logs are enabled. The default value is false. If the value is true,
2297
2554
  * <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
2298
2555
  * <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow logs</a> in
@@ -2300,12 +2557,14 @@ export interface UpdateCustomRoutingAcceleratorAttributesRequest {
2300
2557
  */
2301
2558
  FlowLogsEnabled?: boolean;
2302
2559
  /**
2560
+ * @public
2303
2561
  * <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
2304
2562
  * <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
2305
2563
  * bucket.</p>
2306
2564
  */
2307
2565
  FlowLogsS3Bucket?: string;
2308
2566
  /**
2567
+ * @public
2309
2568
  * <p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
2310
2569
  * <code>FlowLogsEnabled</code> is <code>true</code>. </p>
2311
2570
  * <p>If you don’t specify a prefix, the flow logs are stored in the
@@ -2319,6 +2578,7 @@ export interface UpdateCustomRoutingAcceleratorAttributesRequest {
2319
2578
  */
2320
2579
  export interface UpdateCustomRoutingAcceleratorAttributesResponse {
2321
2580
  /**
2581
+ * @public
2322
2582
  * <p>Updated custom routing accelerator.</p>
2323
2583
  */
2324
2584
  AcceleratorAttributes?: CustomRoutingAcceleratorAttributes;
@@ -2328,10 +2588,12 @@ export interface UpdateCustomRoutingAcceleratorAttributesResponse {
2328
2588
  */
2329
2589
  export interface UpdateCustomRoutingListenerRequest {
2330
2590
  /**
2591
+ * @public
2331
2592
  * <p>The Amazon Resource Name (ARN) of the listener to update.</p>
2332
2593
  */
2333
2594
  ListenerArn: string | undefined;
2334
2595
  /**
2596
+ * @public
2335
2597
  * <p>The updated port range to support for connections from clients to your accelerator. If you remove ports that are
2336
2598
  * currently being used by a subnet endpoint, the call fails.</p>
2337
2599
  * <p>Separately, you set port ranges for endpoints. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html">About
@@ -2344,6 +2606,7 @@ export interface UpdateCustomRoutingListenerRequest {
2344
2606
  */
2345
2607
  export interface UpdateCustomRoutingListenerResponse {
2346
2608
  /**
2609
+ * @public
2347
2610
  * <p>Information for the updated listener for a custom routing accelerator.</p>
2348
2611
  */
2349
2612
  Listener?: CustomRoutingListener;
@@ -2353,14 +2616,17 @@ export interface UpdateCustomRoutingListenerResponse {
2353
2616
  */
2354
2617
  export interface UpdateEndpointGroupRequest {
2355
2618
  /**
2619
+ * @public
2356
2620
  * <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
2357
2621
  */
2358
2622
  EndpointGroupArn: string | undefined;
2359
2623
  /**
2624
+ * @public
2360
2625
  * <p>The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.</p>
2361
2626
  */
2362
2627
  EndpointConfigurations?: EndpointConfiguration[];
2363
2628
  /**
2629
+ * @public
2364
2630
  * <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
2365
2631
  * this listener. </p>
2366
2632
  * <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
@@ -2369,31 +2635,37 @@ export interface UpdateEndpointGroupRequest {
2369
2635
  */
2370
2636
  TrafficDialPercentage?: number;
2371
2637
  /**
2638
+ * @public
2372
2639
  * <p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port
2373
2640
  * is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses
2374
2641
  * the first port in the list.</p>
2375
2642
  */
2376
2643
  HealthCheckPort?: number;
2377
2644
  /**
2645
+ * @public
2378
2646
  * <p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default
2379
2647
  * value is TCP.</p>
2380
2648
  */
2381
2649
  HealthCheckProtocol?: HealthCheckProtocol | string;
2382
2650
  /**
2651
+ * @public
2383
2652
  * <p>If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The
2384
2653
  * default value is slash (/).</p>
2385
2654
  */
2386
2655
  HealthCheckPath?: string;
2387
2656
  /**
2657
+ * @public
2388
2658
  * <p>The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.</p>
2389
2659
  */
2390
2660
  HealthCheckIntervalSeconds?: number;
2391
2661
  /**
2662
+ * @public
2392
2663
  * <p>The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an
2393
2664
  * unhealthy endpoint to healthy. The default value is 3.</p>
2394
2665
  */
2395
2666
  ThresholdCount?: number;
2396
2667
  /**
2668
+ * @public
2397
2669
  * <p>Override specific listener ports used to route traffic to endpoints that are part of this endpoint group.
2398
2670
  * For example, you can create a port override in which the listener
2399
2671
  * receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
@@ -2408,6 +2680,7 @@ export interface UpdateEndpointGroupRequest {
2408
2680
  */
2409
2681
  export interface UpdateEndpointGroupResponse {
2410
2682
  /**
2683
+ * @public
2411
2684
  * <p>The information about the endpoint group that was updated.</p>
2412
2685
  */
2413
2686
  EndpointGroup?: EndpointGroup;
@@ -2417,18 +2690,22 @@ export interface UpdateEndpointGroupResponse {
2417
2690
  */
2418
2691
  export interface UpdateListenerRequest {
2419
2692
  /**
2693
+ * @public
2420
2694
  * <p>The Amazon Resource Name (ARN) of the listener to update.</p>
2421
2695
  */
2422
2696
  ListenerArn: string | undefined;
2423
2697
  /**
2698
+ * @public
2424
2699
  * <p>The updated list of port ranges for the connections from clients to the accelerator.</p>
2425
2700
  */
2426
2701
  PortRanges?: PortRange[];
2427
2702
  /**
2703
+ * @public
2428
2704
  * <p>The updated protocol for the connections from clients to the accelerator.</p>
2429
2705
  */
2430
2706
  Protocol?: Protocol | string;
2431
2707
  /**
2708
+ * @public
2432
2709
  * <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
2433
2710
  * regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
2434
2711
  * route each client to the same specific endpoint.</p>
@@ -2449,6 +2726,7 @@ export interface UpdateListenerRequest {
2449
2726
  */
2450
2727
  export interface UpdateListenerResponse {
2451
2728
  /**
2729
+ * @public
2452
2730
  * <p>Information for the updated listener.</p>
2453
2731
  */
2454
2732
  Listener?: Listener;
@@ -2458,6 +2736,7 @@ export interface UpdateListenerResponse {
2458
2736
  */
2459
2737
  export interface WithdrawByoipCidrRequest {
2460
2738
  /**
2739
+ * @public
2461
2740
  * <p>The address range, in CIDR notation.</p>
2462
2741
  */
2463
2742
  Cidr: string | undefined;
@@ -2467,6 +2746,7 @@ export interface WithdrawByoipCidrRequest {
2467
2746
  */
2468
2747
  export interface WithdrawByoipCidrResponse {
2469
2748
  /**
2749
+ * @public
2470
2750
  * <p>Information about the address pool.</p>
2471
2751
  */
2472
2752
  ByoipCidr?: ByoipCidr;