Connect Network Edge Device to Amazon Web Services

Establish a direct layer 2 connection between your Virtual Device and your Amazon Web Services (AWS) resource.

Step 1: Identify Your Amazon Account ID

Log in to AWS Management Console and locate your account number.

Refer to https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html for instructions on how to find your account number.

Step 2: Get Network Edge Device Information

You need a provisioned Equinix Virtual Device/Redundant Devices/Cluster with a registered license on the A-side. Check your available virtual devices/clusters by calling Get Virtual Devices or Get Virtual Device {uuid}. You may choose any available interface of the device for your connection. However, Equinix will select an interface if you do not specify any.

Step 3: Create Connection

1. Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

Refer to Generating Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section for instructions on how to call Oauth API to validate and authenticate your credentials.

If you are unaware of your user credentials for Equinix Fabric, contact your local Equinix Service Desk.

2. Choose Z-side metro location and seller region
Call Get All Metros API to find all metros where Equinix Fabric is available, and determine the destination location.

3. Identify the service profile to connect
Call Retrieve Service Profiles API to search for a specific service profile or call Get Service Profiles API to list all available service profiles.

4. Validate your AWS Account ID
Use the Validate Connection Authorization Key API request to verify that your AWS Account ID can be used to create a connection to the selected service profile in the given metro.

5. Establish connection
Use the POST /fabric/v4/connections API request to create a connection.

POST /fabric/v4/connections
Method POST
Endpoint /fabric/v4/connections
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, name, order, bandwidth, redundancy, aSide, zSide, notifications

Call Retrieve Pricing API to get connection price estimate.


Sample curl request - connect your Network Edge Device to AWS

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
{
    "type": "IP_VC",
    "bandwidth": 200,
    "project": {
        "projectId": "188572000188973"
    },
    "aSide": {
        "accessPoint": {
            "type": "CLOUD_ROUTER",
            "router": {
                "uuid": "13fa98e8-8497-44d9-a45c-ce00d89b0a56"
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "VD",
            "virtualDevice": {
                "uuid": "f6b1f188-3af4-47d0-a46e-ef175973c233"
            }
        }
    },
    "name": "test-fcr-to-ne-device",
    "order": {
        "purchaseOrderNumber": ""
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "x@equinix.com"
            ]
        }
    ]
}
'

Body parameters

Parameter
Description
type string
REQUIRED
 Connection type.
  • EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections.
name string
REQUIRED
 Connection name.
Applicable values:
  • Maximum: 24 characters
  • Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_')
Example: my_connection
order object
OPTIONAL
 Order details.
purchaseOrderNumber string
OPTIONAL
 Subscriber's purchase order identifier.
Example: 1-129105284100
bandwidth integer
REQUIRED
 Connection speed in Mbps.
Applicable values:
  • 10
  • 50
  • 200
  • 500
  • 1000
  • 2000
  • 5000
  • 10000
redundancy object
CONDITIONAL
 Connection redundancy configuration.
group string
CONDITIONAL
 Unique Id of the redundancy group. This is only required for secondary connections. If you are creating a secondary connection, enter the group of the PRIMARY. You can find the group of the primary connection by calling Get Specified Connection or by checking the "group" field in the response you receive when creating PRIMARY connection.
Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority string
CONDITIONAL
 Whether the connection is PRIMARY or SECONDARY. Don't provide a redundancy group for a PRIMARY connection.
Applicable value:
  • PRIMARY
  • SECONDARY
aSide object
REQUIRED
 Source definition.
accessPoint object
REQUIRED
 Connection endpoint configuration from the A-Side.
type string
REQUIRED
 Connection endpoint type.
  • VD
virtualDevice object
REQUIRED
 Object containing the virtual device details.
type string
REQUIRED
 Type of virtual device.
  • EDGE
uuid string
REQUIRED
 Unique Id of virtual device.
Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
interface object
OPTIONAL
 Object containing the interface details of the virtual device.
type string
OPTIONAL
 Type of interface.
  • NETWORK
  • CLOUD
id string
OPTIONAL
 Id of interface. You can choose any available interface on your device for your connection. However, Equinix will select an interface if you do not specify any.
Example: 7
zSide object
REQUIRED
 Z-side details.
accessPoint object
REQUIRED
 Connection endpoint configuration.
type string
REQUIRED
 Connection endpoint type.
  • SP - Service profile.
profile object
REQUIRED
 A named provider service and its network connectivity requirements.
Applicable to SP type access points.
Call Retrieve Service Profiles API to search for service profiles and determine their identifiers and available locations.
uuid string
REQUIRED
 Service profile identifier.
Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
type string
OPTIONAL
 Service profile type.
Example:
  • L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model.
location object
REQUIRED
 Connection endpoint location information.
Applicable to SP type access points.
metroCode string
REQUIRED
 Metropolitan area identifier.
Call Get Specified Service Profile API to determine where a given service is available.
sellerRegion string
REQUIRED
 Seller region.
Example: us-west1
authenticationKey string
REQUIRED
 AWS accound Id.
Example: 1234567890
notifications array[object]
REQUIRED
 Notification settings for messages.
