Skip to main content

AWS Cloud Connectivity - Create a Private Self-Made Cloud Connector

Prepare credentials, a technical VPN, and the AWS connection values before creating the connector.

1. Retrieve AWS credentials​

List project credentials and use the returned id as awsCredentialId. If no credential is available, create one.

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/aws/api/v1/projects/{projectId}/aws/credentials?limit=10&offset=0

2. Retrieve the technical VPN​

Replace {tenantId} with the tenant or organization UUID. Use the returned VPN id as technicalVpnId.

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/vpnaaservice/api/v2/tenant/{tenantId}/vpns?connectivity=Any2Any&limit=100&offset=0

3. Retrieve the AWS region​

Use the credential ID from step 1 and the intended virtual interface type (privateVif or transitVif).

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/aws/api/v1/aws/projects/{projectId}/vif/{vifType}/regions?awsCredentialsId={awsCredentialId}

4. Retrieve the customer gateway​

Use the same interface type and select a customer gateway from the AWS account. regionName is optional in the API; providing it scopes the results.

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/aws/api/v1/projects/{projectId}/aws/vif/{vifValue}/customergateways?awsCredentialsId={awsCredentialId}&regionName={region}

5. Retrieve the Orange location​

GET https://ope-obs.apibackbone.orange.com/evolutionplatform/aws/api/v1/aws/orangelocations

6. Create the private connector​

The required body fields are name, state, bandwidth, technicalVpnId, awsCredentialId, virtualInterfaceType, location, and customerGatewayId. Optional fields include region, maxBandwidth, and routingPolicy.

POST https://ope-obs.apibackbone.orange.com/evolutionplatform/aws/api/v1/projects/{projectId}/aws/cloudconnectors/privates
Authorization: Bearer YOUR_JWT_TOKEN
Content-Type: application/json
{
  "name": "YOUR_CONNECTOR_NAME",
  "state": "DESIGNED",
  "bandwidth": 50,
  "technicalVpnId": "YOUR_TECHNICAL_VPN_ID",
  "awsCredentialId": "YOUR_AWS_CREDENTIAL_ID",
  "virtualInterfaceType": "privateVif",
  "location": "YOUR_ORANGE_LOCATION",
  "region": "YOUR_AWS_REGION",
  "customerGatewayId": "YOUR_CUSTOMER_GATEWAY_ID",
  "routingPolicy": "basicAggregate"
}

The API returns 201 Created when the connector is created. Supported state and routing policy values are listed in the endpoint reference.