Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. WorkersScript
Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.WorkersScript

Explore with Pulumi AI

Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  exampleWorkersScript:
    type: cloudflare:WorkersScript
    name: example_workers_script
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      scriptName: this-is_my_script-01
      assets:
        config:
          htmlHandling: auto-trailing-slash
          notFoundHandling: none
          runWorkerFirst: false
          serveDirectly: true
        jwt: jwt
      bindings:
        - name: MY_ENV_VAR
          type: plain_text
      bodyPart: worker.js
      compatibilityDate: 2021-01-01
      compatibilityFlags:
        - nodejs_compat
      content:
        fn::invoke:
          function: std:file
          arguments:
            input: worker.js
          return: result
      keepAssets: false
      keepBindings:
        - string
      logpush: false
      mainModule: worker.js
      migrations:
        deleted_classes:
          - string
        new_classes:
          - string
        new_sqlite_classes:
          - string
        new_tag: v2
        old_tag: v1
        renamed_classes:
          - from: from
            to: to
        transferred_classes:
          - from: from
            fromScript: from_script
            to: to
      observability:
        enabled: true
        head_sampling_rate: 0.1
      placement:
        mode: smart
      tags:
        - string
      tailConsumers:
        - service: my-log-consumer
          environment: production
          namespace: my-namespace
      usageModel: standard
Copy

Create WorkersScript Resource

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

Constructor syntax

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

@overload
def WorkersScript(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  content: Optional[str] = None,
                  script_name: Optional[str] = None,
                  account_id: Optional[str] = None,
                  keep_bindings: Optional[Sequence[str]] = None,
                  main_module: Optional[str] = None,
                  compatibility_flags: Optional[Sequence[str]] = None,
                  body_part: Optional[str] = None,
                  keep_assets: Optional[bool] = None,
                  bindings: Optional[Sequence[WorkersScriptBindingArgs]] = None,
                  logpush: Optional[bool] = None,
                  compatibility_date: Optional[str] = None,
                  migrations: Optional[WorkersScriptMigrationsArgs] = None,
                  observability: Optional[WorkersScriptObservabilityArgs] = None,
                  placement: Optional[WorkersScriptPlacementArgs] = None,
                  assets: Optional[WorkersScriptAssetsArgs] = None,
                  tail_consumers: Optional[Sequence[WorkersScriptTailConsumerArgs]] = None,
                  usage_model: Optional[str] = None)
func NewWorkersScript(ctx *Context, name string, args WorkersScriptArgs, opts ...ResourceOption) (*WorkersScript, error)
public WorkersScript(string name, WorkersScriptArgs args, CustomResourceOptions? opts = null)
public WorkersScript(String name, WorkersScriptArgs args)
public WorkersScript(String name, WorkersScriptArgs args, CustomResourceOptions options)

