/
models_0.ts
3406 lines (2979 loc) · 105 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { GlobalAcceleratorServiceException as __BaseException } from "./GlobalAcceleratorServiceException";
/**
* <p>A complex type that contains a <code>Timestamp</code> value and <code>Message</code> for changes
* that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when
* you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum
* of ten event messages. </p>
*/
export interface AcceleratorEvent {
/**
* <p>A string that contains an <code>Event</code> message describing changes or errors
* when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>
*/
Message?: string;
/**
* <p>A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>
*/
Timestamp?: Date;
}
export enum IpAddressType {
DUAL_STACK = "DUAL_STACK",
IPV4 = "IPV4",
}
export enum IpAddressFamily {
IPv4 = "IPv4",
IPv6 = "IPv6",
}
/**
* <p>A complex type for the set of IP addresses for an accelerator.</p>
*/
export interface IpSet {
/**
* @deprecated
*
* <p>IpFamily is deprecated and has been replaced by IpAddressFamily.</p>
*/
IpFamily?: string;
/**
* <p>The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.</p>
*/
IpAddresses?: string[];
/**
* <p>The types of IP addresses included in this IP set. </p>
*/
IpAddressFamily?: IpAddressFamily | string;
}
export enum AcceleratorStatus {
DEPLOYED = "DEPLOYED",
IN_PROGRESS = "IN_PROGRESS",
}
/**
* <p>An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct
* traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.</p>
*/
export interface Accelerator {
/**
* <p>The Amazon Resource Name (ARN) of the accelerator.</p>
*/
AcceleratorArn?: string;
/**
* <p>The name of the accelerator. The name must contain only alphanumeric characters or
* hyphens (-), and must not begin or end with a hyphen.</p>
*/
Name?: string;
/**
* <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
*/
IpAddressType?: IpAddressType | string;
/**
* <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p>
* <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
*/
Enabled?: boolean;
/**
* <p>The static IP addresses that Global Accelerator associates with the accelerator.</p>
*/
IpSets?: IpSet[];
/**
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.</p>
* <p>The naming convention for the DNS name for an accelerator is the following: A lowercase letter a,
* followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
* a1234567890abcdef.awsglobalaccelerator.com.</p>
* <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, that points to both
* the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.</p>
* <p>For more information about the default DNS name, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html">
* Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
DnsName?: string;
/**
* <p>Describes the deployment status of the accelerator.</p>
*/
Status?: AcceleratorStatus | string;
/**
* <p>The date and time that the accelerator was created.</p>
*/
CreatedTime?: Date;
/**
* <p>The date and time that the accelerator was last modified.</p>
*/
LastModifiedTime?: Date;
/**
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:
* two IPv4 addresses and two IPv6 addresses.</p>
* <p>The naming convention for the dual-stack DNS name is the following: A lowercase letter a,
* followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:
* a1234567890abcdef.dualstack.awsglobalaccelerator.com.</p>
* <p>Note: Global Accelerator also assigns a default DNS name, <code>DnsName</code>, to your accelerator that points just to the static IPv4 addresses. </p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing">
* Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
DualStackDnsName?: string;
/**
* <p>A history of changes that you make to an accelerator in Global Accelerator.</p>
*/
Events?: AcceleratorEvent[];
}
/**
* <p>Attributes of an accelerator.</p>
*/
export interface AcceleratorAttributes {
/**
* <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
* <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
* the <i>Global Accelerator Developer Guide</i>.</p>
*/
FlowLogsEnabled?: boolean;
/**
* <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
* <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
* bucket.</p>
*/
FlowLogsS3Bucket?: string;
/**
* <p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
* <code>FlowLogsEnabled</code> is <code>true</code>.</p>
* <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>
* <p>s3-bucket_name//AWSLogs/aws_account_id</p>
*/
FlowLogsS3Prefix?: string;
}
/**
* <p>The accelerator that you specified could not be disabled.</p>
*/
export class AcceleratorNotDisabledException extends __BaseException {
readonly name: "AcceleratorNotDisabledException" = "AcceleratorNotDisabledException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AcceleratorNotDisabledException, __BaseException>) {
super({
name: "AcceleratorNotDisabledException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AcceleratorNotDisabledException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The accelerator that you specified doesn't exist.</p>
*/
export class AcceleratorNotFoundException extends __BaseException {
readonly name: "AcceleratorNotFoundException" = "AcceleratorNotFoundException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AcceleratorNotFoundException, __BaseException>) {
super({
name: "AcceleratorNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AcceleratorNotFoundException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>You don't have access permission.</p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.</p>
*/
export interface CustomRoutingEndpointConfiguration {
/**
* <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC)
* subnet ID. </p>
*/
EndpointId?: string;
}
export interface AddCustomRoutingEndpointsRequest {
/**
* <p>The list of endpoint objects to add to a custom routing accelerator.</p>
*/
EndpointConfigurations: CustomRoutingEndpointConfiguration[] | undefined;
/**
* <p>The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.</p>
*/
EndpointGroupArn: string | undefined;
}
/**
* <p>A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints,
* which are virtual private cloud (VPC) subnets.</p>
*/
export interface CustomRoutingEndpointDescription {
/**
* <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC)
* subnet ID. </p>
*/
EndpointId?: string;
}
export interface AddCustomRoutingEndpointsResponse {
/**
* <p>The endpoint objects added to the custom routing accelerator.</p>
*/
EndpointDescriptions?: CustomRoutingEndpointDescription[];
/**
* <p>The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.</p>
*/
EndpointGroupArn?: string;
}
/**
* <p>You can't use both of those options.</p>
*/
export class ConflictException extends __BaseException {
readonly name: "ConflictException" = "ConflictException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>) {
super({
name: "ConflictException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ConflictException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The endpoint that you specified doesn't exist.</p>
*/
export class EndpointAlreadyExistsException extends __BaseException {
readonly name: "EndpointAlreadyExistsException" = "EndpointAlreadyExistsException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<EndpointAlreadyExistsException, __BaseException>) {
super({
name: "EndpointAlreadyExistsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, EndpointAlreadyExistsException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The endpoint group that you specified doesn't exist.</p>
*/
export class EndpointGroupNotFoundException extends __BaseException {
readonly name: "EndpointGroupNotFoundException" = "EndpointGroupNotFoundException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<EndpointGroupNotFoundException, __BaseException>) {
super({
name: "EndpointGroupNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, EndpointGroupNotFoundException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>There was an internal error for Global Accelerator.</p>
*/
export class InternalServiceErrorException extends __BaseException {
readonly name: "InternalServiceErrorException" = "InternalServiceErrorException";
readonly $fault: "server" = "server";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InternalServiceErrorException, __BaseException>) {
super({
name: "InternalServiceErrorException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, InternalServiceErrorException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>An argument that you specified is invalid.</p>
*/
export class InvalidArgumentException extends __BaseException {
readonly name: "InvalidArgumentException" = "InvalidArgumentException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>) {
super({
name: "InvalidArgumentException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidArgumentException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>Processing your request would cause you to exceed an Global Accelerator limit.</p>
*/
export class LimitExceededException extends __BaseException {
readonly name: "LimitExceededException" = "LimitExceededException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>) {
super({
name: "LimitExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LimitExceededException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.</p>
*/
export interface EndpointConfiguration {
/**
* <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
* Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
* allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active
* when you add it as an endpoint.</p>
* <p>An Application Load Balancer can be either internal or internet-facing.</p>
*/
EndpointId?: string;
/**
* <p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic
* based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The
* result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second
* and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html">Endpoint weights</a> in the
* <i>Global Accelerator Developer Guide</i>.</p>
*/
Weight?: number;
/**
* <p>Indicates whether client IP address preservation is enabled for an endpoint.
* The value is true or false. The default value is true for new accelerators. </p>
* <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
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
*
*
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
* Balancers and Amazon EC2 instances.</p>
*
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
* Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
ClientIPPreservationEnabled?: boolean;
}
export interface AddEndpointsRequest {
/**
* <p>The list of endpoint objects.</p>
*/
EndpointConfigurations: EndpointConfiguration[] | undefined;
/**
* <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
*/
EndpointGroupArn: string | undefined;
}
export enum HealthState {
HEALTHY = "HEALTHY",
INITIAL = "INITIAL",
UNHEALTHY = "UNHEALTHY",
}
/**
* <p>A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load
* balancers.</p>
*/
export interface EndpointDescription {
/**
* <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
* Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
* allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p>
* <p>An Application Load Balancer can be either internal or internet-facing.</p>
*/
EndpointId?: string;
/**
* <p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic
* based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The
* result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second
* and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html">Endpoint weights</a> in the
* <i>Global Accelerator Developer Guide</i>. </p>
*/
Weight?: number;
/**
* <p>The health status of the endpoint.</p>
*/
HealthState?: HealthState | string;
/**
* <p>Returns a null result.</p>
*/
HealthReason?: string;
/**
* <p>Indicates whether client IP address preservation is enabled for an endpoint.
* The value is true or false. The default value is true for new accelerators. </p>
* <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
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
*
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
* Balancers and Amazon EC2 instances.</p>
*
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
* Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
ClientIPPreservationEnabled?: boolean;
}
export interface AddEndpointsResponse {
/**
* <p>The list of endpoint objects.</p>
*/
EndpointDescriptions?: EndpointDescription[];
/**
* <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
*/
EndpointGroupArn?: string;
}
/**
* <p>There's already a transaction in progress. Another transaction can't be processed.</p>
*/
export class TransactionInProgressException extends __BaseException {
readonly name: "TransactionInProgressException" = "TransactionInProgressException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<TransactionInProgressException, __BaseException>) {
super({
name: "TransactionInProgressException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, TransactionInProgressException.prototype);
this.Message = opts.Message;
}
}
export interface AdvertiseByoipCidrRequest {
/**
* <p>The address range, in CIDR notation. This must be the exact range that you provisioned.
* You can't advertise only a portion of the provisioned range.</p>
*/
Cidr: string | undefined;
}
/**
* <p>A complex type that contains a <code>Message</code> and a <code>Timestamp</code> value for changes
* that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP
* address (BYOIP).</p>
*/
export interface ByoipCidrEvent {
/**
* <p>A string that contains an <code>Event</code> message describing changes that you make in the status
* of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).</p>
*/
Message?: string;
/**
* <p>A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through
* bring your own IP address (BYOIP).</p>
*/
Timestamp?: Date;
}
export enum ByoipCidrState {
ADVERTISING = "ADVERTISING",
DEPROVISIONED = "DEPROVISIONED",
FAILED_ADVERTISING = "FAILED_ADVERTISING",
FAILED_DEPROVISION = "FAILED_DEPROVISION",
FAILED_PROVISION = "FAILED_PROVISION",
FAILED_WITHDRAW = "FAILED_WITHDRAW",
PENDING_ADVERTISING = "PENDING_ADVERTISING",
PENDING_DEPROVISIONING = "PENDING_DEPROVISIONING",
PENDING_PROVISIONING = "PENDING_PROVISIONING",
PENDING_WITHDRAWING = "PENDING_WITHDRAWING",
READY = "READY",
}
/**
* <p>Information about an IP address range that is provisioned for use with your Amazon Web Services resources through
* bring your own IP address (BYOIP).</p>
* <p>The following describes each BYOIP <code>State</code> that your IP address range can be in.</p>
* <ul>
* <li>
* <p>
* <b>PENDING_PROVISIONING</b> —
* You’ve submitted a request to provision an IP address range but it is not yet provisioned with
* Global Accelerator.</p>
* </li>
* <li>
* <p>
* <b>READY</b> — The address range is provisioned
* with Global Accelerator and can be advertised.</p>
* </li>
* <li>
* <p>
* <b>PENDING_ADVERTISING</b> — You’ve submitted a
* request for Global Accelerator to advertise an address range but it is not yet being advertised.</p>
* </li>
* <li>
* <p>
* <b>ADVERTISING</b> — The address range is
* being advertised by Global Accelerator.</p>
* </li>
* <li>
* <p>
* <b>PENDING_WITHDRAWING</b> — You’ve submitted
* a request to withdraw an address range from being advertised but it is still being advertised
* by Global Accelerator.</p>
* </li>
* <li>
* <p>
* <b>PENDING_DEPROVISIONING</b> — You’ve submitted a
* request to deprovision an address range from Global Accelerator but it is still provisioned.</p>
* </li>
* <li>
* <p>
* <b>DEPROVISIONED</b> — The address range is deprovisioned
* from Global Accelerator.</p>
* </li>
* <li>
* <p>
* <b>FAILED_PROVISION </b> — The request to
* provision the address range from Global Accelerator was not successful. Please make sure that
* you provide all of the correct information, and try again. If the request fails
* a second time, contact Amazon Web Services support.</p>
* </li>
* <li>
* <p>
* <b>FAILED_ADVERTISING</b> — The request for Global Accelerator
* to advertise the address range was not successful. Please make sure that
* you provide all of the correct information, and try again. If the request fails
* a second time, contact Amazon Web Services support.</p>
* </li>
* <li>
* <p>
* <b>FAILED_WITHDRAW</b> — The request to withdraw
* the address range from advertising by Global Accelerator was not successful. Please make sure that
* you provide all of the correct information, and try again. If the request fails
* a second time, contact Amazon Web Services support.</p>
* </li>
* <li>
* <p>
* <b>FAILED_DEPROVISION </b> — The request to
* deprovision the address range from Global Accelerator was not successful. Please make sure that
* you provide all of the correct information, and try again. If the request fails
* a second time, contact Amazon Web Services support.</p>
* </li>
* </ul>
*/
export interface ByoipCidr {
/**
* <p>The address range, in CIDR notation.</p>
*/
Cidr?: string;
/**
* <p>The state of the address pool.</p>
*/
State?: ByoipCidrState | string;
/**
* <p>A history of status changes for an IP address range that you bring to Global Accelerator
* through bring your own IP address (BYOIP).</p>
*/
Events?: ByoipCidrEvent[];
}
export interface AdvertiseByoipCidrResponse {
/**
* <p>Information about the address range.</p>
*/
ByoipCidr?: ByoipCidr;
}
/**
* <p>The CIDR that you specified was not found or is incorrect.</p>
*/
export class ByoipCidrNotFoundException extends __BaseException {
readonly name: "ByoipCidrNotFoundException" = "ByoipCidrNotFoundException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ByoipCidrNotFoundException, __BaseException>) {
super({
name: "ByoipCidrNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ByoipCidrNotFoundException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be
* incorrect for this action.</p>
*/
export class IncorrectCidrStateException extends __BaseException {
readonly name: "IncorrectCidrStateException" = "IncorrectCidrStateException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<IncorrectCidrStateException, __BaseException>) {
super({
name: "IncorrectCidrStateException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, IncorrectCidrStateException.prototype);
this.Message = opts.Message;
}
}
export interface AllowCustomRoutingTrafficRequest {
/**
* <p>The Amazon Resource Name (ARN) of the endpoint group.</p>
*/
EndpointGroupArn: string | undefined;
/**
* <p>An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.</p>
*/
EndpointId: string | undefined;
/**
* <p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive
* traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.</p>
* <p>
* <code>DestinationAddresses</code> is required if <code>AllowAllTrafficToEndpoint</code> is <code>FALSE</code> or is
* not specified.</p>
*/
DestinationAddresses?: string[];
/**
* <p>A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.</p>
*/
DestinationPorts?: number[];
/**
* <p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic
* from a custom routing accelerator. The value is TRUE or FALSE. </p>
* <p>When set to TRUE, <i>all</i> destinations in the custom routing VPC subnet can receive traffic. Note
* that you cannot specify destination IP addresses and ports when the value is set to TRUE.</p>
* <p>When set to FALSE (or not specified), you <i>must</i> specify a list of destination IP addresses that are allowed
* to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is
* the same as the ports configured for the endpoint group.</p>
* <p>The default value is FALSE.</p>
*/
AllowAllTrafficToEndpoint?: boolean;
}
/**
* <p>The listener that you specified has an endpoint group associated with it. You must remove all dependent resources
* from a listener before you can delete it.</p>
*/
export class AssociatedEndpointGroupFoundException extends __BaseException {
readonly name: "AssociatedEndpointGroupFoundException" = "AssociatedEndpointGroupFoundException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AssociatedEndpointGroupFoundException, __BaseException>) {
super({
name: "AssociatedEndpointGroupFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AssociatedEndpointGroupFoundException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an
* accelerator before you can delete it.</p>
*/
export class AssociatedListenerFoundException extends __BaseException {
readonly name: "AssociatedListenerFoundException" = "AssociatedListenerFoundException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AssociatedListenerFoundException, __BaseException>) {
super({
name: "AssociatedListenerFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AssociatedListenerFoundException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services
* account using bring your own IP addresses (BYOIP). </p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
export interface CidrAuthorizationContext {
/**
* <p>The plain-text authorization message for the prefix and account.</p>
*/
Message: string | undefined;
/**
* <p>The signed authorization message for the prefix and account.</p>
*/
Signature: string | undefined;
}
export enum ClientAffinity {
NONE = "NONE",
SOURCE_IP = "SOURCE_IP",
}
/**
* <p>A complex type that contains a <code>Tag</code> key and <code>Tag</code> value.</p>
*/
export interface Tag {
/**
* <p>A string that contains a <code>Tag</code> key.</p>
*/
Key: string | undefined;
/**
* <p>A string that contains a <code>Tag</code> value.</p>
*/
Value: string | undefined;
}
export interface CreateAcceleratorRequest {
/**
* <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
* periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
*/
Name: string | undefined;
/**
* <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
*/
IpAddressType?: IpAddressType | string;
/**
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
* from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
* <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
* When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns
* you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges
* to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is
* because Global Accelerator assigns each address range to a different network zone, for high availability.</p>
* <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p>
* <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new
* accelerator with the new addresses.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
IpAddresses?: string[];
/**
* <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
* <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
*/
Enabled?: boolean;
/**
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the
* uniqueness—of an accelerator.</p>
*/
IdempotencyToken?: string;
/**
* <p>Create tags for an accelerator.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
Tags?: Tag[];
}
export interface CreateAcceleratorResponse {
/**
* <p>The accelerator that is created by specifying a listener and the supported IP address types.</p>
*/
Accelerator?: Accelerator;
}
export interface CreateCustomRoutingAcceleratorRequest {
/**
* <p>The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain
* only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>
*/
Name: string | undefined;
/**
* <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
*/
IpAddressType?: IpAddressType | string;
/**
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
* from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
* <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
* When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns
* you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges
* to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is
* because Global Accelerator assigns each address range to a different network zone, for high availability.</p>
* <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p>
* <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new
* accelerator with the new addresses.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
IpAddresses?: string[];
/**
* <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
* <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
*/
Enabled?: boolean;
/**
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency—that
* is, the uniqueness—of the request.</p>
*/
IdempotencyToken?: string;
/**
* <p>Create tags for an accelerator.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
Tags?: Tag[];
}
export enum CustomRoutingAcceleratorStatus {
DEPLOYED = "DEPLOYED",
IN_PROGRESS = "IN_PROGRESS",
}
/**
* <p>Attributes of a custom routing accelerator.</p>
*/
export interface CustomRoutingAccelerator {
/**
* <p>The Amazon Resource Name (ARN) of the custom routing accelerator.</p>
*/
AcceleratorArn?: string;
/**
* <p>The name of the accelerator. The name must contain only alphanumeric characters or
* hyphens (-), and must not begin or end with a hyphen.</p>
*/
Name?: string;
/**
* <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
*/
IpAddressType?: IpAddressType | string;
/**
* <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p>
* <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
*/
Enabled?: boolean;
/**
* <p>The static IP addresses that Global Accelerator associates with the accelerator.</p>
*/
IpSets?: IpSet[];
/**
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. </p>
* <p>The naming convention for the DNS name is the following: A lowercase letter a,
* followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
* a1234567890abcdef.awsglobalaccelerator.com.</p>
*
* <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, that points to both the A record
* and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.</p>
* <p>For more information about the default DNS name, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/dns-addressing-custom-domains.dns-addressing.html">
* Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
*/
DnsName?: string;
/**
* <p>Describes the deployment status of the accelerator.</p>
*/
Status?: CustomRoutingAcceleratorStatus | string;
/**
* <p>The date and time that the accelerator was created.</p>
*/
CreatedTime?: Date;