WorkersRoute

class WorkersRoute : KotlinCustomResource

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,
});
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)
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,
});
});
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
})
}
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());
}
}
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

Import

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

////////////

Properties

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val pattern: Output<String>

The route pattern to associate the Worker with.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val scriptName: Output<String>?

Worker script name to invoke for requests that match the route pattern.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val zoneId: Output<String>

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.