type: cloudflare:WorkersScript
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. WorkersScriptArgs
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. WorkersScriptArgs
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. WorkersScriptArgs
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. WorkersScriptArgs
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. WorkersScriptArgs
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 workersScriptResource = new Cloudflare.WorkersScript("workersScriptResource", new()
{
    Content = "string",
    ScriptName = "string",
    AccountId = "string",
    KeepBindings = new[]
    {
        "string",
    },
    MainModule = "string",
    CompatibilityFlags = new[]
    {
        "string",
    },
    BodyPart = "string",
    KeepAssets = false,
    Bindings = new[]
    {
        new Cloudflare.Inputs.WorkersScriptBindingArgs
        {
            Name = "string",
            Type = "string",
            Environment = "string",
            Namespace = "string",
            BucketName = "string",
            Id = "string",
            IndexName = "string",
            Json = "string",
            ClassName = "string",
            Dataset = "string",
            NamespaceId = "string",
            Outbound = new Cloudflare.Inputs.WorkersScriptBindingOutboundArgs
            {
                Params = new[]
                {
                    "string",
                },
                Worker = new Cloudflare.Inputs.WorkersScriptBindingOutboundWorkerArgs
                {
                    Environment = "string",
                    Service = "string",
                },
            },
            QueueName = "string",
            ScriptName = "string",
            Service = "string",
            Text = "string",
            CertificateId = "string",
        },
    },
    Logpush = false,
    CompatibilityDate = "string",
    Migrations = new Cloudflare.Inputs.WorkersScriptMigrationsArgs
    {
        DeletedClasses = new[]
        {
            "string",
        },
        NewClasses = new[]
        {
            "string",
        },
        NewSqliteClasses = new[]
        {
            "string",
        },
        NewTag = "string",
        OldTag = "string",
        RenamedClasses = new[]
        {
            new Cloudflare.Inputs.WorkersScriptMigrationsRenamedClassArgs
            {
                From = "string",
                To = "string",
            },
        },
        Steps = new[]
        {
            new Cloudflare.Inputs.WorkersScriptMigrationsStepArgs
            {
                DeletedClasses = new[]
                {
                    "string",
                },
                NewClasses = new[]
                {
                    "string",
                },
                NewSqliteClasses = new[]
                {
                    "string",
                },
                RenamedClasses = new[]
                {
                    new Cloudflare.Inputs.WorkersScriptMigrationsStepRenamedClassArgs
                    {
                        From = "string",
                        To = "string",
                    },
                },
                TransferredClasses = new[]
                {
                    new Cloudflare.Inputs.WorkersScriptMigrationsStepTransferredClassArgs
                    {
                        From = "string",
                        FromScript = "string",
                        To = "string",
                    },
                },
            },
        },
        TransferredClasses = new[]
        {
            new Cloudflare.Inputs.WorkersScriptMigrationsTransferredClassArgs
            {
                From = "string",
                FromScript = "string",
                To = "string",
            },
        },
    },
    Observability = new Cloudflare.Inputs.WorkersScriptObservabilityArgs
    {
        Enabled = false,
        HeadSamplingRate = 0,
    },
    Placement = new Cloudflare.Inputs.WorkersScriptPlacementArgs
    {
        Mode = "string",
        Status = "string",
    },
    Assets = new Cloudflare.Inputs.WorkersScriptAssetsArgs
    {
        Config = new Cloudflare.Inputs.WorkersScriptAssetsConfigArgs
        {
            _headers = "string",
            _redirects = "string",
            HtmlHandling = "string",
            NotFoundHandling = "string",
            RunWorkerFirst = false,
        },
        Jwt = "string",
    },
    TailConsumers = new[]
    {
        new Cloudflare.Inputs.WorkersScriptTailConsumerArgs
        {
            Service = "string",
            Environment = "string",
            Namespace = "string",
        },
    },
    UsageModel = "string",
});
Copy
example, err := cloudflare.NewWorkersScript(ctx, "workersScriptResource", &cloudflare.WorkersScriptArgs{
	Content:    pulumi.String("string"),
	ScriptName: pulumi.String("string"),
	AccountId:  pulumi.String("string"),
	KeepBindings: pulumi.StringArray{
		pulumi.String("string"),
	},
	MainModule: pulumi.String("string"),
	CompatibilityFlags: pulumi.StringArray{
		pulumi.String("string"),
	},
	BodyPart:   pulumi.String("string"),
	KeepAssets: pulumi.Bool(false),
	Bindings: cloudflare.WorkersScriptBindingArray{
		&cloudflare.WorkersScriptBindingArgs{
			Name:        pulumi.String("string"),
			Type:        pulumi.String("string"),
			Environment: pulumi.String("string"),
			Namespace:   pulumi.String("string"),
			BucketName:  pulumi.String("string"),
			Id:          pulumi.String("string"),
			IndexName:   pulumi.String("string"),
			Json:        pulumi.String("string"),
			ClassName:   pulumi.String("string"),
			Dataset:     pulumi.String("string"),
			NamespaceId: pulumi.String("string"),
			Outbound: &cloudflare.WorkersScriptBindingOutboundArgs{
				Params: pulumi.StringArray{
					pulumi.String("string"),
				},
				Worker: &cloudflare.WorkersScriptBindingOutboundWorkerArgs{
					Environment: pulumi.String("string"),
					Service:     pulumi.String("string"),
				},
			},
			QueueName:     pulumi.String("string"),
			ScriptName:    pulumi.String("string"),
			Service:       pulumi.String("string"),
			Text:          pulumi.String("string"),
			CertificateId: pulumi.String("string"),
		},
	},
	Logpush:           pulumi.Bool(false),
	CompatibilityDate: pulumi.String("string"),
	Migrations: &cloudflare.WorkersScriptMigrationsArgs{
		DeletedClasses: pulumi.StringArray{
			pulumi.String("string"),
		},
		NewClasses: pulumi.StringArray{
			pulumi.String("string"),
		},
		NewSqliteClasses: pulumi.StringArray{
			pulumi.String("string"),
		},
		NewTag: pulumi.String("string"),
		OldTag: pulumi.String("string"),
		RenamedClasses: cloudflare.WorkersScriptMigrationsRenamedClassArray{
			&cloudflare.WorkersScriptMigrationsRenamedClassArgs{
				From: pulumi.String("string"),
				To:   pulumi.String("string"),
			},
		},
		Steps: cloudflare.WorkersScriptMigrationsStepArray{
			&cloudflare.WorkersScriptMigrationsStepArgs{
				DeletedClasses: pulumi.StringArray{
					pulumi.String("string"),
				},
				NewClasses: pulumi.StringArray{
					pulumi.String("string"),
				},
				NewSqliteClasses: pulumi.StringArray{
					pulumi.String("string"),
				},
				RenamedClasses: cloudflare.WorkersScriptMigrationsStepRenamedClassArray{
					&cloudflare.WorkersScriptMigrationsStepRenamedClassArgs{
						From: pulumi.String("string"),
						To:   pulumi.String("string"),
					},
				},
				TransferredClasses: cloudflare.WorkersScriptMigrationsStepTransferredClassArray{
					&cloudflare.WorkersScriptMigrationsStepTransferredClassArgs{
						From:       pulumi.String("string"),
						FromScript: pulumi.String("string"),
						To:         pulumi.String("string"),
					},
				},
			},
		},
		TransferredClasses: cloudflare.WorkersScriptMigrationsTransferredClassArray{
			&cloudflare.WorkersScriptMigrationsTransferredClassArgs{
				From:       pulumi.String("string"),
				FromScript: pulumi.String("string"),
				To:         pulumi.String("string"),
			},
		},
	},
	Observability: &cloudflare.WorkersScriptObservabilityArgs{
		Enabled:          pulumi.Bool(false),
		HeadSamplingRate: pulumi.Float64(0),
	},
	Placement: &cloudflare.WorkersScriptPlacementArgs{
		Mode:   pulumi.String("string"),
		Status: pulumi.String("string"),
	},
	Assets: &cloudflare.WorkersScriptAssetsArgs{
		Config: &cloudflare.WorkersScriptAssetsConfigArgs{
			_headers:         pulumi.String("string"),
			_redirects:       pulumi.String("string"),
			HtmlHandling:     pulumi.String("string"),
			NotFoundHandling: pulumi.String("string"),
			RunWorkerFirst:   pulumi.Bool(false),
		},
		Jwt: pulumi.String("string"),
	},
	TailConsumers: cloudflare.WorkersScriptTailConsumerArray{
		&cloudflare.WorkersScriptTailConsumerArgs{
			Service:     pulumi.String("string"),
			Environment: pulumi.String("string"),
			Namespace:   pulumi.String("string"),
		},
	},
	UsageModel: pulumi.String("string"),
})
Copy
var workersScriptResource = new WorkersScript("workersScriptResource", WorkersScriptArgs.builder()
    .content("string")
    .scriptName("string")
    .accountId("string")
    .keepBindings("string")
    .mainModule("string")
    .compatibilityFlags("string")
    .bodyPart("string")
    .keepAssets(false)
    .bindings(WorkersScriptBindingArgs.builder()
        .name("string")
        .type("string")
        .environment("string")
        .namespace("string")
        .bucketName("string")
        .id("string")
        .indexName("string")
        .json("string")
        .className("string")
        .dataset("string")
        .namespaceId("string")
        .outbound(WorkersScriptBindingOutboundArgs.builder()
            .params("string")
            .worker(WorkersScriptBindingOutboundWorkerArgs.builder()
                .environment("string")
                .service("string")
                .build())
            .build())
        .queueName("string")
        .scriptName("string")
        .service("string")
        .text("string")
        .certificateId("string")
        .build())
    .logpush(false)
    .compatibilityDate("string")
    .migrations(WorkersScriptMigrationsArgs.builder()
        .deletedClasses("string")
        .newClasses("string")
        .newSqliteClasses("string")
        .newTag("string")
        .oldTag("string")
        .renamedClasses(WorkersScriptMigrationsRenamedClassArgs.builder()
            .from("string")
            .to("string")
            .build())
        .steps(WorkersScriptMigrationsStepArgs.builder()
            .deletedClasses("string")
            .newClasses("string")
            .newSqliteClasses("string")
            .renamedClasses(WorkersScriptMigrationsStepRenamedClassArgs.builder()
                .from("string")
                .to("string")
                .build())
            .transferredClasses(WorkersScriptMigrationsStepTransferredClassArgs.builder()
                .from("string")
                .fromScript("string")
                .to("string")
                .build())
            .build())
        .transferredClasses(WorkersScriptMigrationsTransferredClassArgs.builder()
            .from("string")
            .fromScript("string")
            .to("string")
            .build())
        .build())
    .observability(WorkersScriptObservabilityArgs.builder()
        .enabled(false)
        .headSamplingRate(0)
        .build())
    .placement(WorkersScriptPlacementArgs.builder()
        .mode("string")
        .status("string")
        .build())
    .assets(WorkersScriptAssetsArgs.builder()
        .config(WorkersScriptAssetsConfigArgs.builder()
            ._headers("string")
            ._redirects("string")
            .htmlHandling("string")
            .notFoundHandling("string")
            .runWorkerFirst(false)
            .build())
        .jwt("string")
        .build())
    .tailConsumers(WorkersScriptTailConsumerArgs.builder()
        .service("string")
        .environment("string")
        .namespace("string")
        .build())
    .usageModel("string")
    .build());