type string
REQUIRED
 Notification messages category.
Applicable values:
  • ALL
emails array[string]
REQUIRED
 Email addresses of up to 12 recipients.
Example:["x@mx.com","x@x.com"]

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response - connection to AWS from a Network Edge Virtual Device

Copy 
{
    "type": "EVPL_VC",
    "href": "https://api.equinix.com/fabric/v4/connections/f89bc4b5-324a-462f-9ea4-23cb670dec44",
    "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "name": "test-aws-3-vd-api",
    "operation": {
        "providerStatus": "PROVISIONING",
        "equinixStatus": "PROVISIONING"
    },
    "order": {
        "billingTier": "Up to 50 MB"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ],
    "changeLog": {
        "createdBy": "X@EQUINIX.COM",
        "createdByFullName": "XXXXX XXXXXX",
        "createdByEmail": "x@x.com",
        "createdDateTime": "2024-04-22T20:49:46.840Z",
        "updatedBy": "x@x.COM",
        "updatedByFullName": "XXXXX XXXXX",
        "updatedByEmail": "x@x.com",
        "updatedDateTime": "2024-04-22T20:49:46.840Z"
    },
    "bandwidth": 50,
    "redundancy": {
        "group": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "interface": {
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                "id": 7,
                "type": "NETWORK"
            },
            "location": {
                "metroCode": "AM"
            },
            "virtualDevice": {
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
                "type": "EDGE"
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "location": {
                "metroCode": "DA"
            },
            "profile": {
                "href": "https://api.equinix.com/fabric/v4/serviceProfiles/69ee618d-be52-468d-bc99-00566f2dd2b9",
                "type": "L2_PROFILE",
                "name": "AWS Direct Connect",
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
            },
            "sellerRegion": "us-east-1",
            "authenticationKey": "123456123456"
        }
    }
}

Response payload body description

Parameter
Description
type string
 Type of connection.
Example: EVPL_VC
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned connection Id.
Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
name string
 Name of the connection.
Example: Test-aws-to-vd-api
order object
 Order information.
billingTier string
 Billing tier of connection bandwidth.
Example: Up to 1 Gbps
bandwidth string
 Bandwidth.
Example: Up to 1 Gbps
redundancy object
 Redundancy details.
group string
 Unique Id of the redundancy group.
priority string
 Whether the connection is PRIMARY or SECONDARY.
aSide object
 Source definition.
accessPoint object
 Connection endpoint configuration from the A-side.
interface object
 Object containing interface details.
uuid string
 Unique id of the interface.
Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
id string
 Id of the interface.
Example: 7
type string
 Type of interface.
Example: NETWORK
location object
 Object containing A-side location details.
metroCode string
 A-side Metropolitan area identifier.
Example: AM
virtualDevice object
 Object containing virtual device details.
type string
 Type of virtual device.
Example: EDGE
uuid string
 Unique Id of the virtual device.
Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
zSide object
 Destination port definition.
accessPoint object
 Connection endpoint configuration from the Z-side.
profile object
 The service profile associated with this access point.
href string
 An absolute URL that returns complete specification of the given entity.
Example:https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f
type string
 Service profile type.
Example:
  • L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model.
name string
 Name of the service profile.
Example: AWS Direct Connect
uuid string
 Unique Id of the service profile.
Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
location object
 Connection endpoint location information.
metroCode string
 Metropolitan area identifier.
Example: DA
sellerRegion string
 Seller region.
. Example: us-west1
authenticationKey string
 Authentication key.
. Example: 1234567890
notifications array[object]
 Notification settings for messages.
type string
 Notification messages category.
Example: ALL
emails array[string]
 Email addresses of up to 12 recipients.
Example:["x@x.com","x@x.com"]
operation object
 Connection operational data.
equinixStatus string
 Status of the connection on the Equinix side.
Example: PROVISIONING
providerStatus string
 Status of the connection on the provider side.
Example: NOT_AVAILABLE
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

Use the Get Specified Connection API request to monitor connection status.

equinixStatus
attribute values		 providerStatus
attribute values 		AWS Direct Connect State Description
PROVISIONING PROVISIONING Connection request has not been sent to AWS yet.
PROVISIONED PENDING_APPROVAL Ordering -> Requested The connection awaits for acceptance.
PROVISIONED PROVISIONING Pending Connection establishment in progress.
PROVISIONED PROVISIONED Pending -> Available The connection has been accepted.

Step 4: Accept Connection

You can accept the connection on the Fabric portal or in your AWS console. You can also accept the connection through an API call by passing the connection Id as a path parameter and the accessKey and secretKey in the body of the payload.

Sample curl request to accept connection

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/connections/c31199e6-e776-4017-9433-ad97a2c9848c'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "add",
        "path": "/zSide",
        "value": {
            "additionalInfo": [
                {
                    "key": "accessKey",
                    "value": "AKIA4TNUPZNEUHUXXXXXXX"
                },
                {
                    "key": "secretKey",
                    "value": "1EQ2rm137ldG3H8TFGQastXXXXXXXXXX"
                }
            ]
        }
    }
]'