Skip to content

AWS DNS Adapter

Reference doc for the `sst.aws.dns` adapter.

The AWS DNS Adapter is used to create DNS records to manage domains hosted on Route 53.

This adapter is passed in as domain.dns when setting a custom domain.

{
domain: {
name: "example.com",
dns: sst.aws.dns()
}
}

You can also sepcify a hosted zone ID if you have multiple hosted zones with the same domain.

{
domain: {
name: "example.com",
dns: sst.aws.dns({
zone: "Z2FDTNDATAQYW2"
})
}
}

Functions

dns

dns(args?)

Parameters

Returns Object

DnsArgs

override?

Type Input<boolean>

Default false

Set to true to allow the creation of new DNS records that can replace existing ones.

This is useful for switching a domain to a new site without removing old DNS records, helping to prevent downtime.

{
override: true
}

transform?

Type Object

Transform how this component creates its underlying resources.

transform.record?

Type RecordArgs | (args: RecordArgs, opts: ComponentResourceOptions, name: string) => void

Transform the AWS Route 53 record resource.

zone?

Type Input<string>

Set the hosted zone ID if you have multiple hosted zones that have the same domain in Route 53.

The 14 letter ID of the Route 53 hosted zone that contains the domainName. You can find the hosted zone ID in the Route 53 part of the AWS Console.

{
zone: "Z2FDTNDATAQYW2"
}