Copy
workers_script_resource = cloudflare.WorkersScript("workersScriptResource",
    content="string",
    script_name="string",
    account_id="string",
    keep_bindings=["string"],
    main_module="string",
    compatibility_flags=["string"],
    body_part="string",
    keep_assets=False,
    bindings=[{
        "name": "string",
        "type": "string",
        "environment": "string",
        "namespace": "string",
        "bucket_name": "string",
        "id": "string",
        "index_name": "string",
        "json": "string",
        "class_name": "string",
        "dataset": "string",
        "namespace_id": "string",
        "outbound": {
            "params": ["string"],
            "worker": {
                "environment": "string",
                "service": "string",
            },
        },
        "queue_name": "string",
        "script_name": "string",
        "service": "string",
        "text": "string",
        "certificate_id": "string",
    }],
    logpush=False,
    compatibility_date="string",
    migrations={
        "deleted_classes": ["string"],
        "new_classes": ["string"],
        "new_sqlite_classes": ["string"],
        "new_tag": "string",
        "old_tag": "string",
        "renamed_classes": [{
            "from_": "string",
            "to": "string",
        }],
        "steps": [{
            "deleted_classes": ["string"],
            "new_classes": ["string"],
            "new_sqlite_classes": ["string"],
            "renamed_classes": [{
                "from_": "string",
                "to": "string",
            }],
            "transferred_classes": [{
                "from_": "string",
                "from_script": "string",
                "to": "string",
            }],
        }],
        "transferred_classes": [{
            "from_": "string",
            "from_script": "string",
            "to": "string",
        }],
    },
    observability={
        "enabled": False,
        "head_sampling_rate": 0,
    },
    placement={
        "mode": "string",
        "status": "string",
    },
    assets={
        "config": {
            "_headers": "string",
            "_redirects": "string",
            "html_handling": "string",
            "not_found_handling": "string",
            "run_worker_first": False,
        },
        "jwt": "string",
    },
    tail_consumers=[{
        "service": "string",
        "environment": "string",
        "namespace": "string",
    }],
    usage_model="string")
Copy
const workersScriptResource = new cloudflare.WorkersScript("workersScriptResource", {
    content: "string",
    scriptName: "string",
    accountId: "string",
    keepBindings: ["string"],
    mainModule: "string",
    compatibilityFlags: ["string"],
    bodyPart: "string",
    keepAssets: false,
    bindings: [{
        name: "string",
        type: "string",
        environment: "string",
        namespace: "string",
        bucketName: "string",
        id: "string",
        indexName: "string",
        json: "string",
        className: "string",
        dataset: "string",
        namespaceId: "string",
        outbound: {
            params: ["string"],
            worker: {
                environment: "string",
                service: "string",
            },
        },
        queueName: "string",
        scriptName: "string",
        service: "string",
        text: "string",
        certificateId: "string",
    }],
    logpush: false,
    compatibilityDate: "string",
    migrations: {
        deletedClasses: ["string"],
        newClasses: ["string"],
        newSqliteClasses: ["string"],
        newTag: "string",
        oldTag: "string",
        renamedClasses: [{
            from: "string",
            to: "string",
        }],
        steps: [{
            deletedClasses: ["string"],
            newClasses: ["string"],
            newSqliteClasses: ["string"],
            renamedClasses: [{
                from: "string",
                to: "string",
            }],
            transferredClasses: [{
                from: "string",
                fromScript: "string",
                to: "string",
            }],
        }],
        transferredClasses: [{
            from: "string",
            fromScript: "string",
            to: "string",
        }],
    },
    observability: {
        enabled: false,
        headSamplingRate: 0,
    },
    placement: {
        mode: "string",
        status: "string",
    },
    assets: {
        config: {
            _headers: "string",
            _redirects: "string",
            htmlHandling: "string",
            notFoundHandling: "string",
            runWorkerFirst: false,
        },
        jwt: "string",
    },
    tailConsumers: [{
        service: "string",
        environment: "string",
        namespace: "string",
    }],
    usageModel: "string",
});
Copy
type: cloudflare:WorkersScript
properties:
    accountId: string
    assets:
        config:
            _headers: string
            _redirects: string
            htmlHandling: string
            notFoundHandling: string
            runWorkerFirst: false
        jwt: string
    bindings:
        - bucketName: string
          certificateId: string
          className: string
          dataset: string
          environment: string
          id: string
          indexName: string
          json: string
          name: string
          namespace: string
          namespaceId: string
          outbound:
            params:
                - string
            worker:
                environment: string
                service: string
          queueName: string
          scriptName: string
          service: string
          text: string
          type: string
    bodyPart: string
    compatibilityDate: string
    compatibilityFlags:
        - string
    content: string
    keepAssets: false
    keepBindings:
        - string
    logpush: false
    mainModule: string
    migrations:
        deletedClasses:
            - string
        newClasses:
            - string
        newSqliteClasses:
            - string
        newTag: string
        oldTag: string
        renamedClasses:
            - from: string
              to: string
        steps:
            - deletedClasses:
                - string
              newClasses:
                - string
              newSqliteClasses:
                - string
              renamedClasses:
                - from: string
                  to: string
              transferredClasses:
                - from: string
                  fromScript: string
                  to: string
        transferredClasses:
            - from: string
              fromScript: string
              to: string
    observability:
        enabled: false
        headSamplingRate: 0
    placement:
        mode: string
        status: string
    scriptName: string
    tailConsumers:
        - environment: string
          namespace: string
          service: string
    usageModel: string
Copy

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

