@aws-sdk/client-global-accelerator 3.137.0 → 3.142.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.
- package/CHANGELOG.md +33 -0
- package/README.md +23 -120
- package/dist-cjs/models/models_0.js +13 -3
- package/dist-cjs/protocols/Aws_json1_1.js +264 -412
- package/dist-es/models/models_0.js +7 -0
- package/dist-es/protocols/Aws_json1_1.js +433 -437
- package/dist-types/GlobalAccelerator.d.ts +66 -158
- package/dist-types/GlobalAcceleratorClient.d.ts +25 -120
- package/dist-types/commands/AdvertiseByoipCidrCommand.d.ts +4 -4
- package/dist-types/commands/CreateAcceleratorCommand.d.ts +3 -2
- package/dist-types/commands/CreateCustomRoutingAcceleratorCommand.d.ts +4 -3
- package/dist-types/commands/CreateCustomRoutingEndpointGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateEndpointGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAcceleratorCommand.d.ts +4 -4
- package/dist-types/commands/DeleteCustomRoutingAcceleratorCommand.d.ts +3 -3
- package/dist-types/commands/DeprovisionByoipCidrCommand.d.ts +3 -3
- package/dist-types/commands/ListAcceleratorsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomRoutingAcceleratorsCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomRoutingPortMappingsCommand.d.ts +4 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ProvisionByoipCidrCommand.d.ts +3 -3
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAcceleratorCommand.d.ts +3 -2
- package/dist-types/commands/WithdrawByoipCidrCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +188 -129
- package/dist-types/ts3.4/models/models_0.d.ts +20 -0
- package/package.json +6 -6
|
@@ -1,20 +1,48 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { GlobalAcceleratorServiceException as __BaseException } from "./GlobalAcceleratorServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* <p>A complex type that contains a <code>Timestamp</code> value and <code>Message</code> for changes
|
|
5
|
+
* that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when
|
|
6
|
+
* you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum
|
|
7
|
+
* of ten event messages. </p>
|
|
8
|
+
*/
|
|
9
|
+
export interface AcceleratorEvent {
|
|
10
|
+
/**
|
|
11
|
+
* <p>A string that contains an <code>Event</code> message describing changes or errors
|
|
12
|
+
* when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>
|
|
13
|
+
*/
|
|
14
|
+
Message?: string;
|
|
15
|
+
/**
|
|
16
|
+
* <p>A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.</p>
|
|
17
|
+
*/
|
|
18
|
+
Timestamp?: Date;
|
|
19
|
+
}
|
|
3
20
|
export declare enum IpAddressType {
|
|
21
|
+
DUAL_STACK = "DUAL_STACK",
|
|
4
22
|
IPV4 = "IPV4"
|
|
5
23
|
}
|
|
24
|
+
export declare enum IpAddressFamily {
|
|
25
|
+
IPv4 = "IPv4",
|
|
26
|
+
IPv6 = "IPv6"
|
|
27
|
+
}
|
|
6
28
|
/**
|
|
7
29
|
* <p>A complex type for the set of IP addresses for an accelerator.</p>
|
|
8
30
|
*/
|
|
9
31
|
export interface IpSet {
|
|
10
32
|
/**
|
|
11
|
-
*
|
|
33
|
+
* @deprecated
|
|
34
|
+
*
|
|
35
|
+
* <p>IpFamily is deprecated and has been replaced by IpAddressFamily.</p>
|
|
12
36
|
*/
|
|
13
37
|
IpFamily?: string;
|
|
14
38
|
/**
|
|
15
39
|
* <p>The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.</p>
|
|
16
40
|
*/
|
|
17
41
|
IpAddresses?: string[];
|
|
42
|
+
/**
|
|
43
|
+
* <p>The types of IP addresses included in this IP set. </p>
|
|
44
|
+
*/
|
|
45
|
+
IpAddressFamily?: IpAddressFamily | string;
|
|
18
46
|
}
|
|
19
47
|
export declare type AcceleratorStatus = "DEPLOYED" | "IN_PROGRESS";
|
|
20
48
|
/**
|
|
@@ -32,8 +60,7 @@ export interface Accelerator {
|
|
|
32
60
|
*/
|
|
33
61
|
Name?: string;
|
|
34
62
|
/**
|
|
35
|
-
* <p>The
|
|
36
|
-
* </p>
|
|
63
|
+
* <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
|
|
37
64
|
*/
|
|
38
65
|
IpAddressType?: IpAddressType | string;
|
|
39
66
|
/**
|
|
@@ -46,12 +73,14 @@ export interface Accelerator {
|
|
|
46
73
|
*/
|
|
47
74
|
IpSets?: IpSet[];
|
|
48
75
|
/**
|
|
49
|
-
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to
|
|
50
|
-
* <p>The naming convention for the DNS name is the following: A lowercase letter a,
|
|
76
|
+
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.</p>
|
|
77
|
+
* <p>The naming convention for the DNS name for an accelerator is the following: A lowercase letter a,
|
|
51
78
|
* followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
|
|
52
79
|
* a1234567890abcdef.awsglobalaccelerator.com.</p>
|
|
53
|
-
*
|
|
54
|
-
*
|
|
80
|
+
* <p>If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four
|
|
81
|
+
* static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).</p>
|
|
82
|
+
* <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">
|
|
83
|
+
* Support for DNS Addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
55
84
|
*/
|
|
56
85
|
DnsName?: string;
|
|
57
86
|
/**
|
|
@@ -66,6 +95,21 @@ export interface Accelerator {
|
|
|
66
95
|
* <p>The date and time that the accelerator was last modified.</p>
|
|
67
96
|
*/
|
|
68
97
|
LastModifiedTime?: Date;
|
|
98
|
+
/**
|
|
99
|
+
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:
|
|
100
|
+
* two IPv4 addresses and two IPv6 addresses.</p>
|
|
101
|
+
* <p>The naming convention for the dual-stack DNS name is the following: A lowercase letter a,
|
|
102
|
+
* followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:
|
|
103
|
+
* a1234567890abcdef.dualstack.awsglobalaccelerator.com.</p>
|
|
104
|
+
* <p>Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses. </p>
|
|
105
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing">
|
|
106
|
+
* Support for DNS Addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
107
|
+
*/
|
|
108
|
+
DualStackDnsName?: string;
|
|
109
|
+
/**
|
|
110
|
+
* <p>A history of changes that you make to an accelerator in Global Accelerator.</p>
|
|
111
|
+
*/
|
|
112
|
+
Events?: AcceleratorEvent[];
|
|
69
113
|
}
|
|
70
114
|
/**
|
|
71
115
|
* <p>Attributes of an accelerator.</p>
|
|
@@ -74,21 +118,20 @@ export interface AcceleratorAttributes {
|
|
|
74
118
|
/**
|
|
75
119
|
* <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
|
|
76
120
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
77
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow
|
|
78
|
-
*
|
|
121
|
+
* <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
|
|
122
|
+
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
79
123
|
*/
|
|
80
124
|
FlowLogsEnabled?: boolean;
|
|
81
125
|
/**
|
|
82
126
|
* <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
|
|
83
|
-
*
|
|
127
|
+
* <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
|
|
84
128
|
* bucket.</p>
|
|
85
129
|
*/
|
|
86
130
|
FlowLogsS3Bucket?: string;
|
|
87
131
|
/**
|
|
88
132
|
* <p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
|
|
89
133
|
* <code>FlowLogsEnabled</code> is <code>true</code>.</p>
|
|
90
|
-
* <p>If you
|
|
91
|
-
* root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:</p>
|
|
134
|
+
* <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>
|
|
92
135
|
* <p>s3-bucket_name//AWSLogs/aws_account_id</p>
|
|
93
136
|
*/
|
|
94
137
|
FlowLogsS3Prefix?: string;
|
|
@@ -207,7 +250,7 @@ export declare class EndpointGroupNotFoundException extends __BaseException {
|
|
|
207
250
|
constructor(opts: __ExceptionOptionType<EndpointGroupNotFoundException, __BaseException>);
|
|
208
251
|
}
|
|
209
252
|
/**
|
|
210
|
-
* <p>There was an internal error for
|
|
253
|
+
* <p>There was an internal error for Global Accelerator.</p>
|
|
211
254
|
*/
|
|
212
255
|
export declare class InternalServiceErrorException extends __BaseException {
|
|
213
256
|
readonly name: "InternalServiceErrorException";
|
|
@@ -231,7 +274,7 @@ export declare class InvalidArgumentException extends __BaseException {
|
|
|
231
274
|
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
|
|
232
275
|
}
|
|
233
276
|
/**
|
|
234
|
-
* <p>Processing your request would cause you to exceed an
|
|
277
|
+
* <p>Processing your request would cause you to exceed an Global Accelerator limit.</p>
|
|
235
278
|
*/
|
|
236
279
|
export declare class LimitExceededException extends __BaseException {
|
|
237
280
|
readonly name: "LimitExceededException";
|
|
@@ -251,17 +294,17 @@ export interface AdvertiseByoipCidrRequest {
|
|
|
251
294
|
}
|
|
252
295
|
/**
|
|
253
296
|
* <p>A complex type that contains a <code>Message</code> and a <code>Timestamp</code> value for changes
|
|
254
|
-
* that you make in the status an IP address range that you bring to
|
|
297
|
+
* that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP
|
|
255
298
|
* address (BYOIP).</p>
|
|
256
299
|
*/
|
|
257
300
|
export interface ByoipCidrEvent {
|
|
258
301
|
/**
|
|
259
302
|
* <p>A string that contains an <code>Event</code> message describing changes that you make in the status
|
|
260
|
-
* of an IP address range that you bring to
|
|
303
|
+
* of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).</p>
|
|
261
304
|
*/
|
|
262
305
|
Message?: string;
|
|
263
306
|
/**
|
|
264
|
-
* <p>A timestamp when you make a status change for an IP address range that you bring to
|
|
307
|
+
* <p>A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through
|
|
265
308
|
* bring your own IP address (BYOIP).</p>
|
|
266
309
|
*/
|
|
267
310
|
Timestamp?: Date;
|
|
@@ -280,7 +323,7 @@ export declare enum ByoipCidrState {
|
|
|
280
323
|
READY = "READY"
|
|
281
324
|
}
|
|
282
325
|
/**
|
|
283
|
-
* <p>Information about an IP address range that is provisioned for use with your
|
|
326
|
+
* <p>Information about an IP address range that is provisioned for use with your Amazon Web Services resources through
|
|
284
327
|
* bring your own IP address (BYOIP).</p>
|
|
285
328
|
* <p>The following describes each BYOIP <code>State</code> that your IP address range can be in.</p>
|
|
286
329
|
* <ul>
|
|
@@ -288,66 +331,66 @@ export declare enum ByoipCidrState {
|
|
|
288
331
|
* <p>
|
|
289
332
|
* <b>PENDING_PROVISIONING</b> —
|
|
290
333
|
* You’ve submitted a request to provision an IP address range but it is not yet provisioned with
|
|
291
|
-
*
|
|
334
|
+
* Global Accelerator.</p>
|
|
292
335
|
* </li>
|
|
293
336
|
* <li>
|
|
294
337
|
* <p>
|
|
295
338
|
* <b>READY</b> — The address range is provisioned
|
|
296
|
-
*
|
|
339
|
+
* with Global Accelerator and can be advertised.</p>
|
|
297
340
|
* </li>
|
|
298
341
|
* <li>
|
|
299
342
|
* <p>
|
|
300
343
|
* <b>PENDING_ADVERTISING</b> — You’ve submitted a
|
|
301
|
-
*
|
|
344
|
+
* request for Global Accelerator to advertise an address range but it is not yet being advertised.</p>
|
|
302
345
|
* </li>
|
|
303
346
|
* <li>
|
|
304
347
|
* <p>
|
|
305
348
|
* <b>ADVERTISING</b> — The address range is
|
|
306
|
-
*
|
|
349
|
+
* being advertised by Global Accelerator.</p>
|
|
307
350
|
* </li>
|
|
308
351
|
* <li>
|
|
309
352
|
* <p>
|
|
310
353
|
* <b>PENDING_WITHDRAWING</b> — You’ve submitted
|
|
311
354
|
* a request to withdraw an address range from being advertised but it is still being advertised
|
|
312
|
-
* by
|
|
355
|
+
* by Global Accelerator.</p>
|
|
313
356
|
* </li>
|
|
314
357
|
* <li>
|
|
315
358
|
* <p>
|
|
316
359
|
* <b>PENDING_DEPROVISIONING</b> — You’ve submitted a
|
|
317
|
-
*
|
|
360
|
+
* request to deprovision an address range from Global Accelerator but it is still provisioned.</p>
|
|
318
361
|
* </li>
|
|
319
362
|
* <li>
|
|
320
363
|
* <p>
|
|
321
364
|
* <b>DEPROVISIONED</b> — The address range is deprovisioned
|
|
322
|
-
*
|
|
365
|
+
* from Global Accelerator.</p>
|
|
323
366
|
* </li>
|
|
324
367
|
* <li>
|
|
325
368
|
* <p>
|
|
326
369
|
* <b>FAILED_PROVISION </b> — The request to
|
|
327
|
-
*
|
|
370
|
+
* provision the address range from Global Accelerator was not successful. Please make sure that
|
|
328
371
|
* you provide all of the correct information, and try again. If the request fails
|
|
329
|
-
* a second time, contact
|
|
372
|
+
* a second time, contact Amazon Web Services support.</p>
|
|
330
373
|
* </li>
|
|
331
374
|
* <li>
|
|
332
375
|
* <p>
|
|
333
|
-
* <b>FAILED_ADVERTISING</b> — The request for
|
|
376
|
+
* <b>FAILED_ADVERTISING</b> — The request for Global Accelerator
|
|
334
377
|
* to advertise the address range was not successful. Please make sure that
|
|
335
378
|
* you provide all of the correct information, and try again. If the request fails
|
|
336
|
-
* a second time, contact
|
|
379
|
+
* a second time, contact Amazon Web Services support.</p>
|
|
337
380
|
* </li>
|
|
338
381
|
* <li>
|
|
339
382
|
* <p>
|
|
340
383
|
* <b>FAILED_WITHDRAW</b> — The request to withdraw
|
|
341
|
-
*
|
|
384
|
+
* the address range from advertising by Global Accelerator was not successful. Please make sure that
|
|
342
385
|
* you provide all of the correct information, and try again. If the request fails
|
|
343
|
-
* a second time, contact
|
|
386
|
+
* a second time, contact Amazon Web Services support.</p>
|
|
344
387
|
* </li>
|
|
345
388
|
* <li>
|
|
346
389
|
* <p>
|
|
347
390
|
* <b>FAILED_DEPROVISION </b> — The request to
|
|
348
|
-
*
|
|
391
|
+
* deprovision the address range from Global Accelerator was not successful. Please make sure that
|
|
349
392
|
* you provide all of the correct information, and try again. If the request fails
|
|
350
|
-
* a second time, contact
|
|
393
|
+
* a second time, contact Amazon Web Services support.</p>
|
|
351
394
|
* </li>
|
|
352
395
|
* </ul>
|
|
353
396
|
*/
|
|
@@ -361,7 +404,7 @@ export interface ByoipCidr {
|
|
|
361
404
|
*/
|
|
362
405
|
State?: ByoipCidrState | string;
|
|
363
406
|
/**
|
|
364
|
-
* <p>A history of status changes for an IP address range that you bring to
|
|
407
|
+
* <p>A history of status changes for an IP address range that you bring to Global Accelerator
|
|
365
408
|
* through bring your own IP address (BYOIP).</p>
|
|
366
409
|
*/
|
|
367
410
|
Events?: ByoipCidrEvent[];
|
|
@@ -457,10 +500,10 @@ export declare class AssociatedListenerFoundException extends __BaseException {
|
|
|
457
500
|
constructor(opts: __ExceptionOptionType<AssociatedListenerFoundException, __BaseException>);
|
|
458
501
|
}
|
|
459
502
|
/**
|
|
460
|
-
* <p>Provides authorization for Amazon to bring a specific IP address range to a specific
|
|
503
|
+
* <p>Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services
|
|
461
504
|
* account using bring your own IP addresses (BYOIP). </p>
|
|
462
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
463
|
-
*
|
|
505
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
|
|
506
|
+
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
464
507
|
*/
|
|
465
508
|
export interface CidrAuthorizationContext {
|
|
466
509
|
/**
|
|
@@ -488,25 +531,27 @@ export interface Tag {
|
|
|
488
531
|
}
|
|
489
532
|
export interface CreateAcceleratorRequest {
|
|
490
533
|
/**
|
|
491
|
-
* <p>The name of
|
|
492
|
-
* hyphens (-), and must not begin or end with a hyphen.</p>
|
|
534
|
+
* <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
|
|
535
|
+
* periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
|
|
493
536
|
*/
|
|
494
537
|
Name: string | undefined;
|
|
495
538
|
/**
|
|
496
|
-
* <p>The
|
|
539
|
+
* <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
|
|
497
540
|
*/
|
|
498
541
|
IpAddressType?: IpAddressType | string;
|
|
499
542
|
/**
|
|
500
|
-
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose
|
|
501
|
-
* from your own pool to use for the accelerator's static
|
|
502
|
-
*
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
543
|
+
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
|
|
544
|
+
* from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
|
|
545
|
+
* <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
|
|
546
|
+
* When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns
|
|
547
|
+
* you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges
|
|
548
|
+
* to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is
|
|
549
|
+
* because Global Accelerator assigns each address range to a different network zone, for high availability.</p>
|
|
550
|
+
* <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p>
|
|
506
551
|
* <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new
|
|
507
552
|
* accelerator with the new addresses.</p>
|
|
508
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
509
|
-
*
|
|
553
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
554
|
+
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
510
555
|
*/
|
|
511
556
|
IpAddresses?: string[];
|
|
512
557
|
/**
|
|
@@ -522,7 +567,7 @@ export interface CreateAcceleratorRequest {
|
|
|
522
567
|
/**
|
|
523
568
|
* <p>Create tags for an accelerator.</p>
|
|
524
569
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
525
|
-
*
|
|
570
|
+
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
526
571
|
*/
|
|
527
572
|
Tags?: Tag[];
|
|
528
573
|
}
|
|
@@ -539,20 +584,22 @@ export interface CreateCustomRoutingAcceleratorRequest {
|
|
|
539
584
|
*/
|
|
540
585
|
Name: string | undefined;
|
|
541
586
|
/**
|
|
542
|
-
* <p>The
|
|
587
|
+
* <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
|
|
543
588
|
*/
|
|
544
589
|
IpAddressType?: IpAddressType | string;
|
|
545
590
|
/**
|
|
546
|
-
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
*
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
*
|
|
591
|
+
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
|
|
592
|
+
* from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
|
|
593
|
+
* <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
|
|
594
|
+
* When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns
|
|
595
|
+
* you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges
|
|
596
|
+
* to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is
|
|
597
|
+
* because Global Accelerator assigns each address range to a different network zone, for high availability.</p>
|
|
598
|
+
* <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p>
|
|
599
|
+
* <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new
|
|
600
|
+
* accelerator with the new addresses.</p>
|
|
601
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
602
|
+
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
556
603
|
*/
|
|
557
604
|
IpAddresses?: string[];
|
|
558
605
|
/**
|
|
@@ -568,7 +615,7 @@ export interface CreateCustomRoutingAcceleratorRequest {
|
|
|
568
615
|
/**
|
|
569
616
|
* <p>Create tags for an accelerator.</p>
|
|
570
617
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
571
|
-
*
|
|
618
|
+
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
572
619
|
*/
|
|
573
620
|
Tags?: Tag[];
|
|
574
621
|
}
|
|
@@ -587,7 +634,7 @@ export interface CustomRoutingAccelerator {
|
|
|
587
634
|
*/
|
|
588
635
|
Name?: string;
|
|
589
636
|
/**
|
|
590
|
-
* <p>The
|
|
637
|
+
* <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
|
|
591
638
|
*/
|
|
592
639
|
IpAddressType?: IpAddressType | string;
|
|
593
640
|
/**
|
|
@@ -600,12 +647,14 @@ export interface CustomRoutingAccelerator {
|
|
|
600
647
|
*/
|
|
601
648
|
IpSets?: IpSet[];
|
|
602
649
|
/**
|
|
603
|
-
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to
|
|
650
|
+
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. </p>
|
|
604
651
|
* <p>The naming convention for the DNS name is the following: A lowercase letter a,
|
|
605
652
|
* followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
|
|
606
653
|
* a1234567890abcdef.awsglobalaccelerator.com.</p>
|
|
607
|
-
* <p>
|
|
608
|
-
*
|
|
654
|
+
* <p>If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four
|
|
655
|
+
* static addresses for the accelerator (two IPv4 addresses and two IPv6 addresses).</p>
|
|
656
|
+
* <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">
|
|
657
|
+
* Support for DNS Addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
609
658
|
*/
|
|
610
659
|
DnsName?: string;
|
|
611
660
|
/**
|
|
@@ -655,7 +704,7 @@ export interface CreateCustomRoutingEndpointGroupRequest {
|
|
|
655
704
|
*/
|
|
656
705
|
ListenerArn: string | undefined;
|
|
657
706
|
/**
|
|
658
|
-
* <p>The
|
|
707
|
+
* <p>The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a
|
|
659
708
|
* specific Region.</p>
|
|
660
709
|
*/
|
|
661
710
|
EndpointGroupRegion: string | undefined;
|
|
@@ -693,7 +742,7 @@ export interface CustomRoutingDestinationDescription {
|
|
|
693
742
|
Protocols?: (Protocol | string)[];
|
|
694
743
|
}
|
|
695
744
|
/**
|
|
696
|
-
* <p>A complex type for the endpoint group for a custom routing accelerator. An
|
|
745
|
+
* <p>A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.
|
|
697
746
|
* </p>
|
|
698
747
|
*/
|
|
699
748
|
export interface CustomRoutingEndpointGroup {
|
|
@@ -702,7 +751,7 @@ export interface CustomRoutingEndpointGroup {
|
|
|
702
751
|
*/
|
|
703
752
|
EndpointGroupArn?: string;
|
|
704
753
|
/**
|
|
705
|
-
* <p>The
|
|
754
|
+
* <p>The Amazon Web Services Region where the endpoint group is located.</p>
|
|
706
755
|
*/
|
|
707
756
|
EndpointGroupRegion?: string;
|
|
708
757
|
/**
|
|
@@ -822,20 +871,23 @@ export interface EndpointConfiguration {
|
|
|
822
871
|
*/
|
|
823
872
|
EndpointId?: string;
|
|
824
873
|
/**
|
|
825
|
-
* <p>The weight associated with the endpoint. When you add weights to endpoints, you configure
|
|
874
|
+
* <p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic
|
|
826
875
|
* based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The
|
|
827
876
|
* result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second
|
|
828
|
-
* 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
|
|
829
|
-
*
|
|
877
|
+
* 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
|
|
878
|
+
* <i>Global Accelerator Developer Guide</i>.</p>
|
|
830
879
|
*/
|
|
831
880
|
Weight?: number;
|
|
832
881
|
/**
|
|
833
|
-
* <p>Indicates whether client IP address preservation is enabled for an
|
|
882
|
+
* <p>Indicates whether client IP address preservation is enabled for an endpoint.
|
|
834
883
|
* The value is true or false. The default value is true for new accelerators. </p>
|
|
835
884
|
* <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
|
|
836
|
-
* traffic travels to applications on the
|
|
885
|
+
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
|
|
886
|
+
*
|
|
887
|
+
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
|
|
888
|
+
* Balancers and Amazon EC2 instances.</p>
|
|
837
889
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
|
|
838
|
-
* Preserve
|
|
890
|
+
* Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
839
891
|
*/
|
|
840
892
|
ClientIPPreservationEnabled?: boolean;
|
|
841
893
|
}
|
|
@@ -850,17 +902,17 @@ export declare enum HealthCheckProtocol {
|
|
|
850
902
|
* receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
|
|
851
903
|
* and 1443, respectively, on the endpoints.</p>
|
|
852
904
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html">
|
|
853
|
-
*
|
|
905
|
+
* Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
854
906
|
*/
|
|
855
907
|
export interface PortOverride {
|
|
856
908
|
/**
|
|
857
909
|
* <p>The listener port that you want to map to a specific endpoint port. This is the port that user traffic
|
|
858
|
-
*
|
|
910
|
+
* arrives to the Global Accelerator on.</p>
|
|
859
911
|
*/
|
|
860
912
|
ListenerPort?: number;
|
|
861
913
|
/**
|
|
862
914
|
* <p>The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint,
|
|
863
|
-
*
|
|
915
|
+
* such as the Application Load Balancer or Amazon EC2 instance.</p>
|
|
864
916
|
*/
|
|
865
917
|
EndpointPort?: number;
|
|
866
918
|
}
|
|
@@ -870,7 +922,7 @@ export interface CreateEndpointGroupRequest {
|
|
|
870
922
|
*/
|
|
871
923
|
ListenerArn: string | undefined;
|
|
872
924
|
/**
|
|
873
|
-
* <p>The
|
|
925
|
+
* <p>The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a
|
|
874
926
|
* specific Region.</p>
|
|
875
927
|
*/
|
|
876
928
|
EndpointGroupRegion: string | undefined;
|
|
@@ -879,7 +931,7 @@ export interface CreateEndpointGroupRequest {
|
|
|
879
931
|
*/
|
|
880
932
|
EndpointConfigurations?: EndpointConfiguration[];
|
|
881
933
|
/**
|
|
882
|
-
* <p>The percentage of traffic to send to an
|
|
934
|
+
* <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
|
|
883
935
|
* this listener. </p>
|
|
884
936
|
* <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
|
|
885
937
|
* applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p>
|
|
@@ -887,13 +939,13 @@ export interface CreateEndpointGroupRequest {
|
|
|
887
939
|
*/
|
|
888
940
|
TrafficDialPercentage?: number;
|
|
889
941
|
/**
|
|
890
|
-
* <p>The port that
|
|
891
|
-
*
|
|
942
|
+
* <p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port
|
|
943
|
+
* is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the
|
|
892
944
|
* first port in the list.</p>
|
|
893
945
|
*/
|
|
894
946
|
HealthCheckPort?: number;
|
|
895
947
|
/**
|
|
896
|
-
* <p>The protocol that
|
|
948
|
+
* <p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default
|
|
897
949
|
* value is TCP.</p>
|
|
898
950
|
*/
|
|
899
951
|
HealthCheckProtocol?: HealthCheckProtocol | string;
|
|
@@ -922,7 +974,7 @@ export interface CreateEndpointGroupRequest {
|
|
|
922
974
|
* receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
|
|
923
975
|
* and 1443, respectively, on the endpoints.</p>
|
|
924
976
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html">
|
|
925
|
-
*
|
|
977
|
+
* Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
926
978
|
*/
|
|
927
979
|
PortOverrides?: PortOverride[];
|
|
928
980
|
}
|
|
@@ -940,11 +992,11 @@ export interface EndpointDescription {
|
|
|
940
992
|
*/
|
|
941
993
|
EndpointId?: string;
|
|
942
994
|
/**
|
|
943
|
-
* <p>The weight associated with the endpoint. When you add weights to endpoints, you configure
|
|
995
|
+
* <p>The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic
|
|
944
996
|
* based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The
|
|
945
997
|
* result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second
|
|
946
|
-
* 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
|
|
947
|
-
*
|
|
998
|
+
* 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
|
|
999
|
+
* <i>Global Accelerator Developer Guide</i>. </p>
|
|
948
1000
|
*/
|
|
949
1001
|
Weight?: number;
|
|
950
1002
|
/**
|
|
@@ -956,17 +1008,20 @@ export interface EndpointDescription {
|
|
|
956
1008
|
*/
|
|
957
1009
|
HealthReason?: string;
|
|
958
1010
|
/**
|
|
959
|
-
* <p>Indicates whether client IP address preservation is enabled for an
|
|
1011
|
+
* <p>Indicates whether client IP address preservation is enabled for an endpoint.
|
|
960
1012
|
* The value is true or false. The default value is true for new accelerators. </p>
|
|
961
1013
|
* <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
|
|
962
|
-
* traffic travels to applications on the
|
|
963
|
-
*
|
|
964
|
-
*
|
|
1014
|
+
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
|
|
1015
|
+
*
|
|
1016
|
+
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
|
|
1017
|
+
* Balancers and Amazon EC2 instances.</p>
|
|
1018
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
|
|
1019
|
+
* Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
965
1020
|
*/
|
|
966
1021
|
ClientIPPreservationEnabled?: boolean;
|
|
967
1022
|
}
|
|
968
1023
|
/**
|
|
969
|
-
* <p>A complex type for the endpoint group. An
|
|
1024
|
+
* <p>A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.
|
|
970
1025
|
* </p>
|
|
971
1026
|
*/
|
|
972
1027
|
export interface EndpointGroup {
|
|
@@ -975,7 +1030,7 @@ export interface EndpointGroup {
|
|
|
975
1030
|
*/
|
|
976
1031
|
EndpointGroupArn?: string;
|
|
977
1032
|
/**
|
|
978
|
-
* <p>The
|
|
1033
|
+
* <p>The Amazon Web Services Region where the endpoint group is located.</p>
|
|
979
1034
|
*/
|
|
980
1035
|
EndpointGroupRegion?: string;
|
|
981
1036
|
/**
|
|
@@ -983,7 +1038,7 @@ export interface EndpointGroup {
|
|
|
983
1038
|
*/
|
|
984
1039
|
EndpointDescriptions?: EndpointDescription[];
|
|
985
1040
|
/**
|
|
986
|
-
* <p>The percentage of traffic to send to an
|
|
1041
|
+
* <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
|
|
987
1042
|
* this listener. </p>
|
|
988
1043
|
* <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
|
|
989
1044
|
* applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p>
|
|
@@ -994,7 +1049,7 @@ export interface EndpointGroup {
|
|
|
994
1049
|
* <p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p>
|
|
995
1050
|
*
|
|
996
1051
|
* <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a
|
|
997
|
-
*
|
|
1052
|
+
* list, Global Accelerator uses the first specified port in the list of ports.</p>
|
|
998
1053
|
*/
|
|
999
1054
|
HealthCheckPort?: number;
|
|
1000
1055
|
/**
|
|
@@ -1018,7 +1073,7 @@ export interface EndpointGroup {
|
|
|
1018
1073
|
ThresholdCount?: number;
|
|
1019
1074
|
/**
|
|
1020
1075
|
* <p>Allows you to override the destination ports used to route traffic to an endpoint.
|
|
1021
|
-
* Using a port override lets you
|
|
1076
|
+
* Using a port override lets you map a list of external destination ports (that your
|
|
1022
1077
|
* users send traffic to) to a list of internal destination ports that you want an application
|
|
1023
1078
|
* endpoint to receive traffic on. </p>
|
|
1024
1079
|
*/
|
|
@@ -1047,13 +1102,13 @@ export interface CreateListenerRequest {
|
|
|
1047
1102
|
* <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
|
|
1048
1103
|
* regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
|
|
1049
1104
|
* route each client to the same specific endpoint.</p>
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1105
|
+
* <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client
|
|
1106
|
+
* affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port,
|
|
1052
1107
|
* destination IP address, destination port, and protocol—to select the hash value, and then chooses the best
|
|
1053
1108
|
* endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not
|
|
1054
1109
|
* be always routed to the same endpoint because the hash value changes. </p>
|
|
1055
1110
|
* <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code>
|
|
1056
|
-
*
|
|
1111
|
+
* instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
|
|
1057
1112
|
* source (client) IP address and destination IP address—to select the hash value.</p>
|
|
1058
1113
|
* <p>The default value is <code>NONE</code>.</p>
|
|
1059
1114
|
*/
|
|
@@ -1084,13 +1139,13 @@ export interface Listener {
|
|
|
1084
1139
|
* <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
|
|
1085
1140
|
* regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
|
|
1086
1141
|
* route each client to the same specific endpoint.</p>
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1142
|
+
* <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client
|
|
1143
|
+
* affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port,
|
|
1089
1144
|
* destination IP address, destination port, and protocol—to select the hash value, and then chooses the best
|
|
1090
1145
|
* endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not
|
|
1091
1146
|
* be always routed to the same endpoint because the hash value changes. </p>
|
|
1092
1147
|
* <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code>
|
|
1093
|
-
*
|
|
1148
|
+
* instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
|
|
1094
1149
|
* source (client) IP address and destination IP address—to select the hash value.</p>
|
|
1095
1150
|
* <p>The default value is <code>NONE</code>.</p>
|
|
1096
1151
|
*/
|
|
@@ -1109,13 +1164,13 @@ export interface CustomRoutingAcceleratorAttributes {
|
|
|
1109
1164
|
/**
|
|
1110
1165
|
* <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
|
|
1111
1166
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
1112
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow
|
|
1113
|
-
*
|
|
1167
|
+
* <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
|
|
1168
|
+
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1114
1169
|
*/
|
|
1115
1170
|
FlowLogsEnabled?: boolean;
|
|
1116
1171
|
/**
|
|
1117
1172
|
* <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
|
|
1118
|
-
*
|
|
1173
|
+
* <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
|
|
1119
1174
|
* bucket.</p>
|
|
1120
1175
|
*/
|
|
1121
1176
|
FlowLogsS3Bucket?: string;
|
|
@@ -1345,7 +1400,7 @@ export interface DestinationPortMapping {
|
|
|
1345
1400
|
*/
|
|
1346
1401
|
EndpointId?: string;
|
|
1347
1402
|
/**
|
|
1348
|
-
* <p>The
|
|
1403
|
+
* <p>The Amazon Web Services Region for the endpoint group.</p>
|
|
1349
1404
|
*/
|
|
1350
1405
|
EndpointGroupRegion?: string;
|
|
1351
1406
|
/**
|
|
@@ -1353,7 +1408,7 @@ export interface DestinationPortMapping {
|
|
|
1353
1408
|
*/
|
|
1354
1409
|
DestinationSocketAddress?: SocketAddress;
|
|
1355
1410
|
/**
|
|
1356
|
-
* <p>The IP address type,
|
|
1411
|
+
* <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
|
|
1357
1412
|
*/
|
|
1358
1413
|
IpAddressType?: IpAddressType | string;
|
|
1359
1414
|
/**
|
|
@@ -1515,8 +1570,8 @@ export interface ListCustomRoutingPortMappingsRequest {
|
|
|
1515
1570
|
}
|
|
1516
1571
|
/**
|
|
1517
1572
|
* <p>Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual
|
|
1518
|
-
*
|
|
1519
|
-
*
|
|
1573
|
+
* private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that
|
|
1574
|
+
* statically associates port ranges with VPC subnets, which allows Global Accelerator to route to
|
|
1520
1575
|
* specific instances and ports within one or more subnets. </p>
|
|
1521
1576
|
*/
|
|
1522
1577
|
export interface PortMapping {
|
|
@@ -1706,12 +1761,12 @@ export interface UpdateAcceleratorRequest {
|
|
|
1706
1761
|
*/
|
|
1707
1762
|
AcceleratorArn: string | undefined;
|
|
1708
1763
|
/**
|
|
1709
|
-
* <p>The name of the accelerator. The name can have a maximum of
|
|
1710
|
-
* hyphens (-), and must not begin or end with a hyphen.</p>
|
|
1764
|
+
* <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
|
|
1765
|
+
* periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
|
|
1711
1766
|
*/
|
|
1712
1767
|
Name?: string;
|
|
1713
1768
|
/**
|
|
1714
|
-
* <p>The IP address type,
|
|
1769
|
+
* <p>The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.</p>
|
|
1715
1770
|
*/
|
|
1716
1771
|
IpAddressType?: IpAddressType | string;
|
|
1717
1772
|
/**
|
|
@@ -1735,20 +1790,20 @@ export interface UpdateAcceleratorAttributesRequest {
|
|
|
1735
1790
|
* <p>Update whether flow logs are enabled. The default value is false. If the value is true,
|
|
1736
1791
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
1737
1792
|
* <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
|
|
1738
|
-
*
|
|
1793
|
+
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1739
1794
|
*/
|
|
1740
1795
|
FlowLogsEnabled?: boolean;
|
|
1741
1796
|
/**
|
|
1742
1797
|
* <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
|
|
1743
|
-
*
|
|
1798
|
+
* <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
|
|
1744
1799
|
* bucket.</p>
|
|
1745
1800
|
*/
|
|
1746
1801
|
FlowLogsS3Bucket?: string;
|
|
1747
1802
|
/**
|
|
1748
1803
|
* <p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
|
|
1749
1804
|
* <code>FlowLogsEnabled</code> is <code>true</code>. </p>
|
|
1750
|
-
* <p>If you
|
|
1751
|
-
*
|
|
1805
|
+
* <p>If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//),
|
|
1806
|
+
* like the following:</p>
|
|
1752
1807
|
* <p>s3-bucket_name//AWSLogs/aws_account_id</p>
|
|
1753
1808
|
*/
|
|
1754
1809
|
FlowLogsS3Prefix?: string;
|
|
@@ -1765,12 +1820,12 @@ export interface UpdateCustomRoutingAcceleratorRequest {
|
|
|
1765
1820
|
*/
|
|
1766
1821
|
AcceleratorArn: string | undefined;
|
|
1767
1822
|
/**
|
|
1768
|
-
* <p>The name of the accelerator. The name can have a maximum of
|
|
1769
|
-
* hyphens (-), and must not begin or end with a hyphen.</p>
|
|
1823
|
+
* <p>The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters,
|
|
1824
|
+
* periods (.), or hyphens (-), and must not begin or end with a hyphen or period.</p>
|
|
1770
1825
|
*/
|
|
1771
1826
|
Name?: string;
|
|
1772
1827
|
/**
|
|
1773
|
-
* <p>The
|
|
1828
|
+
* <p>The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.</p>
|
|
1774
1829
|
*/
|
|
1775
1830
|
IpAddressType?: IpAddressType | string;
|
|
1776
1831
|
/**
|
|
@@ -1793,13 +1848,13 @@ export interface UpdateCustomRoutingAcceleratorAttributesRequest {
|
|
|
1793
1848
|
/**
|
|
1794
1849
|
* <p>Update whether flow logs are enabled. The default value is false. If the value is true,
|
|
1795
1850
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
1796
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html">Flow
|
|
1797
|
-
*
|
|
1851
|
+
* <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
|
|
1852
|
+
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1798
1853
|
*/
|
|
1799
1854
|
FlowLogsEnabled?: boolean;
|
|
1800
1855
|
/**
|
|
1801
1856
|
* <p>The name of the Amazon S3 bucket for the flow logs. Attribute is required if <code>FlowLogsEnabled</code> is
|
|
1802
|
-
*
|
|
1857
|
+
* <code>true</code>. The bucket must exist and have a bucket policy that grants Global Accelerator permission to write to the
|
|
1803
1858
|
* bucket.</p>
|
|
1804
1859
|
*/
|
|
1805
1860
|
FlowLogsS3Bucket?: string;
|
|
@@ -1847,7 +1902,7 @@ export interface UpdateEndpointGroupRequest {
|
|
|
1847
1902
|
*/
|
|
1848
1903
|
EndpointConfigurations?: EndpointConfiguration[];
|
|
1849
1904
|
/**
|
|
1850
|
-
* <p>The percentage of traffic to send to an
|
|
1905
|
+
* <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
|
|
1851
1906
|
* this listener. </p>
|
|
1852
1907
|
* <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
|
|
1853
1908
|
* applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p>
|
|
@@ -1855,13 +1910,13 @@ export interface UpdateEndpointGroupRequest {
|
|
|
1855
1910
|
*/
|
|
1856
1911
|
TrafficDialPercentage?: number;
|
|
1857
1912
|
/**
|
|
1858
|
-
* <p>The port that
|
|
1859
|
-
*
|
|
1913
|
+
* <p>The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port
|
|
1914
|
+
* is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses
|
|
1860
1915
|
* the first port in the list.</p>
|
|
1861
1916
|
*/
|
|
1862
1917
|
HealthCheckPort?: number;
|
|
1863
1918
|
/**
|
|
1864
|
-
* <p>The protocol that
|
|
1919
|
+
* <p>The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default
|
|
1865
1920
|
* value is TCP.</p>
|
|
1866
1921
|
*/
|
|
1867
1922
|
HealthCheckProtocol?: HealthCheckProtocol | string;
|
|
@@ -1885,7 +1940,7 @@ export interface UpdateEndpointGroupRequest {
|
|
|
1885
1940
|
* receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
|
|
1886
1941
|
* and 1443, respectively, on the endpoints.</p>
|
|
1887
1942
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html">
|
|
1888
|
-
*
|
|
1943
|
+
* Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1889
1944
|
*/
|
|
1890
1945
|
PortOverrides?: PortOverride[];
|
|
1891
1946
|
}
|
|
@@ -1912,13 +1967,13 @@ export interface UpdateListenerRequest {
|
|
|
1912
1967
|
* <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
|
|
1913
1968
|
* regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
|
|
1914
1969
|
* route each client to the same specific endpoint.</p>
|
|
1915
|
-
*
|
|
1916
|
-
*
|
|
1970
|
+
* <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client
|
|
1971
|
+
* affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port,
|
|
1917
1972
|
* destination IP address, destination port, and protocol—to select the hash value, and then chooses the best
|
|
1918
1973
|
* endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not
|
|
1919
1974
|
* be always routed to the same endpoint because the hash value changes. </p>
|
|
1920
1975
|
* <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code>
|
|
1921
|
-
*
|
|
1976
|
+
* instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
|
|
1922
1977
|
* source (client) IP address and destination IP address—to select the hash value.</p>
|
|
1923
1978
|
* <p>The default value is <code>NONE</code>.</p>
|
|
1924
1979
|
*/
|
|
@@ -1942,6 +1997,10 @@ export interface WithdrawByoipCidrResponse {
|
|
|
1942
1997
|
*/
|
|
1943
1998
|
ByoipCidr?: ByoipCidr;
|
|
1944
1999
|
}
|
|
2000
|
+
/**
|
|
2001
|
+
* @internal
|
|
2002
|
+
*/
|
|
2003
|
+
export declare const AcceleratorEventFilterSensitiveLog: (obj: AcceleratorEvent) => any;
|
|
1945
2004
|
/**
|
|
1946
2005
|
* @internal
|
|
1947
2006
|
*/
|