npmctl-route53
AWS Route 53 DNS provider plugin for npmctl
Extend npmctl with Route 53-backed DNS record management for declarative workflows, provider discovery, and DNS-aware automation.
npmctl-route53 is the AWS Route 53 DNS provider package for npmctl. Install it when you want desired-state DNS records or DNS diagnostics to resolve through Route 53 instead of using only the base npmctl package.
Supported Python Versions
npmctl-route53 supports Python 3.10, 3.11, 3.12, 3.13, and 3.14.
Why npmctl-route53
- Adds Route 53 DNS provider discovery to
npmctl - Lets DNS workflows live beside proxy and certificate desired state
- Keeps AWS DNS dependencies out of the core CLI package
- Supports operator diagnostics through
npmctl dns doctor - Provides client helpers for Route 53 DNS change-batch workflows
FAQ
What is npmctl-route53?
Answer: npmctl-route53 is a plugin package that teaches npmctl how to talk to AWS Route 53 through boto3 for DNS record operations and DNS provider diagnostics.
When do I need npmctl-route53?
Answer: You need npmctl-route53 when your npmctl workflow includes Route 53 hosted-zone DNS records or when you want npmctl to validate Route 53 DNS connectivity and credentials.
Does npmctl-route53 work without npmctl?
Answer: No. npmctl-route53 is an extension package for npmctl, not a standalone CLI.
Can npmctl-route53 set DNS records?
Answer: Yes. The Route 53 provider supports declarative A, AAAA, CNAME, TXT, MX, SRV, and CAA writes through ChangeResourceRecordSets. MX records require priority.
What credentials are required?
Answer: Route 53 access uses the standard AWS credential chain or ROUTE53_PROFILE. Diagnostics require hosted-zone and record-set list permissions; mutation helpers require route53:ChangeResourceRecordSets.
Install
Install the base CLI and the Route 53 provider package together:
pipx install npmctl
pipx inject npmctl npmctl-route53
npmctl plugins list
With uv:
uv tool install npmctl
uv tool install npmctl-route53
npmctl plugins list
Inside a virtual environment:
python -m venv .venv
. .venv/bin/activate
python -m pip install npmctl npmctl-route53
npmctl plugins list
Configure Route 53
Use the standard AWS credential chain:
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export AWS_SESSION_TOKEN=...
Or use a named profile:
export AWS_PROFILE=production-dns
Optional package-specific override:
export ROUTE53_PROFILE=production-dns
Verify Plugin Discovery
Check that npmctl can discover the provider:
npmctl plugins list
npmctl dns doctor --provider route53
Minimal DNS Workflow
Once the provider is installed and configured, npmctl can validate, plan, apply, or diagnose Route 53-backed DNS behavior through the base CLI:
npmctl validate desired-state/dns.yaml
npmctl plan desired-state/dns.yaml --owner site-a
npmctl apply desired-state/dns.yaml --owner site-a
npmctl dns providers
npmctl dns zones --provider route53
npmctl dns records --provider route53 --zone example.com
Route 53 API Surface
The provider follows the AWS Route 53 API through boto3:
ListHostedZones: discover hosted zones.ListResourceRecordSets: list records in one hosted zone.ChangeResourceRecordSetswithCREATE: create record sets.ChangeResourceRecordSetswithUPSERT: create or update record sets.ChangeResourceRecordSetswithDELETE: delete record sets.
Required IAM actions for diagnostics:
route53:ListHostedZonesroute53:ListResourceRecordSets
Required IAM action for mutation helpers:
route53:ChangeResourceRecordSets
Programmatic Record Operations
from npmctl_route53 import Route53Client, Route53Config
client = Route53Client(Route53Config.from_env())
client.create_record("example.com", type="A", name="www", value="192.0.2.10", ttl=300)
client.upsert_record("example.com", type="CNAME", name="app", value="target.example.net", ttl=300)
client.upsert_record("example.com", type="MX", name="@", value="mail.example.com", ttl=300, priority=10)
client.delete_record("example.com", type="A", name="www", value="192.0.2.10", ttl=300)
Safety Notes
- Route 53 changes are hosted-zone scoped. Confirm the selected hosted zone before mutation.
- Prefer IAM policies scoped to the intended hosted zone ARN.
UPSERTcan overwrite live DNS answers. Use create-only workflows when adoption is not explicit.- Use npmctl owner metadata for desired DNS records so apply remains owner-scoped.
More Documentation
- Related PyPI package: https://pypi.org/project/npmctl/
- Repository: https://github.com/groupsum/npmctl
- DNS provider docs: https://github.com/groupsum/npmctl/tree/master/docs/dns-providers.md
Metadata
Release files for npmctl-route53 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| npmctl_route53-0.4.1.tar.gz | 4.0 kB | Without provenance | Details for npmctl_route53-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| npmctl_route53-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for npmctl_route53-0.4.1-py3-none-any.whl |
Total release size: 10.1 kB
Release files / npmctl_route53-0.4.1.tar.gz
| Download URL | npmctl_route53-0.4.1.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8ebcf075270e24d745b247832c671b333e0c1092e339c933a7c09d04816e2ed9
|
|
BLAKE2b-256 checksum How to use checksums |
f3e92bb84142ad05799602a26bc444e13ecc985976f310fe8e4a0b1a2823999f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / npmctl_route53-0.4.1-py3-none-any.whl
| Download URL | npmctl_route53-0.4.1-py3-none-any.whl |
|---|---|
| Size | 6.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
987ff6f88c198beec56d3f199b3445c8242f6330856d82d7100d2d873e7760ec
|
|
BLAKE2b-256 checksum How to use checksums |
abb7f9d68fa240e025bec4669e3bf0700a7909f18bb1facf47a6d0637d15fdec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for npmctl-route53 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.