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

cloudflare.WorkersScriptSubdomain

Explore with Pulumi AI

Cloudflare v6.0.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-cloudflare

Example Usage

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

const exampleWorkersScriptSubdomain = new cloudflare.WorkersScriptSubdomain("example_workers_script_subdomain", {
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    scriptName: "this-is_my_script-01",
    enabled: true,
    previewsEnabled: true,
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_workers_script_subdomain = cloudflare.WorkersScriptSubdomain("example_workers_script_subdomain",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    script_name="this-is_my_script-01",
    enabled=True,
    previews_enabled=True)
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.NewWorkersScriptSubdomain(ctx, "example_workers_script_subdomain", &cloudflare.WorkersScriptSubdomainArgs{
			AccountId:       pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			ScriptName:      pulumi.String("this-is_my_script-01"),
			Enabled:         pulumi.Bool(true),
			PreviewsEnabled: pulumi.Bool(true),
		})
		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 exampleWorkersScriptSubdomain = new Cloudflare.WorkersScriptSubdomain("example_workers_script_subdomain", new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        ScriptName = "this-is_my_script-01",
        Enabled = true,
        PreviewsEnabled = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WorkersScriptSubdomain;
import com.pulumi.cloudflare.WorkersScriptSubdomainArgs;
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 exampleWorkersScriptSubdomain = new WorkersScriptSubdomain("exampleWorkersScriptSubdomain", WorkersScriptSubdomainArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .scriptName("this-is_my_script-01")
            .enabled(true)
            .previewsEnabled(true)
            .build());

    }
}
Copy
resources:
  exampleWorkersScriptSubdomain:
    type: cloudflare:WorkersScriptSubdomain
    name: example_workers_script_subdomain
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      scriptName: this-is_my_script-01
      enabled: true
      previewsEnabled: true
Copy

Create WorkersScriptSubdomain Resource

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

Constructor syntax

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

@overload
def WorkersScriptSubdomain(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_id: Optional[str] = None,
                           enabled: Optional[bool] = None,
                           script_name: Optional[str] = None,
                           previews_enabled: Optional[bool] = None)
func NewWorkersScriptSubdomain(ctx *Context, name string, args WorkersScriptSubdomainArgs, opts ...ResourceOption) (*WorkersScriptSubdomain, error)
public WorkersScriptSubdomain(string name, WorkersScriptSubdomainArgs args, CustomResourceOptions? opts = null)
public WorkersScriptSubdomain(String name, WorkersScriptSubdomainArgs args)
public WorkersScriptSubdomain(String name, WorkersScriptSubdomainArgs args, CustomResourceOptions options)

type: cloudflare:WorkersScriptSubdomain
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. WorkersScriptSubdomainArgs
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. WorkersScriptSubdomainArgs
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. WorkersScriptSubdomainArgs
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. WorkersScriptSubdomainArgs
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. WorkersScriptSubdomainArgs
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 workersScriptSubdomainResource = new Cloudflare.WorkersScriptSubdomain("workersScriptSubdomainResource", new()
{
    AccountId = "string",
    Enabled = false,
    ScriptName = "string",
    PreviewsEnabled = false,
});
Copy
example, err := cloudflare.NewWorkersScriptSubdomain(ctx, "workersScriptSubdomainResource", &cloudflare.WorkersScriptSubdomainArgs{
	AccountId:       pulumi.String("string"),
	Enabled:         pulumi.Bool(false),
	ScriptName:      pulumi.String("string"),
	PreviewsEnabled: pulumi.Bool(false),
})
Copy
var workersScriptSubdomainResource = new WorkersScriptSubdomain("workersScriptSubdomainResource", WorkersScriptSubdomainArgs.builder()
    .accountId("string")
    .enabled(false)
    .scriptName("string")
    .previewsEnabled(false)
    .build());
Copy
workers_script_subdomain_resource = cloudflare.WorkersScriptSubdomain("workersScriptSubdomainResource",
    account_id="string",
    enabled=False,
    script_name="string",
    previews_enabled=False)
Copy
const workersScriptSubdomainResource = new cloudflare.WorkersScriptSubdomain("workersScriptSubdomainResource", {
    accountId: "string",
    enabled: false,
    scriptName: "string",
    previewsEnabled: false,
});
Copy
type: cloudflare:WorkersScriptSubdomain
properties:
    accountId: string
    enabled: false
    previewsEnabled: false
    scriptName: string
Copy

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

AccountId This property is required. string
Identifier
Enabled This property is required. bool
Whether the Worker should be available on the workers.dev subdomain.
ScriptName This property is required. string
Name of the script, used in URLs and route configuration.
PreviewsEnabled bool
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
AccountId This property is required. string
Identifier
Enabled This property is required. bool
Whether the Worker should be available on the workers.dev subdomain.
ScriptName This property is required. string
Name of the script, used in URLs and route configuration.
PreviewsEnabled bool
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
accountId This property is required. String
Identifier
enabled This property is required. Boolean
Whether the Worker should be available on the workers.dev subdomain.
scriptName This property is required. String
Name of the script, used in URLs and route configuration.
previewsEnabled Boolean
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
accountId This property is required. string
Identifier
enabled This property is required. boolean
Whether the Worker should be available on the workers.dev subdomain.
scriptName This property is required. string
Name of the script, used in URLs and route configuration.
previewsEnabled boolean
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
account_id This property is required. str
Identifier
enabled This property is required. bool
Whether the Worker should be available on the workers.dev subdomain.
script_name This property is required. str
Name of the script, used in URLs and route configuration.
previews_enabled bool
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
accountId This property is required. String
Identifier
enabled This property is required. Boolean
Whether the Worker should be available on the workers.dev subdomain.
scriptName This property is required. String
Name of the script, used in URLs and route configuration.
previewsEnabled Boolean
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkersScriptSubdomain 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 WorkersScriptSubdomain Resource

Get an existing WorkersScriptSubdomain 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?: WorkersScriptSubdomainState, opts?: CustomResourceOptions): WorkersScriptSubdomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        previews_enabled: Optional[bool] = None,
        script_name: Optional[str] = None) -> WorkersScriptSubdomain
