HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. awsCloudDeployment

Deploy Cloud Hub(s) in AWS

post
http://127.0.0.1:8080/cloudDeployment/aws/edgeconnects

Initiates deployment of one or more EdgeConnect Cloud Hub appliances in AWS. The Orchestrator must be registered to Cloud Portal before deployment. Creates VPC, subnets, security groups, and EC2 instances using Terraform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

AWS deployment configuration specifying account, region, network settings, and instance details.

Configuration for deploying EdgeConnect Cloud Hub appliances in AWS.

string
required
length ≤ 20
^[a-zA-Z0-9-]{1,20}$

Unique deployment name. Alphanumeric and dash (-) only, max 20 characters.

uuid
required

UUID of a registered AWS account. Obtain from GET /cloudDeployment/aws/accounts.

string
enum
Defaults to aws

Cloud provider identifier. Must be 'aws' for AWS deployments.

Allowed:
string
required

AWS region for deployment (e.g., us-west-2, eu-west-1). Must be valid for the account.

string
required
^([0-9]{1,3}\.){3}[0-9]{1,3}/[0-9]{1,2}$

CIDR block for the new VPC (e.g., 10.100.0.0/16). Must be valid IPv4 CIDR notation.

string
required
length ≥ 1

Name of an existing EC2 key pair in the target region for SSH access.

string
required

Expected WAN bandwidth in Mbps. Used to determine instance sizing.

boolean
Defaults to false

Enable WAN Optimization (Boost) capability on the appliance.

string
required

AWS EC2 instance type (e.g., c5.large, c5.xlarge). Must support the requested bandwidth.

string

Custom AMI ID to use. If omitted, the latest EdgeConnect AMI from Cloud Portal is used.

integer
required
≥ 1

Number of appliances to deploy. Must equal the length of the instances array.

instances
array of objects
required
length ≥ 1

Per-appliance configuration array. Length must match numInstances.

instances*

Configuration for a single AWS EdgeConnect instance within a deployment.

string
required

AWS availability zone for this instance (e.g., us-west-2a). Must be valid for the deployment region.

string
length ≤ 25
^[a-zA-Z0-9-]{0,25}$

Unique appliance tag identifier. Alphanumeric and dash (-) only, max 25 characters. Auto-generated if omitted.

string
^([^=,]+=[^=,]+(,[^=,]+=[^=,]+)*)?$

Custom AWS resource tags as comma-separated key=value pairs.

string

Optional description for the deployment.

Responses

Updated about 13 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 13 hours ago

Did this page help you?