Studio Project workflows for AWS Direct Connect connections, virtual interfaces, and gateways
AWS Direct Connect creates dedicated private network connections between your data center or office and AWS, bypassing the public internet — it manages the connections, virtual interfaces, link aggregation groups (LAGs), and gateways that make up a Direct Connect deployment.
This project provides an OpenAPI spec for automating against the AWS Direct Connect API via an Integration Model. The -latest spec covers the full Direct Connect operation surface — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | AWS Direct Connect API OpenAPI specs — curated -latest plus the full dated spec |
| Studio Projects/AWS Direct Connect | 25 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| AWS Direct Connect API | 2012-10-25 |
| AWS Direct Connect Integration Model | Required to build automation against the OpenAPI spec |
Import aws_direct_connect-latest.json from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at the AWS Direct Connect endpoint (e.g. directconnect.<region>.amazonaws.com).
Authentication uses AWS Signature Version 4, sent in the Authorization header:
Authorization: AWS4-HMAC-SHA256 Credential=<access-key-id>/<date>/<region>/directconnect/aws4_request, SignedHeaders=..., Signature=<signature> Sign requests with an AWS access key ID and secret access key that has IAM permission to call the Direct Connect API. Generate or retrieve credentials in the AWS IAM console under your user's Security credentials.
The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"hmac": {
"accessKeyId": "<your-aws-access-key-id>",
"secretAccessKey": "<your-aws-secret-access-key>",
"sessionToken": ""
}
},
"server": {
"protocol": "https",
"host": "directconnect.us-east-1.amazonaws.com",
"base_path": ""
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
aws_direct_connect-latest.json | latest (curated) | 63 | Actively-maintained, curated for common CRUD automation — see breakdown below |
aws_direct_connect-2012-10-25.json | 2012-10-25 | 63 | Full spec (63 operations) |
aws_direct_connect-latest.jsonActively-maintained spec (x-vendor-api-version: 2012-10-25, 63 operations). Every operation was checked individually against the upstream spec; all 63 are genuine CRUD/provisioning actions on Direct Connect's own resources (connections, virtual interfaces, gateways, LAGs, interconnects, BGP peers, tags) or the lookups needed to drive those actions (locations, router config, LOAs, customer agreements) — there is no health/heartbeat/metrics/version-info/self-introspection surface to exclude, so nothing was removed. The security block is already global (hmac), with no redundant per-operation overrides.
Operations included, by category:
aws_direct_connect-2012-10-25.jsonFull spec for AWS Direct Connect API version 2012-10-25 (63 operations) — the entire upstream API surface as AWS defines it. See aws_direct_connect-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the AWS Direct Connect:latest Integration Model (see aws_direct_connect-latest.json above). The project contains 25 workflows organized into 7 folders, one atomic workflow per API operation, covering a common-CRUD subset of the spec (the full spec is already curated to 63 core operations — see above).
Direct Connect is an AWS JSON-protocol API — every operation is a POST whose X-Amz-Target header is a fixed single-value constant already baked into the operation's path, not real user input, so it's omitted from each workflow's input schema in favor of the single requestBody (JSON) parameter.
| Folder | Workflows | Scope |
|---|---|---|
| Connections | Describe, Create, Update, Delete Connection | Connection lifecycle |
| Virtual Interfaces | Describe, Create Private, Update Attributes, Delete Virtual Interface | Virtual interface lifecycle |
| Direct Connect Gateways | Describe, Create, Update, Delete Direct Connect Gateway | Gateway lifecycle |
| Direct Connect Gateway Associations | Describe, Create, Update, Delete Direct Connect Gateway Association | Gateway-to-VGW/TGW association management |
| LAGs | Describe, Create, Update, Delete Lag | Link Aggregation Group lifecycle |
| Interconnects | Describe, Create, Delete Interconnect | Interconnect lifecycle |
| BGP Peers | Create, Delete BGP Peer | BGP peer management |
| Dependency | Notes |
|---|---|
AWS Direct Connect:latest Integration Model | Import from aws_direct_connect-latest.json before importing the project |
AWS Direct Connect integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named AWS Direct Connect — update the adapter_id value in each workflow task if yours is named differently |