AccountId This property is required. string
Identifier.
Content This property is required. string
Module or Service Worker contents of the Worker.
ScriptName This property is required. string
Name of the script, used in URLs and route configuration.
Assets WorkersScriptAssets
Configuration for assets within a Worker
Bindings List<WorkersScriptBinding>
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
BodyPart string
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
CompatibilityDate string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
CompatibilityFlags List<string>
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
KeepAssets bool
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
KeepBindings List<string>
List of binding types to keep from previous_upload.
Logpush bool
Whether Logpush is turned on for the Worker.
MainModule string
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
Migrations WorkersScriptMigrations
Migrations to apply for Durable Objects associated with this Worker.
Observability WorkersScriptObservability
Observability settings for the Worker.
Placement WorkersScriptPlacement
Configuration for Smart Placement.
TailConsumers List<WorkersScriptTailConsumer>
List of Workers that will consume logs from the attached Worker.
UsageModel string
Usage model for the Worker invocations. Available values: "standard".
AccountId This property is required. string
Identifier.
Content This property is required. string
Module or Service Worker contents of the Worker.
ScriptName This property is required. string
Name of the script, used in URLs and route configuration.
Assets WorkersScriptAssetsArgs
Configuration for assets within a Worker
Bindings []WorkersScriptBindingArgs
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
BodyPart string
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
CompatibilityDate string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
CompatibilityFlags []string
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
KeepAssets bool
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
KeepBindings []string
List of binding types to keep from previous_upload.
Logpush bool
Whether Logpush is turned on for the Worker.
MainModule string
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
Migrations WorkersScriptMigrationsArgs
Migrations to apply for Durable Objects associated with this Worker.
Observability WorkersScriptObservabilityArgs
Observability settings for the Worker.
Placement WorkersScriptPlacementArgs
Configuration for Smart Placement.
TailConsumers []WorkersScriptTailConsumerArgs
List of Workers that will consume logs from the attached Worker.
UsageModel string
Usage model for the Worker invocations. Available values: "standard".
accountId This property is required. String
Identifier.
content This property is required. String
Module or Service Worker contents of the Worker.
scriptName This property is required. String
Name of the script, used in URLs and route configuration.
assets WorkersScriptAssets
Configuration for assets within a Worker
bindings List<WorkersScriptBinding>
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
bodyPart String
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibilityDate String
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibilityFlags List<String>
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
keepAssets Boolean
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keepBindings List<String>
List of binding types to keep from previous_upload.
logpush Boolean
Whether Logpush is turned on for the Worker.
mainModule String
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations WorkersScriptMigrations
Migrations to apply for Durable Objects associated with this Worker.
observability WorkersScriptObservability
Observability settings for the Worker.
placement WorkersScriptPlacement
Configuration for Smart Placement.
tailConsumers List<WorkersScriptTailConsumer>
List of Workers that will consume logs from the attached Worker.
usageModel String
Usage model for the Worker invocations. Available values: "standard".
accountId This property is required. string
Identifier.
content This property is required. string
Module or Service Worker contents of the Worker.
scriptName This property is required. string
Name of the script, used in URLs and route configuration.
assets WorkersScriptAssets
Configuration for assets within a Worker
bindings WorkersScriptBinding[]
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
bodyPart string
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibilityDate string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibilityFlags string[]
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
keepAssets boolean
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keepBindings string[]
List of binding types to keep from previous_upload.
logpush boolean
Whether Logpush is turned on for the Worker.
mainModule string
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations WorkersScriptMigrations
Migrations to apply for Durable Objects associated with this Worker.
observability WorkersScriptObservability
Observability settings for the Worker.
placement WorkersScriptPlacement
Configuration for Smart Placement.
tailConsumers WorkersScriptTailConsumer[]
List of Workers that will consume logs from the attached Worker.
usageModel string
Usage model for the Worker invocations. Available values: "standard".
account_id This property is required. str
Identifier.
content This property is required. str
Module or Service Worker contents of the Worker.
script_name This property is required. str
Name of the script, used in URLs and route configuration.
assets WorkersScriptAssetsArgs
Configuration for assets within a Worker
bindings Sequence[WorkersScriptBindingArgs]
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
body_part str
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibility_date str
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibility_flags Sequence[str]
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
keep_assets bool
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keep_bindings Sequence[str]
List of binding types to keep from previous_upload.
logpush bool
Whether Logpush is turned on for the Worker.
main_module str
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations WorkersScriptMigrationsArgs
Migrations to apply for Durable Objects associated with this Worker.
observability WorkersScriptObservabilityArgs
Observability settings for the Worker.
placement WorkersScriptPlacementArgs
Configuration for Smart Placement.
tail_consumers Sequence[WorkersScriptTailConsumerArgs]
List of Workers that will consume logs from the attached Worker.
usage_model str
Usage model for the Worker invocations. Available values: "standard".
accountId This property is required. String
Identifier.
content This property is required. String
Module or Service Worker contents of the Worker.
scriptName This property is required. String
Name of the script, used in URLs and route configuration.
assets Property Map
Configuration for assets within a Worker
bindings List<Property Map>
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
bodyPart String
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibilityDate String
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibilityFlags List<String>
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
keepAssets Boolean
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keepBindings List<String>
List of binding types to keep from previous_upload.
logpush Boolean
Whether Logpush is turned on for the Worker.
mainModule String
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations Property Map
Migrations to apply for Durable Objects associated with this Worker.
observability Property Map
Observability settings for the Worker.
placement Property Map
Configuration for Smart Placement.
tailConsumers List<Property Map>
List of Workers that will consume logs from the attached Worker.
usageModel String
Usage model for the Worker invocations. Available values: "standard".

Outputs

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

CreatedOn string
When the script was created.
Etag string
Hashed script content, can be used in a If-None-Match header when updating.
HasAssets bool
Whether a Worker contains assets.
HasModules bool
Whether a Worker contains modules.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedOn string
When the script was last modified.
StartupTimeMs int
CreatedOn string
When the script was created.
Etag string
Hashed script content, can be used in a If-None-Match header when updating.
HasAssets bool
Whether a Worker contains assets.
HasModules bool
Whether a Worker contains modules.
Id string
The provider-assigned unique ID for this managed resource.
ModifiedOn string
When the script was last modified.
StartupTimeMs int
createdOn String
When the script was created.
etag String
Hashed script content, can be used in a If-None-Match header when updating.
hasAssets Boolean
Whether a Worker contains assets.
hasModules Boolean
Whether a Worker contains modules.
id String
The provider-assigned unique ID for this managed resource.
modifiedOn String
When the script was last modified.
startupTimeMs Integer
createdOn string
When the script was created.
etag string
Hashed script content, can be used in a If-None-Match header when updating.
hasAssets boolean
Whether a Worker contains assets.
hasModules boolean
Whether a Worker contains modules.
id string
The provider-assigned unique ID for this managed resource.
modifiedOn string
When the script was last modified.
startupTimeMs number
created_on str
When the script was created.
etag str
Hashed script content, can be used in a If-None-Match header when updating.
has_assets bool
Whether a Worker contains assets.
has_modules bool
Whether a Worker contains modules.
id str
The provider-assigned unique ID for this managed resource.
modified_on str
When the script was last modified.
startup_time_ms int
createdOn String
When the script was created.
etag String
Hashed script content, can be used in a If-None-Match header when updating.
hasAssets Boolean
Whether a Worker contains assets.
hasModules Boolean
Whether a Worker contains modules.
id String
The provider-assigned unique ID for this managed resource.
modifiedOn String
When the script was last modified.
startupTimeMs Number

Look up Existing WorkersScript Resource

Get an existing WorkersScript 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?: WorkersScriptState, opts?: CustomResourceOptions): WorkersScript
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        assets: Optional[WorkersScriptAssetsArgs] = None,
        bindings: Optional[Sequence[WorkersScriptBindingArgs]] = None,
        body_part: Optional[str] = None,
        compatibility_date: Optional[str] = None,
        compatibility_flags: Optional[Sequence[str]] = None,
        content: Optional[str] = None,
        created_on: Optional[str] = None,
        etag: Optional[str] = None,
        has_assets: Optional[bool] = None,
        has_modules: Optional[bool] = None,
        keep_assets: Optional[bool] = None,
        keep_bindings: Optional[Sequence[str]] = None,
        logpush: Optional[bool] = None,
        main_module: Optional[str] = None,
        migrations: Optional[WorkersScriptMigrationsArgs] = None,
        modified_on: Optional[str] = None,
        observability: Optional[WorkersScriptObservabilityArgs] = None,
        placement: Optional[WorkersScriptPlacementArgs] = None,
        script_name: Optional[str] = None,
        startup_time_ms: Optional[int] = None,
        tail_consumers: Optional[Sequence[WorkersScriptTailConsumerArgs]] = None,
        usage_model: Optional[str] = None) -> WorkersScript
