@aws-sdk/client-global-accelerator 3.386.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/GlobalAcceleratorClient.js +2 -2
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/GlobalAcceleratorClient.js +2 -2
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/GlobalAccelerator.d.ts +12 -17
- package/dist-types/GlobalAcceleratorClient.d.ts +14 -19
- 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/dist-types/ts3.4/GlobalAcceleratorClient.d.ts +6 -1
- package/package.json +28 -28
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
|
|
@@ -15,8 +15,8 @@ Object.defineProperty(exports, "__Client", { enumerable: true, get: function ()
|
|
|
15
15
|
const EndpointParameters_1 = require("./endpoint/EndpointParameters");
|
|
16
16
|
const runtimeConfig_1 = require("./runtimeConfig");
|
|
17
17
|
class GlobalAcceleratorClient extends smithy_client_1.Client {
|
|
18
|
-
constructor(configuration) {
|
|
19
|
-
const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration);
|
|
18
|
+
constructor(...[configuration]) {
|
|
19
|
+
const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration || {});
|
|
20
20
|
const _config_1 = (0, EndpointParameters_1.resolveClientEndpointParameters)(_config_0);
|
|
21
21
|
const _config_2 = (0, config_resolver_1.resolveRegionConfig)(_config_1);
|
|
22
22
|
const _config_3 = (0, middleware_endpoint_1.resolveEndpointConfig)(_config_2);
|
|
@@ -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;
|
|
@@ -12,8 +12,8 @@ import { resolveClientEndpointParameters, } from "./endpoint/EndpointParameters"
|
|
|
12
12
|
import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
|
|
13
13
|
export { __Client };
|
|
14
14
|
export class GlobalAcceleratorClient extends __Client {
|
|
15
|
-
constructor(configuration) {
|
|
16
|
-
const _config_0 = __getRuntimeConfig(configuration);
|
|
15
|
+
constructor(...[configuration]) {
|
|
16
|
+
const _config_0 = __getRuntimeConfig(configuration || {});
|
|
17
17
|
const _config_1 = resolveClientEndpointParameters(_config_0);
|
|
18
18
|
const _config_2 = resolveRegionConfig(_config_1);
|
|
19
19
|
const _config_3 = resolveEndpointConfig(_config_2);
|
|
@@ -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 {
|
|
@@ -7,7 +7,7 @@ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-
|
|
|
7
7
|
import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
|
|
8
8
|
import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
|
|
9
9
|
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
10
|
-
import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
10
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
11
11
|
import { AddCustomRoutingEndpointsCommandInput, AddCustomRoutingEndpointsCommandOutput } from "./commands/AddCustomRoutingEndpointsCommand";
|
|
12
12
|
import { AddEndpointsCommandInput, AddEndpointsCommandOutput } from "./commands/AddEndpointsCommand";
|
|
13
13
|
import { AdvertiseByoipCidrCommandInput, AdvertiseByoipCidrCommandOutput } from "./commands/AdvertiseByoipCidrCommand";
|
|
@@ -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> {
|
|
@@ -253,7 +248,7 @@ export declare class GlobalAcceleratorClient extends __Client<__HttpHandlerOptio
|
|
|
253
248
|
* The resolved configuration of GlobalAcceleratorClient class. This is resolved and normalized from the {@link GlobalAcceleratorClientConfig | constructor configuration interface}.
|
|
254
249
|
*/
|
|
255
250
|
readonly config: GlobalAcceleratorClientResolvedConfig;
|
|
256
|
-
constructor(configuration: GlobalAcceleratorClientConfig);
|
|
251
|
+
constructor(...[configuration]: __CheckOptionalClientConfig<GlobalAcceleratorClientConfig>);
|
|
257
252
|
/**
|
|
258
253
|
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
259
254
|
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
@@ -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.
|