1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. Queue
Cloudflare v5.44.0 published on Wednesday, Nov 27, 2024 by Pulumi

cloudflare.Queue

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.44.0 published on Wednesday, Nov 27, 2024 by Pulumi

    Provides the ability to manage Cloudflare Workers Queue features.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.Queue("example", {
        accountId: "f037e56e89293a057740de681ac9abbe",
        name: "my-queue",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.Queue("example",
        account_id="f037e56e89293a057740de681ac9abbe",
        name="my-queue")
    
    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.NewQueue(ctx, "example", &cloudflare.QueueArgs{
    			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
    			Name:      pulumi.String("my-queue"),
    		})
    		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.Queue("example", new()
        {
            AccountId = "f037e56e89293a057740de681ac9abbe",
            Name = "my-queue",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.Queue;
    import com.pulumi.cloudflare.QueueArgs;
    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 Queue("example", QueueArgs.builder()
                .accountId("f037e56e89293a057740de681ac9abbe")
                .name("my-queue")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:Queue
        properties:
          accountId: f037e56e89293a057740de681ac9abbe
          name: my-queue
    

    Create Queue Resource

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

    Constructor syntax

    new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);
    @overload
    def Queue(resource_name: str,
              args: QueueArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Queue(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              account_id: Optional[str] = None,
              name: Optional[str] = None)
    func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)
    public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)
    public Queue(String name, QueueArgs args)
    public Queue(String name, QueueArgs args, CustomResourceOptions options)
    
    type: cloudflare:Queue
    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 QueueArgs
    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 QueueArgs
    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 QueueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args QueueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args QueueArgs
    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 queueResource = new Cloudflare.Queue("queueResource", new()
    {
        AccountId = "string",
        Name = "string",
    });
    
    example, err := cloudflare.NewQueue(ctx, "queueResource", &cloudflare.QueueArgs{
    	AccountId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    })
    
    var queueResource = new Queue("queueResource", QueueArgs.builder()
        .accountId("string")
        .name("string")
        .build());
    
    queue_resource = cloudflare.Queue("queueResource",
        account_id="string",
        name="string")
    
    const queueResource = new cloudflare.Queue("queueResource", {
        accountId: "string",
        name: "string",
    });
    
    type: cloudflare:Queue
    properties:
        accountId: string
        name: string
    

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

    AccountId string
    The account identifier to target for the resource.
    Name string
    The name of the queue.
    AccountId string
    The account identifier to target for the resource.
    Name string
    The name of the queue.
    accountId String
    The account identifier to target for the resource.
    name String
    The name of the queue.
    accountId string
    The account identifier to target for the resource.
    name string
    The name of the queue.
    account_id str
    The account identifier to target for the resource.
    name str
    The name of the queue.
    accountId String
    The account identifier to target for the resource.
    name String
    The name of the queue.

    Outputs

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

    Get an existing Queue 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?: QueueState, opts?: CustomResourceOptions): Queue
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            name: Optional[str] = None) -> Queue
    func GetQueue(ctx *Context, name string, id IDInput, state *QueueState, opts ...ResourceOption) (*Queue, error)
    public static Queue Get(string name, Input<string> id, QueueState? state, CustomResourceOptions? opts = null)
    public static Queue get(String name, Output<String> id, QueueState 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.
    Name string
    The name of the queue.
    AccountId string
    The account identifier to target for the resource.
    Name string
    The name of the queue.
    accountId String
    The account identifier to target for the resource.
    name String
    The name of the queue.
    accountId string
    The account identifier to target for the resource.
    name string
    The name of the queue.
    account_id str
    The account identifier to target for the resource.
    name str
    The name of the queue.
    accountId String
    The account identifier to target for the resource.
    name String
    The name of the queue.

    Import

    $ pulumi import cloudflare:index/queue:Queue example <account_id>/<queue_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 logo
    Cloudflare v5.44.0 published on Wednesday, Nov 27, 2024 by Pulumi