Cloudflare v6.0.1, Apr 16 25

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getQueue

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const exampleQueue = cloudflare.getQueue({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    queueId: "023e105f4ecef8ad9ca31a8372d0c353",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_queue = cloudflare.get_queue(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.LookupQueue(ctx, &cloudflare.LookupQueueArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			QueueId:   pulumi.StringRef("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 exampleQueue = Cloudflare.GetQueue.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.GetQueueArgs;
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 exampleQueue = CloudflareFunctions.getQueue(GetQueueArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .queueId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}

variables:
  exampleQueue:
    fn::invoke:
      function: cloudflare:getQueue
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        queueId: 023e105f4ecef8ad9ca31a8372d0c353

Using getQueue

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.

TypeScript
Python
Go
C#
Java
YAML

function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>

def get_queue(account_id: Optional[str] = None,
              queue_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(account_id: Optional[pulumi.Input[str]] = None,
              queue_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]

func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)
func LookupQueueOutput(ctx *Context, args *LookupQueueOutputArgs, opts ...InvokeOption) LookupQueueResultOutput

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

public static class GetQueue 
{
    public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
public static Output<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getQueue:getQueue
  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.

getQueue Result

The following output properties are available:

AccountId string: A Resource identifier.
Consumers List<GetQueueConsumer>
ConsumersTotalCount double
CreatedOn string
Id string: A Resource identifier.
ModifiedOn string
Producers List<GetQueueProducer>
ProducersTotalCount double
QueueId string: A Resource identifier.
QueueName string
Settings GetQueueSettings

AccountId string: A Resource identifier.
Consumers []GetQueueConsumerType
ConsumersTotalCount float64
CreatedOn string
Id string: A Resource identifier.
ModifiedOn string
Producers []GetQueueProducer
ProducersTotalCount float64
QueueId string: A Resource identifier.
QueueName string
Settings GetQueueSettings

accountId String: A Resource identifier.
consumers List<GetQueueConsumer>
consumersTotalCount Double
createdOn String
id String: A Resource identifier.
modifiedOn String
producers List<GetQueueProducer>
producersTotalCount Double
queueId String: A Resource identifier.
queueName String
settings GetQueueSettings

accountId string: A Resource identifier.
consumers GetQueueConsumer[]
consumersTotalCount number
createdOn string
id string: A Resource identifier.
modifiedOn string
producers GetQueueProducer[]
producersTotalCount number
queueId string: A Resource identifier.
queueName string
settings GetQueueSettings

account_id str: A Resource identifier.
consumers Sequence[GetQueueConsumer]
consumers_total_count float
created_on str
id str: A Resource identifier.
modified_on str
producers Sequence[GetQueueProducer]
producers_total_count float
queue_id str: A Resource identifier.
queue_name str
settings GetQueueSettings

accountId String: A Resource identifier.
consumers List<Property Map>
consumersTotalCount Number
createdOn String
id String: A Resource identifier.
modifiedOn String
producers List<Property Map>
producersTotalCount Number
queueId String: A Resource identifier.
queueName String
settings Property Map

Supporting Types

GetQueueConsumer

ConsumerId string: A Resource identifier.
CreatedOn string
QueueId string: A Resource identifier.
Script string: Name of a Worker
ScriptName string: Name of a Worker
Settings GetQueueConsumerSettings
Type string: Available values: "worker".

ConsumerId string: A Resource identifier.
CreatedOn string
QueueId string: A Resource identifier.
Script string: Name of a Worker
ScriptName string: Name of a Worker
Settings GetQueueConsumerSettings
Type string: Available values: "worker".

consumerId String: A Resource identifier.
createdOn String
queueId String: A Resource identifier.
script String: Name of a Worker
scriptName String: Name of a Worker
settings GetQueueConsumerSettings
type String: Available values: "worker".

consumerId string: A Resource identifier.
createdOn string
queueId string: A Resource identifier.
script string: Name of a Worker
scriptName string: Name of a Worker
settings GetQueueConsumerSettings
type string: Available values: "worker".

consumer_id str: A Resource identifier.
created_on str
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".

consumerId String: A Resource identifier.
createdOn String
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".

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.

GetQueueProducer

BucketName string
Script string
Type string: Available values: "worker".

BucketName string
Script string
Type string: Available values: "worker".

bucketName String
script String
type String: Available values: "worker".

bucketName string
script string
type string: Available values: "worker".

bucket_name str
script str
type str: Available values: "worker".

bucketName String
script String
type String: Available values: "worker".

GetQueueSettings

DeliveryDelay double: Number of seconds to delay delivery of all messages to consumers.
MessageRetentionPeriod double: Number of seconds after which an unconsumed message will be delayed.

DeliveryDelay float64: Number of seconds to delay delivery of all messages to consumers.
MessageRetentionPeriod float64: Number of seconds after which an unconsumed message will be delayed.

deliveryDelay Double: Number of seconds to delay delivery of all messages to consumers.
messageRetentionPeriod Double: Number of seconds after which an unconsumed message will be delayed.

deliveryDelay number: Number of seconds to delay delivery of all messages to consumers.
messageRetentionPeriod number: Number of seconds after which an unconsumed message will be delayed.

delivery_delay float: Number of seconds to delay delivery of all messages to consumers.
message_retention_period float: Number of seconds after which an unconsumed message will be delayed.

deliveryDelay Number: Number of seconds to delay delivery of all messages to consumers.
messageRetentionPeriod Number: Number of seconds after which an unconsumed message will be delayed.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getQueue

On this page

On this page

Example Usage

Using getQueue

getQueue Result

Supporting Types

GetQueueConsumer

GetQueueConsumerSettings

GetQueueProducer

GetQueueSettings

Package Details

On this page

On this page