func GetWorkersScript(ctx *Context, name string, id IDInput, state *WorkersScriptState, opts ...ResourceOption) (*WorkersScript, error)
public static WorkersScript Get(string name, Input<string> id, WorkersScriptState? state, CustomResourceOptions? opts = null)
public static WorkersScript get(String name, Output<String> id, WorkersScriptState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:WorkersScript    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.
Assets WorkersScriptAssets
Configuration for assets within a Worker
Bindings List<WorkersScriptBinding>
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
BodyPart string
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
CompatibilityDate string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
CompatibilityFlags List<string>
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
Content string
Module or Service Worker contents of the Worker.
CreatedOn string
When the script was created.
Etag string
Hashed script content, can be used in a If-None-Match header when updating.
HasAssets bool
Whether a Worker contains assets.
HasModules bool
Whether a Worker contains modules.
KeepAssets bool
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
KeepBindings List<string>
List of binding types to keep from previous_upload.
Logpush bool
Whether Logpush is turned on for the Worker.
MainModule string
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
Migrations WorkersScriptMigrations
Migrations to apply for Durable Objects associated with this Worker.
ModifiedOn string
When the script was last modified.
Observability WorkersScriptObservability
Observability settings for the Worker.
Placement WorkersScriptPlacement
Configuration for Smart Placement.
ScriptName string
Name of the script, used in URLs and route configuration.
StartupTimeMs int
TailConsumers List<WorkersScriptTailConsumer>
List of Workers that will consume logs from the attached Worker.
UsageModel string
Usage model for the Worker invocations. Available values: "standard".
AccountId string
Identifier.
Assets WorkersScriptAssetsArgs
Configuration for assets within a Worker
Bindings []WorkersScriptBindingArgs
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
BodyPart string
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
CompatibilityDate string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
CompatibilityFlags []string
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
Content string
Module or Service Worker contents of the Worker.
CreatedOn string
When the script was created.
Etag string
Hashed script content, can be used in a If-None-Match header when updating.
HasAssets bool
Whether a Worker contains assets.
HasModules bool
Whether a Worker contains modules.
KeepAssets bool
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
KeepBindings []string
List of binding types to keep from previous_upload.
Logpush bool
Whether Logpush is turned on for the Worker.
MainModule string
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
Migrations WorkersScriptMigrationsArgs
Migrations to apply for Durable Objects associated with this Worker.
ModifiedOn string
When the script was last modified.
Observability WorkersScriptObservabilityArgs
Observability settings for the Worker.
Placement WorkersScriptPlacementArgs
Configuration for Smart Placement.
ScriptName string
Name of the script, used in URLs and route configuration.
StartupTimeMs int
TailConsumers []WorkersScriptTailConsumerArgs
List of Workers that will consume logs from the attached Worker.
UsageModel string
Usage model for the Worker invocations. Available values: "standard".
accountId String
Identifier.
assets WorkersScriptAssets
Configuration for assets within a Worker
bindings List<WorkersScriptBinding>
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
bodyPart String
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibilityDate String
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibilityFlags List<String>
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
content String
Module or Service Worker contents of the Worker.
createdOn String
When the script was created.
etag String
Hashed script content, can be used in a If-None-Match header when updating.
hasAssets Boolean
Whether a Worker contains assets.
hasModules Boolean
Whether a Worker contains modules.
keepAssets Boolean
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keepBindings List<String>
List of binding types to keep from previous_upload.
logpush Boolean
Whether Logpush is turned on for the Worker.
mainModule String
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations WorkersScriptMigrations
Migrations to apply for Durable Objects associated with this Worker.
modifiedOn String
When the script was last modified.
observability WorkersScriptObservability
Observability settings for the Worker.
placement WorkersScriptPlacement
Configuration for Smart Placement.
scriptName String
Name of the script, used in URLs and route configuration.
startupTimeMs Integer
tailConsumers List<WorkersScriptTailConsumer>
List of Workers that will consume logs from the attached Worker.
usageModel String
Usage model for the Worker invocations. Available values: "standard".
accountId string
Identifier.
assets WorkersScriptAssets
Configuration for assets within a Worker
bindings WorkersScriptBinding[]
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
bodyPart string
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibilityDate string
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibilityFlags string[]
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
content string
Module or Service Worker contents of the Worker.
createdOn string
When the script was created.
etag string
Hashed script content, can be used in a If-None-Match header when updating.
hasAssets boolean
Whether a Worker contains assets.
hasModules boolean
Whether a Worker contains modules.
keepAssets boolean
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keepBindings string[]
List of binding types to keep from previous_upload.
logpush boolean
Whether Logpush is turned on for the Worker.
mainModule string
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations WorkersScriptMigrations
Migrations to apply for Durable Objects associated with this Worker.
modifiedOn string
When the script was last modified.
observability WorkersScriptObservability
Observability settings for the Worker.
placement WorkersScriptPlacement
Configuration for Smart Placement.
scriptName string
Name of the script, used in URLs and route configuration.
startupTimeMs number
tailConsumers WorkersScriptTailConsumer[]
List of Workers that will consume logs from the attached Worker.
usageModel string
Usage model for the Worker invocations. Available values: "standard".
account_id str
Identifier.
assets WorkersScriptAssetsArgs
Configuration for assets within a Worker
bindings Sequence[WorkersScriptBindingArgs]
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
body_part str
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibility_date str
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibility_flags Sequence[str]
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
content str
Module or Service Worker contents of the Worker.
created_on str
When the script was created.
etag str
Hashed script content, can be used in a If-None-Match header when updating.
has_assets bool
Whether a Worker contains assets.
has_modules bool
Whether a Worker contains modules.
keep_assets bool
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keep_bindings Sequence[str]
List of binding types to keep from previous_upload.
logpush bool
Whether Logpush is turned on for the Worker.
main_module str
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations WorkersScriptMigrationsArgs
Migrations to apply for Durable Objects associated with this Worker.
modified_on str
When the script was last modified.
observability WorkersScriptObservabilityArgs
Observability settings for the Worker.
placement WorkersScriptPlacementArgs
Configuration for Smart Placement.
script_name str
Name of the script, used in URLs and route configuration.
startup_time_ms int
tail_consumers Sequence[WorkersScriptTailConsumerArgs]
List of Workers that will consume logs from the attached Worker.
usage_model str
Usage model for the Worker invocations. Available values: "standard".
accountId String
Identifier.
assets Property Map
Configuration for assets within a Worker
bindings List<Property Map>
List of bindings attached to a Worker. You can find more about bindings on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
bodyPart String
Name of the part in the multipart request that contains the script (e.g. the file adding a listener to the fetch event). Indicates a service worker syntax Worker.
compatibilityDate String
Date indicating targeted support in the Workers runtime. Backwards incompatible fixes to the runtime following this date will not affect this Worker.
compatibilityFlags List<String>
Flags that enable or disable certain features in the Workers runtime. Used to enable upcoming features or opt in or out of specific changes not included in a compatibility_date.
content String
Module or Service Worker contents of the Worker.
createdOn String
When the script was created.
etag String
Hashed script content, can be used in a If-None-Match header when updating.
hasAssets Boolean
Whether a Worker contains assets.
hasModules Boolean
Whether a Worker contains modules.
keepAssets Boolean
Retain assets which exist for a previously uploaded Worker version; used in lieu of providing a completion token.
keepBindings List<String>
List of binding types to keep from previous_upload.
logpush Boolean
Whether Logpush is turned on for the Worker.
mainModule String
Name of the part in the multipart request that contains the main module (e.g. the file exporting a fetch handler). Indicates a module syntax Worker.
migrations Property Map
Migrations to apply for Durable Objects associated with this Worker.
modifiedOn String
When the script was last modified.
observability Property Map
Observability settings for the Worker.
placement Property Map
Configuration for Smart Placement.
scriptName String
Name of the script, used in URLs and route configuration.
startupTimeMs Number
tailConsumers List<Property Map>
List of Workers that will consume logs from the attached Worker.
usageModel String
Usage model for the Worker invocations. Available values: "standard".

Supporting Types

WorkersScriptAssets
, WorkersScriptAssetsArgs

Config WorkersScriptAssetsConfig
Configuration for assets within a Worker.
Jwt string
Token provided upon successful upload of all files from a registered manifest.
Config WorkersScriptAssetsConfig
Configuration for assets within a Worker.
Jwt string
Token provided upon successful upload of all files from a registered manifest.
config WorkersScriptAssetsConfig
Configuration for assets within a Worker.
jwt String
Token provided upon successful upload of all files from a registered manifest.
config WorkersScriptAssetsConfig
Configuration for assets within a Worker.
jwt string
Token provided upon successful upload of all files from a registered manifest.
config WorkersScriptAssetsConfig
Configuration for assets within a Worker.
jwt str
Token provided upon successful upload of all files from a registered manifest.
config Property Map
Configuration for assets within a Worker.
jwt String
Token provided upon successful upload of all files from a registered manifest.

WorkersScriptAssetsConfig
, WorkersScriptAssetsConfigArgs

HtmlHandling string
Determines the redirects and rewrites of requests for HTML content. Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
NotFoundHandling string
Determines the response when a request does not match a static asset, and there is no Worker script. Available values: "none", "404-page", "single-page-application".
RunWorkerFirst bool
When true, requests will always invoke the Worker script. Otherwise, attempt to serve an asset matching the request, falling back to the Worker script.
ServeDirectly bool
When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.

Deprecated: This attribute is deprecated.

_headers string
The contents of a _headers file (used to attach custom headers on asset responses)
_redirects string
The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving)
HtmlHandling string
Determines the redirects and rewrites of requests for HTML content. Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
NotFoundHandling string
Determines the response when a request does not match a static asset, and there is no Worker script. Available values: "none", "404-page", "single-page-application".
RunWorkerFirst bool
When true, requests will always invoke the Worker script. Otherwise, attempt to serve an asset matching the request, falling back to the Worker script.
ServeDirectly bool
When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.

