Skip to content
SST
Blog Docs Examples
22K
Console

Cloudflare DNS Adapter

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

The Cloudflare DNS Adapter is used to create DNS records to manage domains hosted on Cloudflare DNS.

This needs the Cloudflare provider. To add it run:

Terminal window
sst add cloudflare

This adapter is passed in as domain.dns when setting a custom domain, where example.com is hosted on Cloudflare.

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

Specify the zone ID.

{
  domain: {
    name: "example.com",
    dns: sst.cloudflare.dns({
      zone: "415e6f4653b6d95b775d350f32119abb"
    })
  }
}

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
}

proxy?

Type Input<boolean>

Default false

Configure ALIAS DNS records as proxy records.

{
  proxy: 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 Cloudflare record resource.

zone?

Type Input<string>

The ID of the Cloudflare zone to create the record in.

{
  zone: "415e6f4653b6d95b775d350f32119abb"
}