Cloudflare/custom Hostnames
@swamp/cloudflare/custom-hostnamesv2026.10.23.1
01README
Cloudflare custom-hostnames infrastructure models
02Release Notes
- Updated: custom_hostnames
03Behaviors
@swamp/cloudflare/custom-hostnames/custom-hostnamesv2026.10.23.1custom_hostnames.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| zone_id | string | Cloudflare zone ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| custom_metadata? | record | Unique key/value metadata for this hostname. These are per-hostname (customer) settings. |
| custom_origin_server? | string | a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record. |
| custom_origin_sni? | string | A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server. |
| ssl? | object | |
| hostname? | string | The custom hostname that will point to your hostname via CNAME. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Custom Hostnames
fn get(id: string)
Get a Custom Hostnames
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom Hostnames |
fn lookup(allowMissing?: boolean)
Look up an existing Custom Hostnames by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Custom Hostnames by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom Hostnames to import |
fn update(identifier?: string)
Update Custom Hostnames attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Custom Hostnames by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Custom Hostnames
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom Hostnames |
fn sync(identifier?: string)
Sync Custom Hostnames state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Custom Hostnames by id (e.g. one discovered by list) |
Resources
state(infinite)— Custom Hostnames resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: custom_hostnames
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: custom_hostnames
2026.09.29.1
- Updated: custom_hostnames
2026.08.25.2
- Updated: custom_hostnames
2026.08.25.1
- Updated: custom_hostnames
2026.07.21.1
- Updated: custom_hostnames
2026.07.18.2
Modified 1 behaviors
2026.07.14.1
- Updated: custom_hostnames
2026.06.08.2
- Updated: custom_hostnames
2026.05.29.1
- Updated: custom_hostnames
2026.05.22.1
- Added: custom_hostnames
05Stats
A
100 / 100
Downloads
25
Archive size
13.5 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels