Studio Project workflows for Amazon Route 53 hosted zones, DNS records, and health checks
Amazon Route 53 is AWS's Domain Name System (DNS) web service, used to register domains, manage hosted zones and DNS records, and configure health checks and routing for internet applications.
This project provides an OpenAPI spec for automating against the Route 53 REST API via an Integration Model. The -latest spec is a curated subset covering common CRUD for DNS automation — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | Amazon Route 53 REST API OpenAPI spec — curated -latest plus the full dated spec |
| Studio Projects/Amazon Route 53 | 17 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Amazon Route 53 | 2013-04-01 API |
| Amazon Route 53 Integration Model | Required to build automation against the OpenAPI spec |
| AWS IAM credentials | An access key ID and secret access key with route53:* permissions for the operations you automate |
Import the OpenAPI spec from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at the Route 53 endpoint (https://route53.amazonaws.com).
Route 53 authenticates requests with AWS Signature Version 4 (SigV4), not a static bearer token. Each request must carry a signed Authorization header computed from an AWS access key ID and secret access key:
Authorization: AWS4-HMAC-SHA256 Credential=<access-key-id>/<date>/<region>/route53/aws4_request, SignedHeaders=..., Signature=<signature> Generate an access key ID and secret access key for an IAM user or role with Route 53 permissions in the AWS Console under IAM > Users > Security credentials, then configure your integration's connection to sign requests with SigV4 using those 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": "route53.amazonaws.com",
"base_path": ""
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
amazon_route_53-latest.json | latest (curated) | 23 | Actively-maintained, trimmed to common CRUD for automation — see breakdown below |
amazon_route_53-2013-04-01.json | 2013-04-01 | 70 | Full spec for the Route 53 2013-04-01 API (70 operations). |
amazon_route_53-latest.jsonActively-maintained spec (x-vendor-api-version: 2013-04-01). Trimmed to 23 of 70 upstream operations covering common CRUD for automation.
Resources included, by category:
Not included: CIDR collections, DNSSEC/key-signing key management, traffic policies and traffic policy instances, query logging configuration, reusable delegation sets, account/resource limit and count lookups, checker IP ranges, geolocation lookups, and the DNS answer test tool. Pull the full spec above if you need one of those areas.
amazon_route_53-2013-04-01.jsonFull spec for the Route 53 2013-04-01 API (70 operations) — the entire upstream API surface as AWS defines it. See amazon_route_53-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the Amazon Route 53:latest Integration Model (see amazon_route_53-latest.json above). The project contains 17 workflows organized into 5 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec.
| Folder | Workflows | Scope |
|---|---|---|
| Hosted Zones | Create, Get, List, Delete Hosted Zone, Update Hosted Zone Comment | Hosted zone lifecycle |
| Resource Record Sets | Change, List Resource Record Sets, Get Change | DNS record management and propagation tracking |
| Health Checks | Create, Get, List, Delete, Update Health Check | Health check management |
| VPC Associations | Associate, Disassociate VPC With Hosted Zone | Private hosted zone VPC association |
| Tags | Change Tags For Resource, List Tags For Resource | Tagging management |
| Dependency | Notes |
|---|---|
Amazon Route 53:latest Integration Model | Import from amazon_route_53-latest.json before importing the project |
Amazon Route 53 integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named Amazon Route 53 — update the adapter_id value in each workflow task if yours is named differently |