@aws-sdk/client-global-accelerator 3.387.0 → 3.388.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/README.md +1 -4
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/GlobalAccelerator.d.ts +12 -17
- package/dist-types/GlobalAcceleratorClient.d.ts +12 -17
- package/dist-types/commands/AddCustomRoutingEndpointsCommand.d.ts +3 -3
- package/dist-types/commands/AddEndpointsCommand.d.ts +9 -5
- package/dist-types/commands/AdvertiseByoipCidrCommand.d.ts +2 -2
- package/dist-types/commands/AllowCustomRoutingTrafficCommand.d.ts +1 -1
- package/dist-types/commands/CreateAcceleratorCommand.d.ts +4 -4
- package/dist-types/commands/CreateCustomRoutingAcceleratorCommand.d.ts +5 -5
- package/dist-types/commands/CreateEndpointGroupCommand.d.ts +3 -0
- package/dist-types/commands/DeleteAcceleratorCommand.d.ts +2 -2
- package/dist-types/commands/DeleteCustomRoutingAcceleratorCommand.d.ts +1 -1
- package/dist-types/commands/DenyCustomRoutingTrafficCommand.d.ts +1 -1
- package/dist-types/commands/DeprovisionByoipCidrCommand.d.ts +2 -2
- package/dist-types/commands/ListCustomRoutingPortMappingsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ProvisionByoipCidrCommand.d.ts +1 -1
- package/dist-types/commands/RemoveEndpointsCommand.d.ts +2 -2
- 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 +22 -6
- package/dist-types/commands/WithdrawByoipCidrCommand.d.ts +2 -2
- package/dist-types/index.d.ts +12 -17
- package/dist-types/models/models_0.d.ts +78 -85
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -28,22 +28,19 @@ can use application logic to directly map one or more users to a specific endpoi
|
|
|
28
28
|
<important>
|
|
29
29
|
<p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
30
30
|
US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
31
|
-
on
|
|
31
|
+
on Amazon Web Services CLI commands.</p>
|
|
32
32
|
</important>
|
|
33
|
-
|
|
34
33
|
<p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
35
34
|
are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
|
|
36
35
|
Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
|
|
37
36
|
With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
|
|
38
37
|
these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
|
|
39
|
-
|
|
40
38
|
<p>For a standard accelerator,
|
|
41
39
|
they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
|
|
42
40
|
the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
|
|
43
41
|
Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
|
|
44
42
|
accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
|
|
45
43
|
are virtual private cloud (VPC) subnets.</p>
|
|
46
|
-
|
|
47
44
|
<important>
|
|
48
45
|
<p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
|
|
49
46
|
disable the accelerator and it no longer accepts or routes traffic. However, when you
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://globalaccelerator-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://globalaccelerator-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://globalaccelerator.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://globalaccelerator.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://globalaccelerator-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://globalaccelerator-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://globalaccelerator.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://globalaccelerator.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -348,13 +348,13 @@ export interface GlobalAccelerator {
|
|
|
348
348
|
/**
|
|
349
349
|
* @public
|
|
350
350
|
* <fullname>Global Accelerator</fullname>
|
|
351
|
-
*
|
|
351
|
+
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
|
|
352
352
|
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
|
|
353
353
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
|
|
354
|
-
*
|
|
354
|
+
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
|
|
355
355
|
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
|
|
356
356
|
* gain additional benefits. </p>
|
|
357
|
-
*
|
|
357
|
+
* <ul>
|
|
358
358
|
* <li>
|
|
359
359
|
* <p>By using a standard accelerator, you can improve availability of your internet applications
|
|
360
360
|
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
|
|
@@ -365,28 +365,23 @@ export interface GlobalAccelerator {
|
|
|
365
365
|
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
|
|
366
366
|
* </li>
|
|
367
367
|
* </ul>
|
|
368
|
-
*
|
|
369
|
-
*
|
|
368
|
+
* <important>
|
|
369
|
+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
370
370
|
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
371
|
-
* on
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
371
|
+
* on Amazon Web Services CLI commands.</p>
|
|
372
|
+
* </important>
|
|
373
|
+
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
376
374
|
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
|
|
377
375
|
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
|
|
378
376
|
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
|
|
379
377
|
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
* <p>For a standard accelerator,
|
|
378
|
+
* <p>For a standard accelerator,
|
|
383
379
|
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
|
|
384
380
|
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
|
|
385
381
|
* Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
|
|
386
382
|
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
|
|
387
383
|
* are virtual private cloud (VPC) subnets.</p>
|
|
388
|
-
*
|
|
389
|
-
* <important>
|
|
384
|
+
* <important>
|
|
390
385
|
* <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
|
|
391
386
|
* disable the accelerator and it no longer accepts or routes traffic. However, when you
|
|
392
387
|
* <i>delete</i> an accelerator, you lose the static IP addresses that
|
|
@@ -394,11 +389,11 @@ export interface GlobalAccelerator {
|
|
|
394
389
|
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
|
|
395
390
|
* permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p>
|
|
396
391
|
* </important>
|
|
397
|
-
*
|
|
392
|
+
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
|
|
398
393
|
* on health, client location, and policies that you configure. The service reacts instantly to
|
|
399
394
|
* changes in health or configuration to ensure that internet traffic from clients is always
|
|
400
395
|
* directed to healthy endpoints.</p>
|
|
401
|
-
*
|
|
396
|
+
* <p>For more information about understanding and using Global Accelerator, see the
|
|
402
397
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
|
|
403
398
|
*/
|
|
404
399
|
export declare class GlobalAccelerator extends GlobalAcceleratorClient implements GlobalAccelerator {
|
|
@@ -195,13 +195,13 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
|
|
|
195
195
|
/**
|
|
196
196
|
* @public
|
|
197
197
|
* <fullname>Global Accelerator</fullname>
|
|
198
|
-
*
|
|
198
|
+
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
|
|
199
199
|
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
|
|
200
200
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
|
|
201
|
-
*
|
|
201
|
+
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
|
|
202
202
|
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
|
|
203
203
|
* gain additional benefits. </p>
|
|
204
|
-
*
|
|
204
|
+
* <ul>
|
|
205
205
|
* <li>
|
|
206
206
|
* <p>By using a standard accelerator, you can improve availability of your internet applications
|
|
207
207
|
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
|
|
@@ -212,28 +212,23 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
|
|
|
212
212
|
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
|
|
213
213
|
* </li>
|
|
214
214
|
* </ul>
|
|
215
|
-
*
|
|
216
|
-
*
|
|
215
|
+
* <important>
|
|
216
|
+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
217
217
|
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
218
|
-
* on
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
218
|
+
* on Amazon Web Services CLI commands.</p>
|
|
219
|
+
* </important>
|
|
220
|
+
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
223
221
|
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
|
|
224
222
|
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
|
|
225
223
|
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
|
|
226
224
|
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
* <p>For a standard accelerator,
|
|
225
|
+
* <p>For a standard accelerator,
|
|
230
226
|
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
|
|
231
227
|
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
|
|
232
228
|
* Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
|
|
233
229
|
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
|
|
234
230
|
* are virtual private cloud (VPC) subnets.</p>
|
|
235
|
-
*
|
|
236
|
-
* <important>
|
|
231
|
+
* <important>
|
|
237
232
|
* <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
|
|
238
233
|
* disable the accelerator and it no longer accepts or routes traffic. However, when you
|
|
239
234
|
* <i>delete</i> an accelerator, you lose the static IP addresses that
|
|
@@ -241,11 +236,11 @@ export interface GlobalAcceleratorClientResolvedConfig extends GlobalAccelerator
|
|
|
241
236
|
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
|
|
242
237
|
* permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p>
|
|
243
238
|
* </important>
|
|
244
|
-
*
|
|
239
|
+
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
|
|
245
240
|
* on health, client location, and policies that you configure. The service reacts instantly to
|
|
246
241
|
* changes in health or configuration to ensure that internet traffic from clients is always
|
|
247
242
|
* directed to healthy endpoints.</p>
|
|
248
|
-
*
|
|
243
|
+
* <p>For more information about understanding and using Global Accelerator, see the
|
|
249
244
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
|
|
250
245
|
*/
|
|
251
246
|
export declare class GlobalAcceleratorClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GlobalAcceleratorClientResolvedConfig> {
|
|
@@ -24,13 +24,13 @@ export interface AddCustomRoutingEndpointsCommandOutput extends AddCustomRouting
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>The listener port range must be large enough to support the number of IP addresses that can be
|
|
28
28
|
* specified in your subnet. The number of ports required is: subnet size times the number
|
|
29
29
|
* of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener
|
|
30
30
|
* port range of at least 255 ports. </p>
|
|
31
|
-
*
|
|
31
|
+
* <p>Note: You must have enough remaining listener ports available to
|
|
32
32
|
* map to the subnet ports, or the call will fail with a LimitExceededException.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all
|
|
34
34
|
* destinations to receive traffic, or to specify individual port mappings that can receive
|
|
35
35
|
* traffic, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html">
|
|
36
36
|
* AllowCustomRoutingTraffic</a> operation.</p>
|
|
@@ -28,17 +28,21 @@ export interface AddEndpointsCommandOutput extends AddEndpointsResponse, __Metad
|
|
|
28
28
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_CreateEndpointGroup.html">CreateEndpointGroup</a> API)
|
|
29
29
|
* or when you update an endpoint group (with the
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html">UpdateEndpointGroup</a> API). </p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* <p>There are two advantages to using <code>AddEndpoints</code> to add endpoints in Global Accelerator:</p>
|
|
32
|
+
* <ul>
|
|
33
33
|
* <li>
|
|
34
34
|
* <p>It's faster, because Global Accelerator only has to resolve the new endpoints that
|
|
35
|
-
* you're adding.</p>
|
|
35
|
+
* you're adding, rather than resolving new and existing endpoints.</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
* <p>It's more convenient, because you don't need to specify
|
|
39
|
-
* endpoints that are already in the endpoint group in addition to the new endpoints that
|
|
38
|
+
* <p>It's more convenient, because you don't need to specify the current
|
|
39
|
+
* endpoints that are already in the endpoint group, in addition to the new endpoints that
|
|
40
|
+
* you want to add.</p>
|
|
40
41
|
* </li>
|
|
41
42
|
* </ul>
|
|
43
|
+
* <p>For information about endpoint types and requirements for endpoints that you can add
|
|
44
|
+
* to Global Accelerator, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html">
|
|
45
|
+
* Endpoints for standard accelerators</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
42
46
|
* @example
|
|
43
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
48
|
* ```javascript
|
|
@@ -26,9 +26,9 @@ export interface AdvertiseByoipCidrCommandOutput extends AdvertiseByoipCidrRespo
|
|
|
26
26
|
* <p>Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources
|
|
27
27
|
* through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to
|
|
28
28
|
* the specified addresses starts routing to Amazon Web Services because of propagation delays. </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>To stop advertising the BYOIP address range, use <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">
|
|
30
30
|
* WithdrawByoipCidr</a>.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
|
|
32
32
|
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,7 +27,7 @@ export interface AllowCustomRoutingTrafficCommandOutput extends __MetadataBearer
|
|
|
27
27
|
* for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a
|
|
28
28
|
* specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports
|
|
29
29
|
* outside of the range that you configured for the endpoint group.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>After you make changes, you can verify that the updates are complete by checking the status of your
|
|
31
31
|
* accelerator: the status changes from IN_PROGRESS to DEPLOYED.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,11 +25,11 @@ export interface CreateAcceleratorCommandOutput extends CreateAcceleratorRespons
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic
|
|
27
27
|
* to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. </p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* <important>
|
|
29
|
+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
30
30
|
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
31
|
-
* on
|
|
32
|
-
*
|
|
31
|
+
* on Amazon Web Services CLI commands.</p>
|
|
32
|
+
* </important>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -25,15 +25,15 @@ export interface CreateCustomRoutingAcceleratorCommandOutput extends CreateCusto
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands
|
|
27
27
|
* of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive
|
|
29
29
|
* traffic. To enable all destinations to receive traffic, or to specify individual port
|
|
30
30
|
* mappings that can receive traffic, see the <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html">
|
|
31
31
|
* AllowCustomRoutingTraffic</a> operation.</p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <important>
|
|
33
|
+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
34
34
|
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
35
|
-
* on
|
|
36
|
-
*
|
|
35
|
+
* on Amazon Web Services CLI commands.</p>
|
|
36
|
+
* </important>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
39
|
* ```javascript
|
|
@@ -25,6 +25,9 @@ export interface CreateEndpointGroupCommandOutput extends CreateEndpointGroupRes
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services
|
|
27
27
|
* Region. A resource must be valid and active when you add it as an endpoint.</p>
|
|
28
|
+
* <p>For more information about endpoint types and requirements for endpoints that you can add
|
|
29
|
+
* to Global Accelerator, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints.html">
|
|
30
|
+
* Endpoints for standard accelerators</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
28
31
|
* @example
|
|
29
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
33
|
* ```javascript
|
|
@@ -25,11 +25,11 @@ export interface DeleteAcceleratorCommandOutput extends __MetadataBearer {
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources
|
|
27
27
|
* (listeners and endpoint groups). To disable the accelerator, update the accelerator to set <code>Enabled</code> to false.</p>
|
|
28
|
-
*
|
|
28
|
+
* <important>
|
|
29
29
|
* <p>When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
|
|
30
30
|
* Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
|
|
31
31
|
* </p>
|
|
32
|
-
*
|
|
32
|
+
* <p>The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and
|
|
33
33
|
* it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the
|
|
34
34
|
* static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.
|
|
35
35
|
* As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You
|
|
@@ -28,7 +28,7 @@ export interface DeleteCustomRoutingAcceleratorCommandOutput extends __MetadataB
|
|
|
28
28
|
* <important>
|
|
29
29
|
* <p>When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
|
|
30
30
|
* </p>
|
|
31
|
-
*
|
|
31
|
+
* <p>The IP
|
|
32
32
|
* addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and
|
|
33
33
|
* it no longer accepts or routes traffic. However, when you <i>delete</i> an accelerator, you lose the
|
|
34
34
|
* static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them.
|
|
@@ -27,7 +27,7 @@ export interface DenyCustomRoutingTrafficCommandOutput extends __MetadataBearer
|
|
|
27
27
|
* for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a
|
|
28
28
|
* specified list of destination IP addresses and ports. Note that you cannot specify IP addresses
|
|
29
29
|
* or ports outside of the range that you configured for the endpoint group.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>After you make changes, you can verify that the updates are complete by checking the status of your
|
|
31
31
|
* accelerator: the status changes from IN_PROGRESS to DEPLOYED.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,10 +25,10 @@ export interface DeprovisionByoipCidrCommandOutput extends DeprovisionByoipCidrR
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Releases the specified address range that you provisioned to use with your Amazon Web Services resources
|
|
27
27
|
* through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>Before you can release an address range, you must stop advertising it by using <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html">WithdrawByoipCidr</a> and you must not have
|
|
29
29
|
* any accelerators that are using static IP addresses allocated from its address range.
|
|
30
30
|
* </p>
|
|
31
|
-
*
|
|
31
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
32
32
|
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -30,7 +30,7 @@ export interface ListCustomRoutingPortMappingsCommandOutput extends ListCustomRo
|
|
|
30
30
|
* <p>If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to
|
|
31
31
|
* your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances
|
|
32
32
|
* in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>The mappings also include a flag for each destination denoting which destination IP addresses and
|
|
34
34
|
* ports are allowed or denied traffic.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,7 +24,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>List all tags for an accelerator. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
28
28
|
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>. </p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,7 +27,7 @@ export interface ProvisionByoipCidrCommandOutput extends ProvisionByoipCidrRespo
|
|
|
27
27
|
* addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned,
|
|
28
28
|
* it is ready to be advertised using <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html">
|
|
29
29
|
* AdvertiseByoipCidr</a>.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
|
|
31
31
|
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,11 +24,11 @@ export interface RemoveEndpointsCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Remove endpoints from an endpoint group. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>The <code>RemoveEndpoints</code> API operation is the recommended option for removing endpoints. The alternative is to remove
|
|
28
28
|
* endpoints by updating an endpoint group by using the
|
|
29
29
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/api/API_UpdateEndpointGroup.html">UpdateEndpointGroup</a>
|
|
30
30
|
* API operation. There are two advantages to using <code>AddEndpoints</code> to remove endpoints instead:</p>
|
|
31
|
-
*
|
|
31
|
+
* <ul>
|
|
32
32
|
* <li>
|
|
33
33
|
* <p>It's more convenient, because you only need to specify the endpoints that you want to remove. With the
|
|
34
34
|
* <code>UpdateEndpointGroup</code> API operation, you must specify all of the endpoints in the
|
|
@@ -24,7 +24,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Add tags to an accelerator resource. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
28
28
|
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>. </p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,7 +25,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value.
|
|
27
27
|
* The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
29
29
|
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,13 +23,29 @@ export interface UpdateAcceleratorCommandOutput extends UpdateAcceleratorRespons
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Update an accelerator
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
26
|
+
* <p>Update an accelerator to make changes, such as the following: </p>
|
|
27
|
+
* <ul>
|
|
28
|
+
* <li>
|
|
29
|
+
* <p>Change the name of the accelerator.</p>
|
|
30
|
+
* </li>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.</p>
|
|
33
|
+
* </li>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>Enable the accelerator, if it is disabled.</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* </ul>
|
|
41
|
+
* <p>Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no
|
|
42
|
+
* longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you
|
|
43
|
+
* can no longer route traffic by using them.</p>
|
|
44
|
+
* <important>
|
|
45
|
+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
30
46
|
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
31
|
-
* on
|
|
32
|
-
*
|
|
47
|
+
* on Amazon Web Services CLI commands.</p>
|
|
48
|
+
* </important>
|
|
33
49
|
* @example
|
|
34
50
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
51
|
* ```javascript
|
|
@@ -26,9 +26,9 @@ export interface WithdrawByoipCidrCommandOutput extends WithdrawByoipCidrRespons
|
|
|
26
26
|
* <p>Stops advertising an address range that is provisioned as an address pool.
|
|
27
27
|
* You can perform this operation at most once every 10 seconds, even if you specify different address
|
|
28
28
|
* ranges each time.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of
|
|
30
30
|
* propagation delays.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
|
|
32
32
|
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <fullname>Global Accelerator</fullname>
|
|
3
|
-
*
|
|
3
|
+
* <p>This is the <i>Global Accelerator API Reference</i>. This guide is for developers who need detailed information about
|
|
4
4
|
* Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the
|
|
5
5
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
|
|
6
|
-
*
|
|
6
|
+
* <p>Global Accelerator is a service in which you create <i>accelerators</i> to improve the performance
|
|
7
7
|
* of your applications for local and global users. Depending on the type of accelerator you choose, you can
|
|
8
8
|
* gain additional benefits. </p>
|
|
9
|
-
*
|
|
9
|
+
* <ul>
|
|
10
10
|
* <li>
|
|
11
11
|
* <p>By using a standard accelerator, you can improve availability of your internet applications
|
|
12
12
|
* that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the Amazon Web Services
|
|
@@ -17,28 +17,23 @@
|
|
|
17
17
|
* can use application logic to directly map one or more users to a specific endpoint among many endpoints.</p>
|
|
18
18
|
* </li>
|
|
19
19
|
* </ul>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <important>
|
|
21
|
+
* <p>Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the
|
|
22
22
|
* US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify <code>--region us-west-2</code>
|
|
23
|
-
* on
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
23
|
+
* on Amazon Web Services CLI commands.</p>
|
|
24
|
+
* </important>
|
|
25
|
+
* <p>By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses
|
|
28
26
|
* are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack,
|
|
29
27
|
* Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses.
|
|
30
28
|
* With a standard accelerator for IPv4, instead of using the addresses that Global Accelerator provides, you can configure
|
|
31
29
|
* these entry points to be IPv4 addresses from your own IP address ranges that you bring toGlobal Accelerator (BYOIP). </p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* <p>For a standard accelerator,
|
|
30
|
+
* <p>For a standard accelerator,
|
|
35
31
|
* they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services Regions , which increases
|
|
36
32
|
* the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers,
|
|
37
33
|
* Amazon EC2 instances, or Elastic IP addresses that are located in one Amazon Web Services Region or multiple Amazon Web Services Regions. For custom routing
|
|
38
34
|
* accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that
|
|
39
35
|
* are virtual private cloud (VPC) subnets.</p>
|
|
40
|
-
*
|
|
41
|
-
* <important>
|
|
36
|
+
* <important>
|
|
42
37
|
* <p>The static IP addresses remain assigned to your accelerator for as long as it exists, even if you
|
|
43
38
|
* disable the accelerator and it no longer accepts or routes traffic. However, when you
|
|
44
39
|
* <i>delete</i> an accelerator, you lose the static IP addresses that
|
|
@@ -46,11 +41,11 @@
|
|
|
46
41
|
* IAM policies like tag-based permissions with Global Accelerator to limit the users who have
|
|
47
42
|
* permissions to delete an accelerator. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/access-control-manage-access-tag-policies.html">Tag-based policies</a>.</p>
|
|
48
43
|
* </important>
|
|
49
|
-
*
|
|
44
|
+
* <p>For standard accelerators, Global Accelerator uses the Amazon Web Services global network to route traffic to the optimal regional endpoint based
|
|
50
45
|
* on health, client location, and policies that you configure. The service reacts instantly to
|
|
51
46
|
* changes in health or configuration to ensure that internet traffic from clients is always
|
|
52
47
|
* directed to healthy endpoints.</p>
|
|
53
|
-
*
|
|
48
|
+
* <p>For more information about understanding and using Global Accelerator, see the
|
|
54
49
|
* <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
|
|
55
50
|
*
|
|
56
51
|
* @packageDocumentation
|
|
@@ -104,7 +104,7 @@ export interface Accelerator {
|
|
|
104
104
|
/**
|
|
105
105
|
* @public
|
|
106
106
|
* <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p>
|
|
107
|
-
*
|
|
107
|
+
* <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
|
|
108
108
|
*/
|
|
109
109
|
Enabled?: boolean;
|
|
110
110
|
/**
|
|
@@ -115,12 +115,12 @@ export interface Accelerator {
|
|
|
115
115
|
/**
|
|
116
116
|
* @public
|
|
117
117
|
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses.</p>
|
|
118
|
-
*
|
|
118
|
+
* <p>The naming convention for the DNS name for an accelerator is the following: A lowercase letter a,
|
|
119
119
|
* followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
|
|
120
120
|
* a1234567890abcdef.awsglobalaccelerator.com.</p>
|
|
121
121
|
* <p>If you have a dual-stack accelerator, you also have a second DNS name, <code>DualStackDnsName</code>, that points to both
|
|
122
122
|
* the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.</p>
|
|
123
|
-
*
|
|
123
|
+
* <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">
|
|
124
124
|
* Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
125
125
|
*/
|
|
126
126
|
DnsName?: string;
|
|
@@ -143,11 +143,11 @@ export interface Accelerator {
|
|
|
143
143
|
* @public
|
|
144
144
|
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses:
|
|
145
145
|
* two IPv4 addresses and two IPv6 addresses.</p>
|
|
146
|
-
*
|
|
146
|
+
* <p>The naming convention for the dual-stack DNS name is the following: A lowercase letter a,
|
|
147
147
|
* followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example:
|
|
148
148
|
* a1234567890abcdef.dualstack.awsglobalaccelerator.com.</p>
|
|
149
|
-
*
|
|
150
|
-
*
|
|
149
|
+
* <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>
|
|
150
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing">
|
|
151
151
|
* Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
152
152
|
*/
|
|
153
153
|
DualStackDnsName?: string;
|
|
@@ -166,7 +166,7 @@ export interface AcceleratorAttributes {
|
|
|
166
166
|
* @public
|
|
167
167
|
* <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
|
|
168
168
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
169
|
-
*
|
|
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
|
|
170
170
|
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
171
171
|
*/
|
|
172
172
|
FlowLogsEnabled?: boolean;
|
|
@@ -181,8 +181,8 @@ export interface AcceleratorAttributes {
|
|
|
181
181
|
* @public
|
|
182
182
|
* <p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
|
|
183
183
|
* <code>FlowLogsEnabled</code> is <code>true</code>.</p>
|
|
184
|
-
*
|
|
185
|
-
*
|
|
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>
|
|
185
|
+
* <p>s3-bucket_name//AWSLogs/aws_account_id</p>
|
|
186
186
|
*/
|
|
187
187
|
FlowLogsS3Prefix?: string;
|
|
188
188
|
}
|
|
@@ -369,7 +369,7 @@ export interface EndpointConfiguration {
|
|
|
369
369
|
* Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
|
|
370
370
|
* allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active
|
|
371
371
|
* when you add it as an endpoint.</p>
|
|
372
|
-
*
|
|
372
|
+
* <p>An Application Load Balancer can be either internal or internet-facing.</p>
|
|
373
373
|
*/
|
|
374
374
|
EndpointId?: string;
|
|
375
375
|
/**
|
|
@@ -385,14 +385,11 @@ export interface EndpointConfiguration {
|
|
|
385
385
|
* @public
|
|
386
386
|
* <p>Indicates whether client IP address preservation is enabled for an endpoint.
|
|
387
387
|
* The value is true or false. The default value is true for new accelerators. </p>
|
|
388
|
-
*
|
|
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
|
|
389
389
|
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
|
|
390
|
+
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
|
|
393
391
|
* Balancers and Amazon EC2 instances.</p>
|
|
394
|
-
*
|
|
395
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
|
|
392
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
|
|
396
393
|
* Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
397
394
|
*/
|
|
398
395
|
ClientIPPreservationEnabled?: boolean;
|
|
@@ -436,7 +433,7 @@ export interface EndpointDescription {
|
|
|
436
433
|
* <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
|
|
437
434
|
* Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
|
|
438
435
|
* allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p>
|
|
439
|
-
*
|
|
436
|
+
* <p>An Application Load Balancer can be either internal or internet-facing.</p>
|
|
440
437
|
*/
|
|
441
438
|
EndpointId?: string;
|
|
442
439
|
/**
|
|
@@ -462,13 +459,11 @@ export interface EndpointDescription {
|
|
|
462
459
|
* @public
|
|
463
460
|
* <p>Indicates whether client IP address preservation is enabled for an endpoint.
|
|
464
461
|
* The value is true or false. The default value is true for new accelerators. </p>
|
|
465
|
-
*
|
|
462
|
+
* <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
|
|
466
463
|
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
|
|
467
|
-
*
|
|
468
|
-
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
|
|
464
|
+
* <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load
|
|
469
465
|
* Balancers and Amazon EC2 instances.</p>
|
|
470
|
-
*
|
|
471
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
|
|
466
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html">
|
|
472
467
|
* Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
473
468
|
*/
|
|
474
469
|
ClientIPPreservationEnabled?: boolean;
|
|
@@ -557,8 +552,8 @@ export type ByoipCidrState = (typeof ByoipCidrState)[keyof typeof ByoipCidrState
|
|
|
557
552
|
* @public
|
|
558
553
|
* <p>Information about an IP address range that is provisioned for use with your Amazon Web Services resources through
|
|
559
554
|
* bring your own IP address (BYOIP).</p>
|
|
560
|
-
*
|
|
561
|
-
*
|
|
555
|
+
* <p>The following describes each BYOIP <code>State</code> that your IP address range can be in.</p>
|
|
556
|
+
* <ul>
|
|
562
557
|
* <li>
|
|
563
558
|
* <p>
|
|
564
559
|
* <b>PENDING_PROVISIONING</b> —
|
|
@@ -699,7 +694,7 @@ export interface AllowCustomRoutingTrafficRequest {
|
|
|
699
694
|
* @public
|
|
700
695
|
* <p>A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive
|
|
701
696
|
* traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.</p>
|
|
702
|
-
*
|
|
697
|
+
* <p>
|
|
703
698
|
* <code>DestinationAddresses</code> is required if <code>AllowAllTrafficToEndpoint</code> is <code>FALSE</code> or is
|
|
704
699
|
* not specified.</p>
|
|
705
700
|
*/
|
|
@@ -713,12 +708,12 @@ export interface AllowCustomRoutingTrafficRequest {
|
|
|
713
708
|
* @public
|
|
714
709
|
* <p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic
|
|
715
710
|
* from a custom routing accelerator. The value is TRUE or FALSE. </p>
|
|
716
|
-
*
|
|
711
|
+
* <p>When set to TRUE, <i>all</i> destinations in the custom routing VPC subnet can receive traffic. Note
|
|
717
712
|
* that you cannot specify destination IP addresses and ports when the value is set to TRUE.</p>
|
|
718
|
-
*
|
|
713
|
+
* <p>When set to FALSE (or not specified), you <i>must</i> specify a list of destination IP addresses that are allowed
|
|
719
714
|
* 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
|
|
720
715
|
* the same as the ports configured for the endpoint group.</p>
|
|
721
|
-
*
|
|
716
|
+
* <p>The default value is FALSE.</p>
|
|
722
717
|
*/
|
|
723
718
|
AllowAllTrafficToEndpoint?: boolean;
|
|
724
719
|
}
|
|
@@ -754,7 +749,7 @@ export declare class AssociatedListenerFoundException extends __BaseException {
|
|
|
754
749
|
* @public
|
|
755
750
|
* <p>Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services
|
|
756
751
|
* account using bring your own IP addresses (BYOIP). </p>
|
|
757
|
-
*
|
|
752
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring your own
|
|
758
753
|
* IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
759
754
|
*/
|
|
760
755
|
export interface CidrAuthorizationContext {
|
|
@@ -816,22 +811,22 @@ export interface CreateAcceleratorRequest {
|
|
|
816
811
|
* @public
|
|
817
812
|
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
|
|
818
813
|
* from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
|
|
819
|
-
*
|
|
814
|
+
* <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
|
|
820
815
|
* When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns
|
|
821
816
|
* you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges
|
|
822
817
|
* to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is
|
|
823
818
|
* because Global Accelerator assigns each address range to a different network zone, for high availability.</p>
|
|
824
|
-
*
|
|
825
|
-
*
|
|
819
|
+
* <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p>
|
|
820
|
+
* <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new
|
|
826
821
|
* accelerator with the new addresses.</p>
|
|
827
|
-
*
|
|
822
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
828
823
|
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
829
824
|
*/
|
|
830
825
|
IpAddresses?: string[];
|
|
831
826
|
/**
|
|
832
827
|
* @public
|
|
833
828
|
* <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
|
|
834
|
-
*
|
|
829
|
+
* <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
|
|
835
830
|
*/
|
|
836
831
|
Enabled?: boolean;
|
|
837
832
|
/**
|
|
@@ -843,7 +838,7 @@ export interface CreateAcceleratorRequest {
|
|
|
843
838
|
/**
|
|
844
839
|
* @public
|
|
845
840
|
* <p>Create tags for an accelerator.</p>
|
|
846
|
-
*
|
|
841
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
847
842
|
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
848
843
|
*/
|
|
849
844
|
Tags?: Tag[];
|
|
@@ -877,22 +872,22 @@ export interface CreateCustomRoutingAcceleratorRequest {
|
|
|
877
872
|
* @public
|
|
878
873
|
* <p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address
|
|
879
874
|
* from your own pool to use for the accelerator's static IPv4 address when you create an accelerator. </p>
|
|
880
|
-
*
|
|
875
|
+
* <p>After you bring an address range to Amazon Web Services, it appears in your account as an address pool.
|
|
881
876
|
* When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns
|
|
882
877
|
* you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges
|
|
883
878
|
* to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is
|
|
884
879
|
* because Global Accelerator assigns each address range to a different network zone, for high availability.</p>
|
|
885
|
-
*
|
|
886
|
-
*
|
|
880
|
+
* <p>You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p>
|
|
881
|
+
* <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new
|
|
887
882
|
* accelerator with the new addresses.</p>
|
|
888
|
-
*
|
|
883
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html">Bring
|
|
889
884
|
* your own IP addresses (BYOIP)</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
890
885
|
*/
|
|
891
886
|
IpAddresses?: string[];
|
|
892
887
|
/**
|
|
893
888
|
* @public
|
|
894
889
|
* <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
|
|
895
|
-
*
|
|
890
|
+
* <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
|
|
896
891
|
*/
|
|
897
892
|
Enabled?: boolean;
|
|
898
893
|
/**
|
|
@@ -904,7 +899,7 @@ export interface CreateCustomRoutingAcceleratorRequest {
|
|
|
904
899
|
/**
|
|
905
900
|
* @public
|
|
906
901
|
* <p>Create tags for an accelerator.</p>
|
|
907
|
-
*
|
|
902
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html">Tagging
|
|
908
903
|
* in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
909
904
|
*/
|
|
910
905
|
Tags?: Tag[];
|
|
@@ -945,7 +940,7 @@ export interface CustomRoutingAccelerator {
|
|
|
945
940
|
/**
|
|
946
941
|
* @public
|
|
947
942
|
* <p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p>
|
|
948
|
-
*
|
|
943
|
+
* <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>
|
|
949
944
|
*/
|
|
950
945
|
Enabled?: boolean;
|
|
951
946
|
/**
|
|
@@ -956,13 +951,12 @@ export interface CustomRoutingAccelerator {
|
|
|
956
951
|
/**
|
|
957
952
|
* @public
|
|
958
953
|
* <p>The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. </p>
|
|
959
|
-
*
|
|
954
|
+
* <p>The naming convention for the DNS name is the following: A lowercase letter a,
|
|
960
955
|
* followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example:
|
|
961
956
|
* a1234567890abcdef.awsglobalaccelerator.com.</p>
|
|
962
|
-
*
|
|
963
|
-
* <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
|
|
957
|
+
* <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
|
|
964
958
|
* and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.</p>
|
|
965
|
-
*
|
|
959
|
+
* <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">
|
|
966
960
|
* Support for DNS addressing in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
967
961
|
*/
|
|
968
962
|
DnsName?: string;
|
|
@@ -1194,7 +1188,7 @@ export interface CreateCustomRoutingListenerRequest {
|
|
|
1194
1188
|
/**
|
|
1195
1189
|
* @public
|
|
1196
1190
|
* <p>The port range to support for connections from clients to your accelerator.</p>
|
|
1197
|
-
*
|
|
1191
|
+
* <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
|
|
1198
1192
|
* endpoints for custom routing accelerators</a>.</p>
|
|
1199
1193
|
*/
|
|
1200
1194
|
PortRanges: PortRange[] | undefined;
|
|
@@ -1218,7 +1212,7 @@ export interface CustomRoutingListener {
|
|
|
1218
1212
|
/**
|
|
1219
1213
|
* @public
|
|
1220
1214
|
* <p>The port range to support for connections from clients to your accelerator.</p>
|
|
1221
|
-
*
|
|
1215
|
+
* <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
|
|
1222
1216
|
* endpoints for custom routing accelerators</a>.</p>
|
|
1223
1217
|
*/
|
|
1224
1218
|
PortRanges?: PortRange[];
|
|
@@ -1252,7 +1246,7 @@ export type HealthCheckProtocol = (typeof HealthCheckProtocol)[keyof typeof Heal
|
|
|
1252
1246
|
* For example, you can create a port override in which the listener
|
|
1253
1247
|
* receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
|
|
1254
1248
|
* and 1443, respectively, on the endpoints.</p>
|
|
1255
|
-
*
|
|
1249
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html">
|
|
1256
1250
|
* Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1257
1251
|
*/
|
|
1258
1252
|
export interface PortOverride {
|
|
@@ -1293,9 +1287,9 @@ export interface CreateEndpointGroupRequest {
|
|
|
1293
1287
|
* @public
|
|
1294
1288
|
* <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
|
|
1295
1289
|
* this listener. </p>
|
|
1296
|
-
*
|
|
1290
|
+
* <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
|
|
1297
1291
|
* applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p>
|
|
1298
|
-
*
|
|
1292
|
+
* <p>The default value is 100.</p>
|
|
1299
1293
|
*/
|
|
1300
1294
|
TrafficDialPercentage?: number;
|
|
1301
1295
|
/**
|
|
@@ -1340,7 +1334,7 @@ export interface CreateEndpointGroupRequest {
|
|
|
1340
1334
|
* For example, you can create a port override in which the listener
|
|
1341
1335
|
* receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
|
|
1342
1336
|
* and 1443, respectively, on the endpoints.</p>
|
|
1343
|
-
*
|
|
1337
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html">
|
|
1344
1338
|
* Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1345
1339
|
*/
|
|
1346
1340
|
PortOverrides?: PortOverride[];
|
|
@@ -1370,16 +1364,15 @@ export interface EndpointGroup {
|
|
|
1370
1364
|
* @public
|
|
1371
1365
|
* <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
|
|
1372
1366
|
* this listener. </p>
|
|
1373
|
-
*
|
|
1367
|
+
* <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
|
|
1374
1368
|
* applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p>
|
|
1375
|
-
*
|
|
1369
|
+
* <p>The default value is 100.</p>
|
|
1376
1370
|
*/
|
|
1377
1371
|
TrafficDialPercentage?: number;
|
|
1378
1372
|
/**
|
|
1379
1373
|
* @public
|
|
1380
1374
|
* <p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p>
|
|
1381
|
-
*
|
|
1382
|
-
* <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a
|
|
1375
|
+
* <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a
|
|
1383
1376
|
* list, Global Accelerator uses the first specified port in the list of ports.</p>
|
|
1384
1377
|
*/
|
|
1385
1378
|
HealthCheckPort?: number;
|
|
@@ -1449,15 +1442,15 @@ export interface CreateListenerRequest {
|
|
|
1449
1442
|
* <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
|
|
1450
1443
|
* regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
|
|
1451
1444
|
* route each client to the same specific endpoint.</p>
|
|
1452
|
-
*
|
|
1445
|
+
* <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client
|
|
1453
1446
|
* affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port,
|
|
1454
1447
|
* destination IP address, destination port, and protocol—to select the hash value, and then chooses the best
|
|
1455
1448
|
* endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not
|
|
1456
1449
|
* be always routed to the same endpoint because the hash value changes. </p>
|
|
1457
|
-
*
|
|
1450
|
+
* <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code>
|
|
1458
1451
|
* instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
|
|
1459
1452
|
* source (client) IP address and destination IP address—to select the hash value.</p>
|
|
1460
|
-
*
|
|
1453
|
+
* <p>The default value is <code>NONE</code>.</p>
|
|
1461
1454
|
*/
|
|
1462
1455
|
ClientAffinity?: ClientAffinity | string;
|
|
1463
1456
|
/**
|
|
@@ -1492,15 +1485,15 @@ export interface Listener {
|
|
|
1492
1485
|
* <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
|
|
1493
1486
|
* regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
|
|
1494
1487
|
* route each client to the same specific endpoint.</p>
|
|
1495
|
-
*
|
|
1488
|
+
* <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client
|
|
1496
1489
|
* affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port,
|
|
1497
1490
|
* destination IP address, destination port, and protocol—to select the hash value, and then chooses the best
|
|
1498
1491
|
* endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not
|
|
1499
1492
|
* be always routed to the same endpoint because the hash value changes. </p>
|
|
1500
|
-
*
|
|
1493
|
+
* <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code>
|
|
1501
1494
|
* instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
|
|
1502
1495
|
* source (client) IP address and destination IP address—to select the hash value.</p>
|
|
1503
|
-
*
|
|
1496
|
+
* <p>The default value is <code>NONE</code>.</p>
|
|
1504
1497
|
*/
|
|
1505
1498
|
ClientAffinity?: ClientAffinity | string;
|
|
1506
1499
|
}
|
|
@@ -1523,7 +1516,7 @@ export interface CustomRoutingAcceleratorAttributes {
|
|
|
1523
1516
|
* @public
|
|
1524
1517
|
* <p>Indicates whether flow logs are enabled. The default value is false. If the value is true,
|
|
1525
1518
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
1526
|
-
*
|
|
1519
|
+
* <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
|
|
1527
1520
|
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
1528
1521
|
*/
|
|
1529
1522
|
FlowLogsEnabled?: boolean;
|
|
@@ -1538,9 +1531,9 @@ export interface CustomRoutingAcceleratorAttributes {
|
|
|
1538
1531
|
* @public
|
|
1539
1532
|
* <p>The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
|
|
1540
1533
|
* <code>FlowLogsEnabled</code> is <code>true</code>.</p>
|
|
1541
|
-
*
|
|
1534
|
+
* <p>If you don’t specify a prefix, the flow logs are stored in the
|
|
1542
1535
|
* 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>
|
|
1543
|
-
*
|
|
1536
|
+
* <p>DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id</p>
|
|
1544
1537
|
*/
|
|
1545
1538
|
FlowLogsS3Prefix?: string;
|
|
1546
1539
|
}
|
|
@@ -1647,12 +1640,12 @@ export interface DenyCustomRoutingTrafficRequest {
|
|
|
1647
1640
|
* @public
|
|
1648
1641
|
* <p>Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint <i>cannot</i>
|
|
1649
1642
|
* receive traffic from a custom routing accelerator. The value is TRUE or FALSE. </p>
|
|
1650
|
-
*
|
|
1643
|
+
* <p>When set to TRUE, <i>no</i> destinations in the custom routing VPC subnet can receive traffic. Note
|
|
1651
1644
|
* that you cannot specify destination IP addresses and ports when the value is set to TRUE.</p>
|
|
1652
|
-
*
|
|
1645
|
+
* <p>When set to FALSE (or not specified), you <i>must</i> specify a list of destination IP addresses that cannot receive
|
|
1653
1646
|
* traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is
|
|
1654
1647
|
* the same as the ports configured for the endpoint group.</p>
|
|
1655
|
-
*
|
|
1648
|
+
* <p>The default value is FALSE.</p>
|
|
1656
1649
|
*/
|
|
1657
1650
|
DenyAllTrafficToEndpoint?: boolean;
|
|
1658
1651
|
}
|
|
@@ -1912,13 +1905,13 @@ export interface EndpointIdentifier {
|
|
|
1912
1905
|
* <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon
|
|
1913
1906
|
* Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address
|
|
1914
1907
|
* allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p>
|
|
1915
|
-
*
|
|
1908
|
+
* <p>An Application Load Balancer can be either internal or internet-facing.</p>
|
|
1916
1909
|
*/
|
|
1917
1910
|
EndpointId: string | undefined;
|
|
1918
1911
|
/**
|
|
1919
1912
|
* @public
|
|
1920
1913
|
* <p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. </p>
|
|
1921
|
-
*
|
|
1914
|
+
* <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
|
|
1922
1915
|
* traffic travels to applications on the endpoint fronted by the accelerator.</p>
|
|
1923
1916
|
*/
|
|
1924
1917
|
ClientIPPreservationEnabled?: boolean;
|
|
@@ -2444,7 +2437,7 @@ export interface UpdateAcceleratorRequest {
|
|
|
2444
2437
|
/**
|
|
2445
2438
|
* @public
|
|
2446
2439
|
* <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
|
|
2447
|
-
*
|
|
2440
|
+
* <p>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
|
|
2448
2441
|
*/
|
|
2449
2442
|
Enabled?: boolean;
|
|
2450
2443
|
}
|
|
@@ -2471,7 +2464,7 @@ export interface UpdateAcceleratorAttributesRequest {
|
|
|
2471
2464
|
* @public
|
|
2472
2465
|
* <p>Update whether flow logs are enabled. The default value is false. If the value is true,
|
|
2473
2466
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
2474
|
-
*
|
|
2467
|
+
* <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
|
|
2475
2468
|
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
2476
2469
|
*/
|
|
2477
2470
|
FlowLogsEnabled?: boolean;
|
|
@@ -2486,9 +2479,9 @@ export interface UpdateAcceleratorAttributesRequest {
|
|
|
2486
2479
|
* @public
|
|
2487
2480
|
* <p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
|
|
2488
2481
|
* <code>FlowLogsEnabled</code> is <code>true</code>. </p>
|
|
2489
|
-
*
|
|
2482
|
+
* <p>If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//),
|
|
2490
2483
|
* like the following:</p>
|
|
2491
|
-
*
|
|
2484
|
+
* <p>s3-bucket_name//AWSLogs/aws_account_id</p>
|
|
2492
2485
|
*/
|
|
2493
2486
|
FlowLogsS3Prefix?: string;
|
|
2494
2487
|
}
|
|
@@ -2525,7 +2518,7 @@ export interface UpdateCustomRoutingAcceleratorRequest {
|
|
|
2525
2518
|
/**
|
|
2526
2519
|
* @public
|
|
2527
2520
|
* <p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p>
|
|
2528
|
-
*
|
|
2521
|
+
* <p>If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>
|
|
2529
2522
|
*/
|
|
2530
2523
|
Enabled?: boolean;
|
|
2531
2524
|
}
|
|
@@ -2552,7 +2545,7 @@ export interface UpdateCustomRoutingAcceleratorAttributesRequest {
|
|
|
2552
2545
|
* @public
|
|
2553
2546
|
* <p>Update whether flow logs are enabled. The default value is false. If the value is true,
|
|
2554
2547
|
* <code>FlowLogsS3Bucket</code> and <code>FlowLogsS3Prefix</code> must be specified.</p>
|
|
2555
|
-
*
|
|
2548
|
+
* <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
|
|
2556
2549
|
* the <i>Global Accelerator Developer Guide</i>.</p>
|
|
2557
2550
|
*/
|
|
2558
2551
|
FlowLogsEnabled?: boolean;
|
|
@@ -2567,9 +2560,9 @@ export interface UpdateCustomRoutingAcceleratorAttributesRequest {
|
|
|
2567
2560
|
* @public
|
|
2568
2561
|
* <p>Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
|
|
2569
2562
|
* <code>FlowLogsEnabled</code> is <code>true</code>. </p>
|
|
2570
|
-
*
|
|
2563
|
+
* <p>If you don’t specify a prefix, the flow logs are stored in the
|
|
2571
2564
|
* 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>
|
|
2572
|
-
*
|
|
2565
|
+
* <p>DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id</p>
|
|
2573
2566
|
*/
|
|
2574
2567
|
FlowLogsS3Prefix?: string;
|
|
2575
2568
|
}
|
|
@@ -2596,7 +2589,7 @@ export interface UpdateCustomRoutingListenerRequest {
|
|
|
2596
2589
|
* @public
|
|
2597
2590
|
* <p>The updated port range to support for connections from clients to your accelerator. If you remove ports that are
|
|
2598
2591
|
* currently being used by a subnet endpoint, the call fails.</p>
|
|
2599
|
-
*
|
|
2592
|
+
* <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
|
|
2600
2593
|
* endpoints for custom routing accelerators</a>.</p>
|
|
2601
2594
|
*/
|
|
2602
2595
|
PortRanges: PortRange[] | undefined;
|
|
@@ -2629,9 +2622,9 @@ export interface UpdateEndpointGroupRequest {
|
|
|
2629
2622
|
* @public
|
|
2630
2623
|
* <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for
|
|
2631
2624
|
* this listener. </p>
|
|
2632
|
-
*
|
|
2625
|
+
* <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
|
|
2633
2626
|
* applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p>
|
|
2634
|
-
*
|
|
2627
|
+
* <p>The default value is 100.</p>
|
|
2635
2628
|
*/
|
|
2636
2629
|
TrafficDialPercentage?: number;
|
|
2637
2630
|
/**
|
|
@@ -2670,7 +2663,7 @@ export interface UpdateEndpointGroupRequest {
|
|
|
2670
2663
|
* For example, you can create a port override in which the listener
|
|
2671
2664
|
* receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080
|
|
2672
2665
|
* and 1443, respectively, on the endpoints.</p>
|
|
2673
|
-
*
|
|
2666
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html">
|
|
2674
2667
|
* Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
|
|
2675
2668
|
*/
|
|
2676
2669
|
PortOverrides?: PortOverride[];
|
|
@@ -2709,15 +2702,15 @@ export interface UpdateListenerRequest {
|
|
|
2709
2702
|
* <p>Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
|
|
2710
2703
|
* regardless of the port and protocol of the client request. Client affinity gives you control over whether to always
|
|
2711
2704
|
* route each client to the same specific endpoint.</p>
|
|
2712
|
-
*
|
|
2705
|
+
* <p>Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client
|
|
2713
2706
|
* affinity is <code>NONE</code>, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port,
|
|
2714
2707
|
* destination IP address, destination port, and protocol—to select the hash value, and then chooses the best
|
|
2715
2708
|
* endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not
|
|
2716
2709
|
* be always routed to the same endpoint because the hash value changes. </p>
|
|
2717
|
-
*
|
|
2710
|
+
* <p>If you want a given client to always be routed to the same endpoint, set client affinity to <code>SOURCE_IP</code>
|
|
2718
2711
|
* instead. When you use the <code>SOURCE_IP</code> setting, Global Accelerator uses the "two-tuple" (2-tuple) properties—
|
|
2719
2712
|
* source (client) IP address and destination IP address—to select the hash value.</p>
|
|
2720
|
-
*
|
|
2713
|
+
* <p>The default value is <code>NONE</code>.</p>
|
|
2721
2714
|
*/
|
|
2722
2715
|
ClientAffinity?: ClientAffinity | string;
|
|
2723
2716
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-global-accelerator",
|
|
3
3
|
"description": "AWS SDK for JavaScript Global Accelerator Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.388.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.388.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.388.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.387.0",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.387.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.387.0",
|