1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. WorkersCustomDomain
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.WorkersCustomDomain

cloudflare logo
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Accepted Permissions

    • Workers Scripts Read
    • Workers Scripts Write

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleWorkersCustomDomain = new cloudflare.WorkersCustomDomain("example_workers_custom_domain", {
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    hostname: "app.example.com",
    service: "my-worker",
    environment: "production",
    zoneId: "593c9c94de529bbbfaac7c53ced0447d",
    zoneName: "example.com",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_workers_custom_domain = cloudflare.WorkersCustomDomain("example_workers_custom_domain",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    hostname="app.example.com",
    service="my-worker",
    environment="production",
    zone_id="593c9c94de529bbbfaac7c53ced0447d",
    zone_name="example.com")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewWorkersCustomDomain(ctx, "example_workers_custom_domain", &cloudflare.WorkersCustomDomainArgs{
			AccountId:   pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			Hostname:    pulumi.String("app.example.com"),
			Service:     pulumi.String("my-worker"),
			Environment: pulumi.String("production"),
			ZoneId:      pulumi.String("593c9c94de529bbbfaac7c53ced0447d"),
			ZoneName:    pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleWorkersCustomDomain = new Cloudflare.Index.WorkersCustomDomain("example_workers_custom_domain", new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        Hostname = "app.example.com",
        Service = "my-worker",
        Environment = "production",
        ZoneId = "593c9c94de529bbbfaac7c53ced0447d",
        ZoneName = "example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WorkersCustomDomain;
import com.pulumi.cloudflare.WorkersCustomDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleWorkersCustomDomain = new WorkersCustomDomain("exampleWorkersCustomDomain", WorkersCustomDomainArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .hostname("app.example.com")
            .service("my-worker")
            .environment("production")
            .zoneId("593c9c94de529bbbfaac7c53ced0447d")
            .zoneName("example.com")
            .build());

    }
}

    resources:
  exampleWorkersCustomDomain:
    type: cloudflare:WorkersCustomDomain
    name: example_workers_custom_domain
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      hostname: app.example.com
      service: my-worker
      environment: production
      zoneId: 593c9c94de529bbbfaac7c53ced0447d
      zoneName: example.com

    Create WorkersCustomDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkersCustomDomain(name: string, args: WorkersCustomDomainArgs, opts?: CustomResourceOptions);
    @overload
def WorkersCustomDomain(resource_name: str,
                        args: WorkersCustomDomainArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def WorkersCustomDomain(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        hostname: Optional[str] = None,
                        service: Optional[str] = None,
                        account_id: Optional[str] = None,
                        environment: Optional[str] = None,
                        zone_id: Optional[str] = None,
                        zone_name: Optional[str] = None)
    func NewWorkersCustomDomain(ctx *Context, name string, args WorkersCustomDomainArgs, opts ...ResourceOption) (*WorkersCustomDomain, error)
    public WorkersCustomDomain(string name, WorkersCustomDomainArgs args, CustomResourceOptions? opts = null)
    public WorkersCustomDomain(String name, WorkersCustomDomainArgs args)
public WorkersCustomDomain(String name, WorkersCustomDomainArgs args, CustomResourceOptions options)

    type: cloudflare:WorkersCustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkersCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkersCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkersCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkersCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkersCustomDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workersCustomDomainResource = new Cloudflare.WorkersCustomDomain("workersCustomDomainResource", new()
{
    Hostname = "string",
    Service = "string",
    AccountId = "string",
    ZoneId = "string",
    ZoneName = "string",
});

    example, err := cloudflare.NewWorkersCustomDomain(ctx, "workersCustomDomainResource", &cloudflare.WorkersCustomDomainArgs{
	Hostname:  pulumi.String("string"),
	Service:   pulumi.String("string"),
	AccountId: pulumi.String("string"),
	ZoneId:    pulumi.String("string"),
	ZoneName:  pulumi.String("string"),
})

    var workersCustomDomainResource = new WorkersCustomDomain("workersCustomDomainResource", WorkersCustomDomainArgs.builder()
    .hostname("string")
    .service("string")
    .accountId("string")
    .zoneId("string")
    .zoneName("string")
    .build());

    workers_custom_domain_resource = cloudflare.WorkersCustomDomain("workersCustomDomainResource",
    hostname="string",
    service="string",
    account_id="string",
    zone_id="string",
    zone_name="string")

    const workersCustomDomainResource = new cloudflare.WorkersCustomDomain("workersCustomDomainResource", {
    hostname: "string",
    service: "string",
    accountId: "string",
    zoneId: "string",
    zoneName: "string",
});

    type: cloudflare:WorkersCustomDomain
properties:
    accountId: string
    hostname: string
    service: string
    zoneId: string
    zoneName: string

    WorkersCustomDomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkersCustomDomain resource accepts the following input properties:

    Hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    Service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    AccountId string
    Identifier.
    Environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    Hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    Service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    AccountId string
    Identifier.
    Environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    hostname String
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service String
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    accountId String
    Identifier.
    environment String
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.
    hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    accountId string
    Identifier.
    environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    zoneId string
    ID of the zone containing the domain hostname.
    zoneName string
    Name of the zone containing the domain hostname.
    hostname str
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service str
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    account_id str
    Identifier.
    environment str
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    zone_id str
    ID of the zone containing the domain hostname.
    zone_name str
    Name of the zone containing the domain hostname.
    hostname String
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service String
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    accountId String
    Identifier.
    environment String
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkersCustomDomain resource produces the following output properties:

    CertId string
    ID of the TLS certificate issued for the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    CertId string
    ID of the TLS certificate issued for the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    certId String
    ID of the TLS certificate issued for the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    certId string
    ID of the TLS certificate issued for the domain.
    id string
    The provider-assigned unique ID for this managed resource.
    cert_id str
    ID of the TLS certificate issued for the domain.
    id str
    The provider-assigned unique ID for this managed resource.
    certId String
    ID of the TLS certificate issued for the domain.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkersCustomDomain Resource

    Get an existing WorkersCustomDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkersCustomDomainState, opts?: CustomResourceOptions): WorkersCustomDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        cert_id: Optional[str] = None,
        environment: Optional[str] = None,
        hostname: Optional[str] = None,
        service: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_name: Optional[str] = None) -> WorkersCustomDomain
    func GetWorkersCustomDomain(ctx *Context, name string, id IDInput, state *WorkersCustomDomainState, opts ...ResourceOption) (*WorkersCustomDomain, error)
    public static WorkersCustomDomain Get(string name, Input<string> id, WorkersCustomDomainState? state, CustomResourceOptions? opts = null)
    public static WorkersCustomDomain get(String name, Output<String> id, WorkersCustomDomainState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:WorkersCustomDomain    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Identifier.
    CertId string
    ID of the TLS certificate issued for the domain.
    Environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    Hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    Service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    AccountId string
    Identifier.
    CertId string
    ID of the TLS certificate issued for the domain.
    Environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    Hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    Service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    accountId String
    Identifier.
    certId String
    ID of the TLS certificate issued for the domain.
    environment String
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname String
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service String
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.
    accountId string
    Identifier.
    certId string
    ID of the TLS certificate issued for the domain.
    environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zoneId string
    ID of the zone containing the domain hostname.
    zoneName string
    Name of the zone containing the domain hostname.
    account_id str
    Identifier.
    cert_id str
    ID of the TLS certificate issued for the domain.
    environment str
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname str
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service str
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zone_id str
    ID of the zone containing the domain hostname.
    zone_name str
    Name of the zone containing the domain hostname.
    accountId String
    Identifier.
    certId String
    ID of the TLS certificate issued for the domain.
    environment String
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname String
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    service String
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.

    Import

    $ pulumi import cloudflare:index/workersCustomDomain:WorkersCustomDomain example '<account_id>/<domain_id>'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.15.0
    published on Saturday, May 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare
      Try Pulumi Cloud free. Your team will thank you.