1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getQueueConsumer
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getQueueConsumer

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleQueueConsumer = cloudflare.getQueueConsumer({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        queueId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_queue_consumer = cloudflare.get_queue_consumer(account_id="023e105f4ecef8ad9ca31a8372d0c353",
        queue_id="023e105f4ecef8ad9ca31a8372d0c353")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.LookupQueueConsumer(ctx, &cloudflare.LookupQueueConsumerArgs{
    			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
    			QueueId:   "023e105f4ecef8ad9ca31a8372d0c353",
    		}, nil)
    		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 exampleQueueConsumer = Cloudflare.GetQueueConsumer.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            QueueId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetQueueConsumerArgs;
    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) {
            final var exampleQueueConsumer = CloudflareFunctions.getQueueConsumer(GetQueueConsumerArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .queueId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      exampleQueueConsumer:
        fn::invoke:
          function: cloudflare:getQueueConsumer
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
            queueId: 023e105f4ecef8ad9ca31a8372d0c353
    

    Using getQueueConsumer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getQueueConsumer(args: GetQueueConsumerArgs, opts?: InvokeOptions): Promise<GetQueueConsumerResult>
    function getQueueConsumerOutput(args: GetQueueConsumerOutputArgs, opts?: InvokeOptions): Output<GetQueueConsumerResult>
    def get_queue_consumer(account_id: Optional[str] = None,
                           queue_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetQueueConsumerResult
    def get_queue_consumer_output(account_id: Optional[pulumi.Input[str]] = None,
                           queue_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetQueueConsumerResult]
    func LookupQueueConsumer(ctx *Context, args *LookupQueueConsumerArgs, opts ...InvokeOption) (*LookupQueueConsumerResult, error)
    func LookupQueueConsumerOutput(ctx *Context, args *LookupQueueConsumerOutputArgs, opts ...InvokeOption) LookupQueueConsumerResultOutput

    > Note: This function is named LookupQueueConsumer in the Go SDK.

    public static class GetQueueConsumer 
    {
        public static Task<GetQueueConsumerResult> InvokeAsync(GetQueueConsumerArgs args, InvokeOptions? opts = null)
        public static Output<GetQueueConsumerResult> Invoke(GetQueueConsumerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetQueueConsumerResult> getQueueConsumer(GetQueueConsumerArgs args, InvokeOptions options)
    public static Output<GetQueueConsumerResult> getQueueConsumer(GetQueueConsumerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getQueueConsumer:getQueueConsumer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    A Resource identifier.
    QueueId string
    A Resource identifier.
    AccountId string
    A Resource identifier.
    QueueId string
    A Resource identifier.
    accountId String
    A Resource identifier.
    queueId String
    A Resource identifier.
    accountId string
    A Resource identifier.
    queueId string
    A Resource identifier.
    account_id str
    A Resource identifier.
    queue_id str
    A Resource identifier.
    accountId String
    A Resource identifier.
    queueId String
    A Resource identifier.

    getQueueConsumer Result

    The following output properties are available:

    AccountId string
    A Resource identifier.
    ConsumerId string
    A Resource identifier.
    CreatedOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueId string
    A Resource identifier.
    Script string
    Name of a Worker
    ScriptName string
    Name of a Worker
    Settings GetQueueConsumerSettings
    Type string
    Available values: "worker".
    AccountId string
    A Resource identifier.
    ConsumerId string
    A Resource identifier.
    CreatedOn string
    Id string
    The provider-assigned unique ID for this managed resource.
    QueueId string
    A Resource identifier.
    Script string
    Name of a Worker
    ScriptName string
    Name of a Worker
    Settings GetQueueConsumerSettings
    Type string
    Available values: "worker".
    accountId String
    A Resource identifier.
    consumerId String
    A Resource identifier.
    createdOn String
    id String
    The provider-assigned unique ID for this managed resource.
    queueId String
    A Resource identifier.
    script String
    Name of a Worker
    scriptName String
    Name of a Worker
    settings GetQueueConsumerSettings
    type String
    Available values: "worker".
    accountId string
    A Resource identifier.
    consumerId string
    A Resource identifier.
    createdOn string
    id string
    The provider-assigned unique ID for this managed resource.
    queueId string
    A Resource identifier.
    script string
    Name of a Worker
    scriptName string
    Name of a Worker
    settings GetQueueConsumerSettings
    type string
    Available values: "worker".
    account_id str
    A Resource identifier.
    consumer_id str
    A Resource identifier.
    created_on str
    id str
    The provider-assigned unique ID for this managed resource.
    queue_id str
    A Resource identifier.
    script str
    Name of a Worker
    script_name str
    Name of a Worker
    settings GetQueueConsumerSettings
    type str
    Available values: "worker".
    accountId String
    A Resource identifier.
    consumerId String
    A Resource identifier.
    createdOn String
    id String
    The provider-assigned unique ID for this managed resource.
    queueId String
    A Resource identifier.
    script String
    Name of a Worker
    scriptName String
    Name of a Worker
    settings Property Map
    type String
    Available values: "worker".

    Supporting Types

    GetQueueConsumerSettings

    BatchSize double
    The maximum number of messages to include in a batch.
    MaxConcurrency double
    Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
    MaxRetries double
    The maximum number of retries
    MaxWaitTimeMs double
    The number of milliseconds to wait for a batch to fill up before attempting to deliver it
    RetryDelay double
    The number of seconds to delay before making the message available for another attempt.
    VisibilityTimeoutMs double
    The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
    BatchSize float64
    The maximum number of messages to include in a batch.
    MaxConcurrency float64
    Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
    MaxRetries float64
    The maximum number of retries
    MaxWaitTimeMs float64
    The number of milliseconds to wait for a batch to fill up before attempting to deliver it
    RetryDelay float64
    The number of seconds to delay before making the message available for another attempt.
    VisibilityTimeoutMs float64
    The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
    batchSize Double
    The maximum number of messages to include in a batch.
    maxConcurrency Double
    Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
    maxRetries Double
    The maximum number of retries
    maxWaitTimeMs Double
    The number of milliseconds to wait for a batch to fill up before attempting to deliver it
    retryDelay Double
    The number of seconds to delay before making the message available for another attempt.
    visibilityTimeoutMs Double
    The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
    batchSize number
    The maximum number of messages to include in a batch.
    maxConcurrency number
    Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
    maxRetries number
    The maximum number of retries
    maxWaitTimeMs number
    The number of milliseconds to wait for a batch to fill up before attempting to deliver it
    retryDelay number
    The number of seconds to delay before making the message available for another attempt.
    visibilityTimeoutMs number
    The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
    batch_size float
    The maximum number of messages to include in a batch.
    max_concurrency float
    Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
    max_retries float
    The maximum number of retries
    max_wait_time_ms float
    The number of milliseconds to wait for a batch to fill up before attempting to deliver it
    retry_delay float
    The number of seconds to delay before making the message available for another attempt.
    visibility_timeout_ms float
    The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
    batchSize Number
    The maximum number of messages to include in a batch.
    maxConcurrency Number
    Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).
    maxRetries Number
    The maximum number of retries
    maxWaitTimeMs Number
    The number of milliseconds to wait for a batch to fill up before attempting to deliver it
    retryDelay Number
    The number of seconds to delay before making the message available for another attempt.
    visibilityTimeoutMs Number
    The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

    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 v6.1.2 published on Monday, Apr 28, 2025 by Pulumi