func GetWorkersScriptSubdomain(ctx *Context, name string, id IDInput, state *WorkersScriptSubdomainState, opts ...ResourceOption) (*WorkersScriptSubdomain, error)
public static WorkersScriptSubdomain Get(string name, Input<string> id, WorkersScriptSubdomainState? state, CustomResourceOptions? opts = null)
public static WorkersScriptSubdomain get(String name, Output<String> id, WorkersScriptSubdomainState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:WorkersScriptSubdomain    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:
AccountId string
Identifier
Enabled bool
Whether the Worker should be available on the workers.dev subdomain.
PreviewsEnabled bool
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
ScriptName string
Name of the script, used in URLs and route configuration.
AccountId string
Identifier
Enabled bool
Whether the Worker should be available on the workers.dev subdomain.
PreviewsEnabled bool
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
ScriptName string
Name of the script, used in URLs and route configuration.
accountId String
Identifier
enabled Boolean
Whether the Worker should be available on the workers.dev subdomain.
previewsEnabled Boolean
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
scriptName String
Name of the script, used in URLs and route configuration.
accountId string
Identifier
enabled boolean
Whether the Worker should be available on the workers.dev subdomain.
previewsEnabled boolean
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
scriptName string
Name of the script, used in URLs and route configuration.
account_id str
Identifier
enabled bool
Whether the Worker should be available on the workers.dev subdomain.
previews_enabled bool
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
script_name str
Name of the script, used in URLs and route configuration.
accountId String
Identifier
enabled Boolean
Whether the Worker should be available on the workers.dev subdomain.
previewsEnabled Boolean
Whether the Worker's Preview URLs should be available on the workers.dev subdomain.
scriptName String
Name of the script, used in URLs and route configuration.

Package Details

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