Cloudflare v5.26.0, Apr 17 24

Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi

cloudflare.WorkerDomain

Explore with Pulumi AI

Cloudflare v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi

Example Usage

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

const example = new cloudflare.WorkerDomain("example", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    hostname: "subdomain.example.com",
    service: "my-service",
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
});

import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.WorkerDomain("example",
    account_id="f037e56e89293a057740de681ac9abbe",
    hostname="subdomain.example.com",
    service="my-service",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewWorkerDomain(ctx, "example", &cloudflare.WorkerDomainArgs{
			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
			Hostname:  pulumi.String("subdomain.example.com"),
			Service:   pulumi.String("my-service"),
			ZoneId:    pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.WorkerDomain("example", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        Hostname = "subdomain.example.com",
        Service = "my-service",
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.WorkerDomain;
import com.pulumi.cloudflare.WorkerDomainArgs;
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 example = new WorkerDomain("example", WorkerDomainArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .hostname("subdomain.example.com")
            .service("my-service")
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .build());

    }
}

resources:
  example:
    type: cloudflare:WorkerDomain
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      hostname: subdomain.example.com
      service: my-service
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711

Create WorkerDomain Resource

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

Constructor syntax

new WorkerDomain(name: string, args: WorkerDomainArgs, opts?: CustomResourceOptions);

@overload
def WorkerDomain(resource_name: str,
                 args: WorkerDomainArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def WorkerDomain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 account_id: Optional[str] = None,
                 hostname: Optional[str] = None,
                 service: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 environment: Optional[str] = None)

func NewWorkerDomain(ctx *Context, name string, args WorkerDomainArgs, opts ...ResourceOption) (*WorkerDomain, error)

public WorkerDomain(string name, WorkerDomainArgs args, CustomResourceOptions? opts = null)

public WorkerDomain(String name, WorkerDomainArgs args)
public WorkerDomain(String name, WorkerDomainArgs args, CustomResourceOptions options)

type: cloudflare:WorkerDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args WorkerDomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WorkerDomainArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WorkerDomainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkerDomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkerDomainArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var workerDomainResource = new Cloudflare.WorkerDomain("workerDomainResource", new()
{
    AccountId = "string",
    Hostname = "string",
    Service = "string",
    ZoneId = "string",
    Environment = "string",
});

example, err := cloudflare.NewWorkerDomain(ctx, "workerDomainResource", &cloudflare.WorkerDomainArgs{
	AccountId:   pulumi.String("string"),
	Hostname:    pulumi.String("string"),
	Service:     pulumi.String("string"),
	ZoneId:      pulumi.String("string"),
	Environment: pulumi.String("string"),
})

var workerDomainResource = new WorkerDomain("workerDomainResource", WorkerDomainArgs.builder()        
    .accountId("string")
    .hostname("string")
    .service("string")
    .zoneId("string")
    .environment("string")
    .build());

worker_domain_resource = cloudflare.WorkerDomain("workerDomainResource",
    account_id="string",
    hostname="string",
    service="string",
    zone_id="string",
    environment="string")

const workerDomainResource = new cloudflare.WorkerDomain("workerDomainResource", {
    accountId: "string",
    hostname: "string",
    service: "string",
    zoneId: "string",
    environment: "string",
});

type: cloudflare:WorkerDomain
properties:
    accountId: string
    environment: string
    hostname: string
    service: string
    zoneId: string

WorkerDomain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The WorkerDomain resource accepts the following input properties:

AccountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Hostname string: Hostname of the Worker Domain.
Service string: Name of worker script to attach the domain to.
ZoneId string: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Environment string: The name of the Worker environment. Defaults to production.

AccountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Hostname string: Hostname of the Worker Domain.
Service string: Name of worker script to attach the domain to.
ZoneId string: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Environment string: The name of the Worker environment. Defaults to production.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
hostname String: Hostname of the Worker Domain.
service String: Name of worker script to attach the domain to.
zoneId String: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment String: The name of the Worker environment. Defaults to production.

accountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
hostname string: Hostname of the Worker Domain.
service string: Name of worker script to attach the domain to.
zoneId string: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment string: The name of the Worker environment. Defaults to production.

account_id str: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
hostname str: Hostname of the Worker Domain.
service str: Name of worker script to attach the domain to.
zone_id str: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment str: The name of the Worker environment. Defaults to production.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
hostname String: Hostname of the Worker Domain.
service String: Name of worker script to attach the domain to.
zoneId String: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment String: The name of the Worker environment. Defaults to production.

Outputs

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

Get an existing WorkerDomain 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?: WorkerDomainState, opts?: CustomResourceOptions): WorkerDomain

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        environment: Optional[str] = None,
        hostname: Optional[str] = None,
        service: Optional[str] = None,
        zone_id: Optional[str] = None) -> WorkerDomain

func GetWorkerDomain(ctx *Context, name string, id IDInput, state *WorkerDomainState, opts ...ResourceOption) (*WorkerDomain, error)

public static WorkerDomain Get(string name, Input<string> id, WorkerDomainState? state, CustomResourceOptions? opts = null)

public static WorkerDomain get(String name, Output<String> id, WorkerDomainState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Environment string: The name of the Worker environment. Defaults to production.
Hostname string: Hostname of the Worker Domain.
Service string: Name of worker script to attach the domain to.
ZoneId string: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

AccountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Environment string: The name of the Worker environment. Defaults to production.
Hostname string: Hostname of the Worker Domain.
Service string: Name of worker script to attach the domain to.
ZoneId string: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment String: The name of the Worker environment. Defaults to production.
hostname String: Hostname of the Worker Domain.
service String: Name of worker script to attach the domain to.
zoneId String: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

accountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment string: The name of the Worker environment. Defaults to production.
hostname string: Hostname of the Worker Domain.
service string: Name of worker script to attach the domain to.
zoneId string: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

account_id str: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment str: The name of the Worker environment. Defaults to production.
hostname str: Hostname of the Worker Domain.
service str: Name of worker script to attach the domain to.
zone_id str: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
environment String: The name of the Worker environment. Defaults to production.
hostname String: Hostname of the Worker Domain.
service String: Name of worker script to attach the domain to.
zoneId String: The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

Import

$ pulumi import cloudflare:index/workerDomain:WorkerDomain example <account_id>/<worker_domain_id>

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 v5.26.0 published on Wednesday, Apr 17, 2024 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.WorkerDomain

On this page

On this page

Example Usage

Create WorkerDomain Resource

Constructor syntax

Parameters

Example

WorkerDomain Resource Properties

Inputs

Outputs

Look up Existing WorkerDomain Resource

Import

Package Details

On this page

On this page