Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WorkersRoute
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.WorkersRoute

Explore with Pulumi AI

Cloudflare v6.1.1 published on Monday, Apr 21, 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.net/*",
    script: "this-is_my_script-01",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_workers_route = cloudflare.WorkersRoute("example_workers_route",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    pattern="example.net/*",
    script="this-is_my_script-01")
Copy
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.net/*"),
			Script:  pulumi.String("this-is_my_script-01"),
		})
		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 exampleWorkersRoute = new Cloudflare.WorkersRoute("example_workers_route", new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Pattern = "example.net/*",
        Script = "this-is_my_script-01",
    });

});
Copy
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.net/*")
            .script("this-is_my_script-01")
            .build());

    }
}
Copy
resources:
  exampleWorkersRoute:
    type: cloudflare:WorkersRoute
    name: example_workers_route
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      pattern: example.net/*
      script: this-is_my_script-01
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,
                 route_id: Optional[str] = None,
                 script: 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",
    RouteId = "string",
    Script = "string",
});
Copy
example, err := cloudflare.NewWorkersRoute(ctx, "workersRouteResource", &cloudflare.WorkersRouteArgs{
	Pattern: pulumi.String("string"),
	ZoneId:  pulumi.String("string"),
	RouteId: pulumi.String("string"),
	Script:  pulumi.String("string"),
})
Copy
var workersRouteResource = new WorkersRoute("workersRouteResource", WorkersRouteArgs.builder()
    .pattern("string")
    .zoneId("string")
    .routeId("string")
    .script("string")
    .build());
Copy
workers_route_resource = cloudflare.WorkersRoute("workersRouteResource",
    pattern="string",
    zone_id="string",
    route_id="string",
    script="string")
Copy
const workersRouteResource = new cloudflare.WorkersRoute("workersRouteResource", {
    pattern: "string",
    zoneId: "string",
    routeId: "string",
    script: "string",
});
Copy
type: cloudflare:WorkersRoute
properties:
    pattern: string
    routeId: string
    script: 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
ZoneId This property is required. string
Identifier.
RouteId string
Identifier.
Script string
Name of the script, used in URLs and route configuration.
Pattern This property is required. string
ZoneId This property is required. string
Identifier.
RouteId string
Identifier.
Script string
Name of the script, used in URLs and route configuration.
pattern This property is required. String
zoneId This property is required. String
Identifier.
routeId String
Identifier.
script String
Name of the script, used in URLs and route configuration.
pattern This property is required. string
zoneId This property is required. string
Identifier.
routeId string
Identifier.
script string
Name of the script, used in URLs and route configuration.
pattern This property is required. str
zone_id This property is required. str
Identifier.
route_id str
Identifier.
script str
Name of the script, used in URLs and route configuration.
pattern This property is required. String
zoneId This property is required. String
Identifier.
routeId String
Identifier.
script String
Name of the script, used in URLs and route configuration.

Outputs

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

Errors List<WorkersRouteError>
Id string
The provider-assigned unique ID for this managed resource.
Messages List<WorkersRouteMessage>
Success bool
Whether the API call was successful.
Errors []WorkersRouteError
Id string
The provider-assigned unique ID for this managed resource.
Messages []WorkersRouteMessage
Success bool
Whether the API call was successful.
errors List<WorkersRouteError>
id String
The provider-assigned unique ID for this managed resource.
messages List<WorkersRouteMessage>
success Boolean
Whether the API call was successful.
errors WorkersRouteError[]
id string
The provider-assigned unique ID for this managed resource.
messages WorkersRouteMessage[]
success boolean
Whether the API call was successful.
errors Sequence[WorkersRouteError]
id str
The provider-assigned unique ID for this managed resource.
messages Sequence[WorkersRouteMessage]
success bool
Whether the API call was successful.
errors List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
messages List<Property Map>
success Boolean
Whether the API call was successful.

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,
        errors: Optional[Sequence[WorkersRouteErrorArgs]] = None,
        messages: Optional[Sequence[WorkersRouteMessageArgs]] = None,
        pattern: Optional[str] = None,
        route_id: Optional[str] = None,
        script: Optional[str] = None,
        success: Optional[bool] = 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:
Errors List<WorkersRouteError>
Messages List<WorkersRouteMessage>
Pattern string
RouteId string
Identifier.
Script string
Name of the script, used in URLs and route configuration.
Success bool
Whether the API call was successful.
ZoneId string
Identifier.
Errors []WorkersRouteErrorArgs
Messages []WorkersRouteMessageArgs
Pattern string
RouteId string
Identifier.
Script string
Name of the script, used in URLs and route configuration.
Success bool
Whether the API call was successful.
ZoneId string
Identifier.
errors List<WorkersRouteError>
messages List<WorkersRouteMessage>
pattern String
routeId String
Identifier.
script String
Name of the script, used in URLs and route configuration.
success Boolean
Whether the API call was successful.
zoneId String
Identifier.
errors WorkersRouteError[]
messages WorkersRouteMessage[]
pattern string
routeId string
Identifier.
script string
Name of the script, used in URLs and route configuration.
success boolean
Whether the API call was successful.
zoneId string
Identifier.
errors Sequence[WorkersRouteErrorArgs]
messages Sequence[WorkersRouteMessageArgs]
pattern str
route_id str
Identifier.
script str
Name of the script, used in URLs and route configuration.
success bool
Whether the API call was successful.
zone_id str
Identifier.
errors List<Property Map>
messages List<Property Map>
pattern String
routeId String
Identifier.
script String
Name of the script, used in URLs and route configuration.
success Boolean
Whether the API call was successful.
zoneId String
Identifier.

Supporting Types

WorkersRouteError
, WorkersRouteErrorArgs

WorkersRouteErrorSource
, WorkersRouteErrorSourceArgs

Pointer string
Pointer string
pointer String
pointer string
pointer String

WorkersRouteMessage
, WorkersRouteMessageArgs

WorkersRouteMessageSource
, WorkersRouteMessageSourceArgs

Pointer string
Pointer string
pointer String
pointer string
pointer String

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi
pulumi/pulumi-cloudflare