Deprecated: This attribute is deprecated.

_headers string
The contents of a _headers file (used to attach custom headers on asset responses)
_redirects string
The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving)
_headers String
The contents of a _headers file (used to attach custom headers on asset responses)
_redirects String
The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving)
htmlHandling String
Determines the redirects and rewrites of requests for HTML content. Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
notFoundHandling String
Determines the response when a request does not match a static asset, and there is no Worker script. Available values: "none", "404-page", "single-page-application".
runWorkerFirst Boolean
When true, requests will always invoke the Worker script. Otherwise, attempt to serve an asset matching the request, falling back to the Worker script.
serveDirectly Boolean
When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.

Deprecated: This attribute is deprecated.

_headers string
The contents of a _headers file (used to attach custom headers on asset responses)
_redirects string
The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving)
htmlHandling string
Determines the redirects and rewrites of requests for HTML content. Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
notFoundHandling string
Determines the response when a request does not match a static asset, and there is no Worker script. Available values: "none", "404-page", "single-page-application".
runWorkerFirst boolean
When true, requests will always invoke the Worker script. Otherwise, attempt to serve an asset matching the request, falling back to the Worker script.
serveDirectly boolean
When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.

Deprecated: This attribute is deprecated.

_headers str
The contents of a _headers file (used to attach custom headers on asset responses)
_redirects str
The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving)
html_handling str
Determines the redirects and rewrites of requests for HTML content. Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
not_found_handling str
Determines the response when a request does not match a static asset, and there is no Worker script. Available values: "none", "404-page", "single-page-application".
run_worker_first bool
When true, requests will always invoke the Worker script. Otherwise, attempt to serve an asset matching the request, falling back to the Worker script.
serve_directly bool
When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.

Deprecated: This attribute is deprecated.

_headers String
The contents of a _headers file (used to attach custom headers on asset responses)
_redirects String
The contents of a _redirects file (used to apply redirects or proxy paths ahead of asset serving)
htmlHandling String
Determines the redirects and rewrites of requests for HTML content. Available values: "auto-trailing-slash", "force-trailing-slash", "drop-trailing-slash", "none".
notFoundHandling String
Determines the response when a request does not match a static asset, and there is no Worker script. Available values: "none", "404-page", "single-page-application".
runWorkerFirst Boolean
When true, requests will always invoke the Worker script. Otherwise, attempt to serve an asset matching the request, falling back to the Worker script.
serveDirectly Boolean
When true and the incoming request matches an asset, that will be served instead of invoking the Worker script. When false, requests will always invoke the Worker script.

Deprecated: This attribute is deprecated.

WorkersScriptBinding
, WorkersScriptBindingArgs

Name This property is required. string
A JavaScript variable name for the binding.
Type This property is required. string
The kind of resource that the binding provides. Available values: "ai", "analyticsengine", "assets", "browserrendering", "d1", "dispatchnamespace", "durableobjectnamespace", "hyperdrive", "json", "kvnamespace", "mtlscertificate", "plaintext", "queue", "r2bucket", "secrettext", "service", "tailconsumer", "vectorize", "versionmetadata".
BucketName string
R2 bucket to bind to.
CertificateId string
Identifier of the certificate to bind to.
ClassName string
The exported class name of the Durable Object.
Dataset string
The name of the dataset to bind to.
Environment string
The environment of the script_name to bind to.
Id string
Identifier of the D1 database to bind to.
IndexName string
Name of the Vectorize index to bind to.
Json string
JSON data to use.
Namespace string
Namespace to bind to.
NamespaceId string
Namespace identifier tag.
Outbound WorkersScriptBindingOutbound
Outbound worker.
QueueName string
Name of the Queue to bind to.
ScriptName string
The script where the Durable Object is defined, if it is external to this Worker.
Service string
Name of Worker to bind to.
Text string
The text value to use.
Name This property is required. string
A JavaScript variable name for the binding.
Type This property is required. string
The kind of resource that the binding provides. Available values: "ai", "analyticsengine", "assets", "browserrendering", "d1", "dispatchnamespace", "durableobjectnamespace", "hyperdrive", "json", "kvnamespace", "mtlscertificate", "plaintext", "queue", "r2bucket", "secrettext", "service", "tailconsumer", "vectorize", "versionmetadata".
BucketName string
R2 bucket to bind to.
CertificateId string
Identifier of the certificate to bind to.
ClassName string
The exported class name of the Durable Object.
Dataset string
The name of the dataset to bind to.
Environment string
The environment of the script_name to bind to.
Id string
Identifier of the D1 database to bind to.
IndexName string
Name of the Vectorize index to bind to.
Json string
JSON data to use.
Namespace string
Namespace to bind to.
NamespaceId string
Namespace identifier tag.
Outbound WorkersScriptBindingOutbound
Outbound worker.
QueueName string
Name of the Queue to bind to.
ScriptName string
The script where the Durable Object is defined, if it is external to this Worker.
Service string
Name of Worker to bind to.
Text string
The text value to use.
name This property is required. String
A JavaScript variable name for the binding.
type This property is required. String
The kind of resource that the binding provides. Available values: "ai", "analyticsengine", "assets", "browserrendering", "d1", "dispatchnamespace", "durableobjectnamespace", "hyperdrive", "json", "kvnamespace", "mtlscertificate", "plaintext", "queue", "r2bucket", "secrettext", "service", "tailconsumer", "vectorize", "versionmetadata".
bucketName String
R2 bucket to bind to.
certificateId String
Identifier of the certificate to bind to.
className String
The exported class name of the Durable Object.
dataset String
The name of the dataset to bind to.
environment String
The environment of the script_name to bind to.
id String
Identifier of the D1 database to bind to.
indexName String
Name of the Vectorize index to bind to.
json String
JSON data to use.
namespace String
Namespace to bind to.
namespaceId String
Namespace identifier tag.
outbound WorkersScriptBindingOutbound
Outbound worker.
queueName String
Name of the Queue to bind to.
scriptName String
The script where the Durable Object is defined, if it is external to this Worker.
service String
Name of Worker to bind to.
text String
The text value to use.
name This property is required. string
A JavaScript variable name for the binding.
type This property is required. string
The kind of resource that the binding provides. Available values: "ai", "analyticsengine", "assets", "browserrendering", "d1", "dispatchnamespace", "durableobjectnamespace", "hyperdrive", "json", "kvnamespace", "mtlscertificate", "plaintext", "queue", "r2bucket", "secrettext", "service", "tailconsumer", "vectorize", "versionmetadata".
bucketName string
R2 bucket to bind to.
certificateId string
Identifier of the certificate to bind to.
className string
The exported class name of the Durable Object.
dataset string
The name of the dataset to bind to.
environment string
The environment of the script_name to bind to.
id string
Identifier of the D1 database to bind to.
indexName string
Name of the Vectorize index to bind to.
json string
JSON data to use.
namespace string
Namespace to bind to.
namespaceId string
Namespace identifier tag.
outbound WorkersScriptBindingOutbound
Outbound worker.
queueName string
Name of the Queue to bind to.
scriptName string
The script where the Durable Object is defined, if it is external to this Worker.
service string
Name of Worker to bind to.
text string
The text value to use.
name This property is required. str
A JavaScript variable name for the binding.
type This property is required. str
The kind of resource that the binding provides. Available values: "ai", "analyticsengine", "assets", "browserrendering", "d1", "dispatchnamespace", "durableobjectnamespace", "hyperdrive", "json", "kvnamespace", "mtlscertificate", "plaintext", "queue", "r2bucket", "secrettext", "service", "tailconsumer", "vectorize", "versionmetadata".
bucket_name str
R2 bucket to bind to.
certificate_id str
Identifier of the certificate to bind to.
class_name str
The exported class name of the Durable Object.
dataset str
The name of the dataset to bind to.
environment str
The environment of the script_name to bind to.
id str
Identifier of the D1 database to bind to.
index_name str
Name of the Vectorize index to bind to.
json str
JSON data to use.
namespace str
Namespace to bind to.
namespace_id str
Namespace identifier tag.
outbound WorkersScriptBindingOutbound
Outbound worker.
queue_name str
Name of the Queue to bind to.
script_name str
The script where the Durable Object is defined, if it is external to this Worker.
service str
Name of Worker to bind to.
text str
The text value to use.
name This property is required. String
A JavaScript variable name for the binding.
type This property is required. String
The kind of resource that the binding provides. Available values: "ai", "analyticsengine", "assets", "browserrendering", "d1", "dispatchnamespace", "durableobjectnamespace", "hyperdrive", "json", "kvnamespace", "mtlscertificate", "plaintext", "queue", "r2bucket", "secrettext", "service", "tailconsumer", "vectorize", "versionmetadata".
bucketName String
R2 bucket to bind to.
certificateId String
Identifier of the certificate to bind to.
className String
The exported class name of the Durable Object.
dataset String
The name of the dataset to bind to.
environment String
The environment of the script_name to bind to.
id String
Identifier of the D1 database to bind to.
indexName String
Name of the Vectorize index to bind to.
json String
JSON data to use.
namespace String
Namespace to bind to.
namespaceId String
Namespace identifier tag.
outbound Property Map
Outbound worker.
queueName String
Name of the Queue to bind to.
scriptName String
The script where the Durable Object is defined, if it is external to this Worker.
service String
Name of Worker to bind to.
text String
The text value to use.

