Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WorkersRoute
Cloudflare v6.2.0 published on Tuesday, May 13, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.WorkersRoute

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.2.0 published on Tuesday, May 13, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

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

const exampleWorkersRoute = new cloudflare.WorkersRoute("example_workers_route", {
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    pattern: "example.com/*",
    script: "my-workers-script",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_workers_route = cloudflare.WorkersRoute("example_workers_route",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    pattern="example.com/*",
    script="my-workers-script")

    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.NewWorkersRoute(ctx, "example_workers_route", &cloudflare.WorkersRouteArgs{
			ZoneId:  pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			Pattern: pulumi.String("example.com/*"),
			Script:  pulumi.String("my-workers-script"),
		})
		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 exampleWorkersRoute = new Cloudflare.WorkersRoute("example_workers_route", new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Pattern = "example.com/*",
        Script = "my-workers-script",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WorkersRoute;
import com.pulumi.cloudflare.WorkersRouteArgs;
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 exampleWorkersRoute = new WorkersRoute("exampleWorkersRoute", WorkersRouteArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .pattern("example.com/*")
            .script("my-workers-script")
            .build());

    }
}

    resources:
  exampleWorkersRoute:
    type: cloudflare:WorkersRoute
    name: example_workers_route
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      pattern: example.com/*
      script: my-workers-script

    Create WorkersRoute Resource

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

    Constructor syntax

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

@overload
def WorkersRoute(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 pattern: Optional[str] = None,
                 script: Optional[str] = None,
                 zone_id: Optional[str] = None)
    func NewWorkersRoute(ctx *Context, name string, args WorkersRouteArgs, opts ...ResourceOption) (*WorkersRoute, error)
    public WorkersRoute(string name, WorkersRouteArgs args, CustomResourceOptions? opts = null)
    public WorkersRoute(String name, WorkersRouteArgs args)
public WorkersRoute(String name, WorkersRouteArgs args, CustomResourceOptions options)

    type: cloudflare:WorkersRoute
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 WorkersRouteArgs
    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 WorkersRouteArgs
    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 WorkersRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkersRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkersRouteArgs
    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 workersRouteResource = new Cloudflare.WorkersRoute("workersRouteResource", new()
{
    Pattern = "string",
    Script = "string",
    ZoneId = "string",
});

    example, err := cloudflare.NewWorkersRoute(ctx, "workersRouteResource", &cloudflare.WorkersRouteArgs{
	Pattern: pulumi.String("string"),
	Script:  pulumi.String("string"),
	ZoneId:  pulumi.String("string"),
})

    var workersRouteResource = new WorkersRoute("workersRouteResource", WorkersRouteArgs.builder()
    .pattern("string")
    .script("string")
    .zoneId("string")
    .build());

    workers_route_resource = cloudflare.WorkersRoute("workersRouteResource",
    pattern="string",
    script="string",
    zone_id="string")

    const workersRouteResource = new cloudflare.WorkersRoute("workersRouteResource", {
    pattern: "string",
    script: "string",
    zoneId: "string",
});

    type: cloudflare:WorkersRoute
properties:
    pattern: string
    script: string
    zoneId: string

    WorkersRoute 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 WorkersRoute resource accepts the following input properties:

    Pattern string
    Pattern to match incoming requests against. Learn more.
    Script string
    Name of the script to run if the route matches.
    ZoneId string
    Identifier.
    Pattern string
    Pattern to match incoming requests against. Learn more.
    Script string
    Name of the script to run if the route matches.
    ZoneId string
    Identifier.
    pattern String
    Pattern to match incoming requests against. Learn more.
    script String
    Name of the script to run if the route matches.
    zoneId String
    Identifier.
    pattern string
    Pattern to match incoming requests against. Learn more.
    script string
    Name of the script to run if the route matches.
    zoneId string
    Identifier.
    pattern str
    Pattern to match incoming requests against. Learn more.
    script str
    Name of the script to run if the route matches.
    zone_id str
    Identifier.
    pattern String
    Pattern to match incoming requests against. Learn more.
    script String
    Name of the script to run if the route matches.
    zoneId String
    Identifier.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkersRoute Resource

    Get an existing WorkersRoute 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?: WorkersRouteState, opts?: CustomResourceOptions): WorkersRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        pattern: Optional[str] = None,
        script: Optional[str] = None,
        zone_id: Optional[str] = None) -> WorkersRoute
    func GetWorkersRoute(ctx *Context, name string, id IDInput, state *WorkersRouteState, opts ...ResourceOption) (*WorkersRoute, error)
    public static WorkersRoute Get(string name, Input<string> id, WorkersRouteState? state, CustomResourceOptions? opts = null)
    public static WorkersRoute get(String name, Output<String> id, WorkersRouteState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:WorkersRoute    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:
    Pattern string
    Pattern to match incoming requests against. Learn more.
    Script string
    Name of the script to run if the route matches.
    ZoneId string
    Identifier.
    Pattern string
    Pattern to match incoming requests against. Learn more.
    Script string
    Name of the script to run if the route matches.
    ZoneId string
    Identifier.
    pattern String
    Pattern to match incoming requests against. Learn more.
    script String
    Name of the script to run if the route matches.
    zoneId String
    Identifier.
    pattern string
    Pattern to match incoming requests against. Learn more.
    script string
    Name of the script to run if the route matches.
    zoneId string
    Identifier.
    pattern str
    Pattern to match incoming requests against. Learn more.
    script str
    Name of the script to run if the route matches.
    zone_id str
    Identifier.
    pattern String
    Pattern to match incoming requests against. Learn more.
    script String
    Name of the script to run if the route matches.
    zoneId String
    Identifier.

    Import

    $ pulumi import cloudflare:index/workersRoute:WorkersRoute example '<zone_id>/<route_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
    Cloudflare v6.2.0 published on Tuesday, May 13, 2025 by Pulumi
    pulumi/pulumi-cloudflare