1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WorkersRoute
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi

cloudflare.WorkersRoute

Explore with Pulumi AI

Provides a Cloudflare worker route resource. A route will also require a cloudflare.WorkerScript.

Example Usage

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

const myScript = new cloudflare.WorkersScript("my_script", {});
// Runs the specified worker script for all URLs that match `example.com/*`
const myRoute = new cloudflare.WorkersRoute("my_route", {
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
    pattern: "example.com/*",
    scriptName: myScript.name,
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

my_script = cloudflare.WorkersScript("my_script")
# Runs the specified worker script for all URLs that match `example.com/*`
my_route = cloudflare.WorkersRoute("my_route",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711",
    pattern="example.com/*",
    script_name=my_script.name)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myScript, err := cloudflare.NewWorkersScript(ctx, "my_script", nil)
		if err != nil {
			return err
		}
		// Runs the specified worker script for all URLs that match `example.com/*`
		_, err = cloudflare.NewWorkersRoute(ctx, "my_route", &cloudflare.WorkersRouteArgs{
			ZoneId:     pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
			Pattern:    pulumi.String("example.com/*"),
			ScriptName: myScript.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var myScript = new Cloudflare.WorkersScript("my_script");

    // Runs the specified worker script for all URLs that match `example.com/*`
    var myRoute = new Cloudflare.WorkersRoute("my_route", new()
    {
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
        Pattern = "example.com/*",
        ScriptName = myScript.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WorkersScript;
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 myScript = new WorkersScript("myScript");

        // Runs the specified worker script for all URLs that match `example.com/*`
        var myRoute = new WorkersRoute("myRoute", WorkersRouteArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .pattern("example.com/*")
            .scriptName(myScript.name())
            .build());

    }
}
Copy
resources:
  # Runs the specified worker script for all URLs that match `example.com/*`
  myRoute:
    type: cloudflare:WorkersRoute
    name: my_route
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      pattern: example.com/*
      scriptName: ${myScript.name}
  myScript:
    type: cloudflare:WorkersScript
    name: my_script
Copy

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,
                 zone_id: Optional[str] = None,
                 script_name: 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 This property is required. string
The unique name of the resource.
args This property is required. WorkersRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. WorkersRouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkersRouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    ZoneId = "string",
    ScriptName = "string",
});
Copy
example, err := cloudflare.NewWorkersRoute(ctx, "workersRouteResource", &cloudflare.WorkersRouteArgs{
	Pattern:    pulumi.String("string"),
	ZoneId:     pulumi.String("string"),
	ScriptName: pulumi.String("string"),
})
Copy
var workersRouteResource = new WorkersRoute("workersRouteResource", WorkersRouteArgs.builder()
    .pattern("string")
    .zoneId("string")
    .scriptName("string")
    .build());
Copy
workers_route_resource = cloudflare.WorkersRoute("workersRouteResource",
    pattern="string",
    zone_id="string",
    script_name="string")
Copy
const workersRouteResource = new cloudflare.WorkersRoute("workersRouteResource", {
    pattern: "string",
    zoneId: "string",
    scriptName: "string",
});
Copy
type: cloudflare:WorkersRoute
properties:
    pattern: string
    scriptName: string
    zoneId: string
Copy

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 This property is required. string
The route pattern to associate the Worker with.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
ScriptName string
Worker script name to invoke for requests that match the route pattern.
Pattern This property is required. string
The route pattern to associate the Worker with.
ZoneId
This property is required.
Changes to this property will trigger replacement.
string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
ScriptName string
Worker script name to invoke for requests that match the route pattern.
pattern This property is required. String
The route pattern to associate the Worker with.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
scriptName String
Worker script name to invoke for requests that match the route pattern.
pattern This property is required. string
The route pattern to associate the Worker with.
zoneId
This property is required.
Changes to this property will trigger replacement.
string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
scriptName string
Worker script name to invoke for requests that match the route pattern.
pattern This property is required. str
The route pattern to associate the Worker with.
zone_id
This property is required.
Changes to this property will trigger replacement.
str
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
script_name str
Worker script name to invoke for requests that match the route pattern.
pattern This property is required. String
The route pattern to associate the Worker with.
zoneId
This property is required.
Changes to this property will trigger replacement.
String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
scriptName String
Worker script name to invoke for requests that match the route pattern.

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_name: 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
The route pattern to associate the Worker with.
ScriptName string
Worker script name to invoke for requests that match the route pattern.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Pattern string
The route pattern to associate the Worker with.
ScriptName string
Worker script name to invoke for requests that match the route pattern.
ZoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
pattern String
The route pattern to associate the Worker with.
scriptName String
Worker script name to invoke for requests that match the route pattern.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
pattern string
The route pattern to associate the Worker with.
scriptName string
Worker script name to invoke for requests that match the route pattern.
zoneId Changes to this property will trigger replacement. string
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
pattern str
The route pattern to associate the Worker with.
script_name str
Worker script name to invoke for requests that match the route pattern.
zone_id Changes to this property will trigger replacement. str
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
pattern String
The route pattern to associate the Worker with.
scriptName String
Worker script name to invoke for requests that match the route pattern.
zoneId Changes to this property will trigger replacement. String
The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

Import

$ pulumi import cloudflare:index/workersRoute:WorkersRoute example <zone_id>/<route_id>
Copy

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.