WorkersScriptBindingOutbound
, WorkersScriptBindingOutboundArgs

Params List<string>
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
Worker WorkersScriptBindingOutboundWorker
Outbound worker.
Params []string
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
Worker WorkersScriptBindingOutboundWorker
Outbound worker.
params List<String>
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
worker WorkersScriptBindingOutboundWorker
Outbound worker.
params string[]
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
worker WorkersScriptBindingOutboundWorker
Outbound worker.
params Sequence[str]
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
worker WorkersScriptBindingOutboundWorker
Outbound worker.
params List<String>
Pass information from the Dispatch Worker to the Outbound Worker through the parameters.
worker Property Map
Outbound worker.

WorkersScriptBindingOutboundWorker
, WorkersScriptBindingOutboundWorkerArgs

Environment string
Environment of the outbound worker.
Service string
Name of the outbound worker.
Environment string
Environment of the outbound worker.
Service string
Name of the outbound worker.
environment String
Environment of the outbound worker.
service String
Name of the outbound worker.
environment string
Environment of the outbound worker.
service string
Name of the outbound worker.
environment str
Environment of the outbound worker.
service str
Name of the outbound worker.
environment String
Environment of the outbound worker.
service String
Name of the outbound worker.

WorkersScriptMigrations
, WorkersScriptMigrationsArgs

DeletedClasses List<string>
A list of classes to delete Durable Object namespaces from.
NewClasses List<string>
A list of classes to create Durable Object namespaces from.
NewSqliteClasses List<string>
A list of classes to create Durable Object namespaces with SQLite from.
NewTag string
Tag to set as the latest migration tag.
OldTag string
Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
RenamedClasses List<WorkersScriptMigrationsRenamedClass>
A list of classes with Durable Object namespaces that were renamed.
Steps List<WorkersScriptMigrationsStep>
Migrations to apply in order.
TransferredClasses List<WorkersScriptMigrationsTransferredClass>
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
DeletedClasses []string
A list of classes to delete Durable Object namespaces from.
NewClasses []string
A list of classes to create Durable Object namespaces from.
NewSqliteClasses []string
A list of classes to create Durable Object namespaces with SQLite from.
NewTag string
Tag to set as the latest migration tag.
OldTag string
Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
RenamedClasses []WorkersScriptMigrationsRenamedClass
A list of classes with Durable Object namespaces that were renamed.
Steps []WorkersScriptMigrationsStep
Migrations to apply in order.
TransferredClasses []WorkersScriptMigrationsTransferredClass
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deletedClasses List<String>
A list of classes to delete Durable Object namespaces from.
newClasses List<String>
A list of classes to create Durable Object namespaces from.
newSqliteClasses List<String>
A list of classes to create Durable Object namespaces with SQLite from.
newTag String
Tag to set as the latest migration tag.
oldTag String
Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
renamedClasses List<WorkersScriptMigrationsRenamedClass>
A list of classes with Durable Object namespaces that were renamed.
steps List<WorkersScriptMigrationsStep>
Migrations to apply in order.
transferredClasses List<WorkersScriptMigrationsTransferredClass>
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deletedClasses string[]
A list of classes to delete Durable Object namespaces from.
newClasses string[]
A list of classes to create Durable Object namespaces from.
newSqliteClasses string[]
A list of classes to create Durable Object namespaces with SQLite from.
newTag string
Tag to set as the latest migration tag.
oldTag string
Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
renamedClasses WorkersScriptMigrationsRenamedClass[]
A list of classes with Durable Object namespaces that were renamed.
steps WorkersScriptMigrationsStep[]
Migrations to apply in order.
transferredClasses WorkersScriptMigrationsTransferredClass[]
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deleted_classes Sequence[str]
A list of classes to delete Durable Object namespaces from.
new_classes Sequence[str]
A list of classes to create Durable Object namespaces from.
new_sqlite_classes Sequence[str]
A list of classes to create Durable Object namespaces with SQLite from.
new_tag str
Tag to set as the latest migration tag.
old_tag str
Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
renamed_classes Sequence[WorkersScriptMigrationsRenamedClass]
A list of classes with Durable Object namespaces that were renamed.
steps Sequence[WorkersScriptMigrationsStep]
Migrations to apply in order.
transferred_classes Sequence[WorkersScriptMigrationsTransferredClass]
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deletedClasses List<String>
A list of classes to delete Durable Object namespaces from.
newClasses List<String>
A list of classes to create Durable Object namespaces from.
newSqliteClasses List<String>
A list of classes to create Durable Object namespaces with SQLite from.
newTag String
Tag to set as the latest migration tag.
oldTag String
Tag used to verify against the latest migration tag for this Worker. If they don't match, the upload is rejected.
renamedClasses List<Property Map>
A list of classes with Durable Object namespaces that were renamed.
steps List<Property Map>
Migrations to apply in order.
transferredClasses List<Property Map>
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.

