Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class CreateAcceleratorCommandProtected

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

Example

Use a bare-bones client and the command you need to make an API call.

import { GlobalAcceleratorClient, CreateAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import
// const { GlobalAcceleratorClient, CreateAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import
const client = new GlobalAcceleratorClient(config);
const input = { // CreateAcceleratorRequest
Name: "STRING_VALUE", // required
IpAddressType: "IPV4" || "DUAL_STACK",
IpAddresses: [ // IpAddresses
"STRING_VALUE",
],
Enabled: true || false,
IdempotencyToken: "STRING_VALUE", // required
Tags: [ // Tags
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
};
const command = new CreateAcceleratorCommand(input);
const response = await client.send(command);
// { // CreateAcceleratorResponse
// Accelerator: { // Accelerator
// AcceleratorArn: "STRING_VALUE",
// Name: "STRING_VALUE",
// IpAddressType: "IPV4" || "DUAL_STACK",
// Enabled: true || false,
// IpSets: [ // IpSets
// { // IpSet
// IpFamily: "STRING_VALUE",
// IpAddresses: [ // IpAddresses
// "STRING_VALUE",
// ],
// IpAddressFamily: "IPv4" || "IPv6",
// },
// ],
// DnsName: "STRING_VALUE",
// Status: "DEPLOYED" || "IN_PROGRESS",
// CreatedTime: new Date("TIMESTAMP"),
// LastModifiedTime: new Date("TIMESTAMP"),
// DualStackDnsName: "STRING_VALUE",
// Events: [ // AcceleratorEvents
// { // AcceleratorEvent
// Message: "STRING_VALUE",
// Timestamp: new Date("TIMESTAMP"),
// },
// ],
// },
// };

Param

CreateAcceleratorCommandInput

Returns

CreateAcceleratorCommandOutput

See

Throws

InternalServiceErrorException (server fault)

There was an internal error for Global Accelerator.

Throws

InvalidArgumentException (client fault)

An argument that you specified is invalid.

Throws

LimitExceededException (client fault)

Processing your request would cause you to exceed an Global Accelerator limit.

Throws

GlobalAcceleratorServiceException

Base exception class for all service exceptions from GlobalAccelerator service.

Hierarchy

Constructors

Properties

Methods