WorkersScriptMigrationsRenamedClass
, WorkersScriptMigrationsRenamedClassArgs

From string
To string
From string
To string
from String
to String
from string
to string
from_ str
to str
from String
to String

WorkersScriptMigrationsStep
, WorkersScriptMigrationsStepArgs

DeletedClasses List<string>
A list of classes to delete Durable Object namespaces from.
NewClasses List<string>
A list of classes to create Durable Object namespaces from.
NewSqliteClasses List<string>
A list of classes to create Durable Object namespaces with SQLite from.
RenamedClasses List<WorkersScriptMigrationsStepRenamedClass>
A list of classes with Durable Object namespaces that were renamed.
TransferredClasses List<WorkersScriptMigrationsStepTransferredClass>
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
DeletedClasses []string
A list of classes to delete Durable Object namespaces from.
NewClasses []string
A list of classes to create Durable Object namespaces from.
NewSqliteClasses []string
A list of classes to create Durable Object namespaces with SQLite from.
RenamedClasses []WorkersScriptMigrationsStepRenamedClass
A list of classes with Durable Object namespaces that were renamed.
TransferredClasses []WorkersScriptMigrationsStepTransferredClass
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deletedClasses List<String>
A list of classes to delete Durable Object namespaces from.
newClasses List<String>
A list of classes to create Durable Object namespaces from.
newSqliteClasses List<String>
A list of classes to create Durable Object namespaces with SQLite from.
renamedClasses List<WorkersScriptMigrationsStepRenamedClass>
A list of classes with Durable Object namespaces that were renamed.
transferredClasses List<WorkersScriptMigrationsStepTransferredClass>
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deletedClasses string[]
A list of classes to delete Durable Object namespaces from.
newClasses string[]
A list of classes to create Durable Object namespaces from.
newSqliteClasses string[]
A list of classes to create Durable Object namespaces with SQLite from.
renamedClasses WorkersScriptMigrationsStepRenamedClass[]
A list of classes with Durable Object namespaces that were renamed.
transferredClasses WorkersScriptMigrationsStepTransferredClass[]
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deleted_classes Sequence[str]
A list of classes to delete Durable Object namespaces from.
new_classes Sequence[str]
A list of classes to create Durable Object namespaces from.
new_sqlite_classes Sequence[str]
A list of classes to create Durable Object namespaces with SQLite from.
renamed_classes Sequence[WorkersScriptMigrationsStepRenamedClass]
A list of classes with Durable Object namespaces that were renamed.
transferred_classes Sequence[WorkersScriptMigrationsStepTransferredClass]
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.
deletedClasses List<String>
A list of classes to delete Durable Object namespaces from.
newClasses List<String>
A list of classes to create Durable Object namespaces from.
newSqliteClasses List<String>
A list of classes to create Durable Object namespaces with SQLite from.
renamedClasses List<Property Map>
A list of classes with Durable Object namespaces that were renamed.
transferredClasses List<Property Map>
A list of transfers for Durable Object namespaces from a different Worker and class to a class defined in this Worker.

WorkersScriptMigrationsStepRenamedClass
, WorkersScriptMigrationsStepRenamedClassArgs

From string
To string
From string
To string
from String
to String
from string
to string
from_ str
to str
from String
to String

WorkersScriptMigrationsStepTransferredClass
, WorkersScriptMigrationsStepTransferredClassArgs

From string
FromScript string
To string
From string
FromScript string
To string
from String
fromScript String
to String
from string
fromScript string
to string
from_ str
from_script str
to str
from String
fromScript String
to String

WorkersScriptMigrationsTransferredClass
, WorkersScriptMigrationsTransferredClassArgs

From string
FromScript string
To string
From string
FromScript string
To string
from String
fromScript String
to String
from string
fromScript string
to string
from_ str
from_script str
to str
from String
fromScript String
to String

WorkersScriptObservability
, WorkersScriptObservabilityArgs

Enabled This property is required. bool
Whether observability is enabled for the Worker.
HeadSamplingRate double
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
Enabled This property is required. bool
Whether observability is enabled for the Worker.
HeadSamplingRate float64
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
enabled This property is required. Boolean
Whether observability is enabled for the Worker.
headSamplingRate Double
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
enabled This property is required. boolean
Whether observability is enabled for the Worker.
headSamplingRate number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
enabled This property is required. bool
Whether observability is enabled for the Worker.
head_sampling_rate float
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
enabled This property is required. Boolean
Whether observability is enabled for the Worker.
headSamplingRate Number
The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.

WorkersScriptPlacement
, WorkersScriptPlacementArgs

Mode string
Enables Smart Placement. Available values: "smart".
Status string
Status of Smart Placement. Available values: "SUCCESS", "UNSUPPORTEDAPPLICATION", "INSUFFICIENTINVOCATIONS".
Mode string
Enables Smart Placement. Available values: "smart".
Status string
Status of Smart Placement. Available values: "SUCCESS", "UNSUPPORTEDAPPLICATION", "INSUFFICIENTINVOCATIONS".
mode String
Enables Smart Placement. Available values: "smart".
status String
Status of Smart Placement. Available values: "SUCCESS", "UNSUPPORTEDAPPLICATION", "INSUFFICIENTINVOCATIONS".
mode string
Enables Smart Placement. Available values: "smart".
status string
Status of Smart Placement. Available values: "SUCCESS", "UNSUPPORTEDAPPLICATION", "INSUFFICIENTINVOCATIONS".
mode str
Enables Smart Placement. Available values: "smart".
status str
Status of Smart Placement. Available values: "SUCCESS", "UNSUPPORTEDAPPLICATION", "INSUFFICIENTINVOCATIONS".
mode String
Enables Smart Placement. Available values: "smart".
status String
Status of Smart Placement. Available values: "SUCCESS", "UNSUPPORTEDAPPLICATION", "INSUFFICIENTINVOCATIONS".

WorkersScriptTailConsumer
, WorkersScriptTailConsumerArgs

Service This property is required. string
Name of Worker that is to be the consumer.
Environment string
Optional environment if the Worker utilizes one.
Namespace string
Optional dispatch namespace the script belongs to.
Service This property is required. string
Name of Worker that is to be the consumer.
Environment string
Optional environment if the Worker utilizes one.
Namespace string
Optional dispatch namespace the script belongs to.
service This property is required. String
Name of Worker that is to be the consumer.
environment String
Optional environment if the Worker utilizes one.
namespace String
Optional dispatch namespace the script belongs to.
service This property is required. string
Name of Worker that is to be the consumer.
environment string
Optional environment if the Worker utilizes one.
namespace string
Optional dispatch namespace the script belongs to.
service This property is required. str
Name of Worker that is to be the consumer.
environment str
Optional environment if the Worker utilizes one.
namespace str
Optional dispatch namespace the script belongs to.
service This property is required. String
Name of Worker that is to be the consumer.
environment String
Optional environment if the Worker utilizes one.
namespace String
Optional dispatch namespace the script belongs to.

Import

$ pulumi import cloudflare:index/workersScript:WorkersScript example '<account_id>/<script_name>'
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.
Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-cloudflare