Queue

A named resource to which messages are sent by publishers.

Create a Queue Resource

new Queue(name: string, args: QueueArgs, opts?: CustomResourceOptions);

def Queue(resource_name, opts=None, app_engine_routing_override=None, location=None, name=None, project=None, rate_limits=None, retry_config=None, __props__=None);

func NewQueue(ctx *Context, name string, args QueueArgs, opts ...ResourceOption) (*Queue, error)

public Queue(string name, QueueArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Queue Resource Properties

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

Inputs

The Queue resource accepts the following input properties:

Location string: The location of the queue
AppEngineRoutingOverride QueueAppEngineRoutingOverrideArgs: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
Name string: The queue name.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RateLimits QueueRateLimitsArgs: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
RetryConfig QueueRetryConfigArgs: Settings that determine the retry behavior. Structure is documented below.

Location string: The location of the queue
AppEngineRoutingOverride QueueAppEngineRoutingOverride: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
Name string: The queue name.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RateLimits QueueRateLimits: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
RetryConfig QueueRetryConfig: Settings that determine the retry behavior. Structure is documented below.

location string: The location of the queue
appEngineRoutingOverride QueueAppEngineRoutingOverride: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
name string: The queue name.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rateLimits QueueRateLimits: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
retryConfig QueueRetryConfig: Settings that determine the retry behavior. Structure is documented below.

location str: The location of the queue
app_engine_routing_override Dict[QueueAppEngineRoutingOverride]: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
name str: The queue name.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rate_limits Dict[QueueRateLimits]: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
retry_config Dict[QueueRetryConfig]: Settings that determine the retry behavior. Structure is documented below.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, app_engine_routing_override=None, location=None, name=None, project=None, rate_limits=None, retry_config=None, __props__=None);

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)

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.

The following state arguments are supported:

AppEngineRoutingOverride QueueAppEngineRoutingOverrideArgs: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
Location string: The location of the queue
Name string: The queue name.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RateLimits QueueRateLimitsArgs: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
RetryConfig QueueRetryConfigArgs: Settings that determine the retry behavior. Structure is documented below.

AppEngineRoutingOverride QueueAppEngineRoutingOverride: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
Location string: The location of the queue
Name string: The queue name.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RateLimits QueueRateLimits: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
RetryConfig QueueRetryConfig: Settings that determine the retry behavior. Structure is documented below.

appEngineRoutingOverride QueueAppEngineRoutingOverride: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
location string: The location of the queue
name string: The queue name.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rateLimits QueueRateLimits: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
retryConfig QueueRetryConfig: Settings that determine the retry behavior. Structure is documented below.

app_engine_routing_override Dict[QueueAppEngineRoutingOverride]: Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.
location str: The location of the queue
name str: The queue name.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
rate_limits Dict[QueueRateLimits]: Rate limits for task dispatches. The queue’s actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rateLimits, retryConfig, and the queue’s state. * System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. Structure is documented below.
retry_config Dict[QueueRetryConfig]: Settings that determine the retry behavior. Structure is documented below.

Supporting Types

QueueAppEngineRoutingOverride

See the input and output API doc for this type.

Host string: - The host that the task is sent to.
Instance string: App instance. By default, the task is sent to an instance which is available when the task is attempted.
Service string: App service. By default, the task is sent to the service which is the default service when the task is attempted.
Version string: App version. By default, the task is sent to the version which is the default version when the task is attempted.

Host string: - The host that the task is sent to.
Instance string: App instance. By default, the task is sent to an instance which is available when the task is attempted.
Service string: App service. By default, the task is sent to the service which is the default service when the task is attempted.
Version string: App version. By default, the task is sent to the version which is the default version when the task is attempted.

host string: - The host that the task is sent to.
instance string: App instance. By default, the task is sent to an instance which is available when the task is attempted.
service string: App service. By default, the task is sent to the service which is the default service when the task is attempted.
version string: App version. By default, the task is sent to the version which is the default version when the task is attempted.

host str: - The host that the task is sent to.
instance str: App instance. By default, the task is sent to an instance which is available when the task is attempted.
service str: App service. By default, the task is sent to the service which is the default service when the task is attempted.
version str: App version. By default, the task is sent to the version which is the default version when the task is attempted.

QueueRateLimits

See the input and output API doc for this type.

MaxBurstSize int: - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
MaxConcurrentDispatches int: The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
MaxDispatchesPerSecond double: The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

MaxBurstSize int: - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
MaxConcurrentDispatches int: The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
MaxDispatchesPerSecond float64: The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

maxBurstSize number: - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
maxConcurrentDispatches number: The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
maxDispatchesPerSecond number: The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

maxBurstSize float: - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.
maxConcurrentDispatches float: The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
maxDispatchesPerSecond float: The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

QueueRetryConfig

See the input and output API doc for this type.

MaxAttempts int: Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
MaxBackoff string: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.
MaxDoublings int: The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
MaxRetryDuration string: If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
MinBackoff string: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

MaxAttempts int: Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
MaxBackoff string: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.
MaxDoublings int: The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
MaxRetryDuration string: If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
MinBackoff string: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

maxAttempts number: Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
maxBackoff string: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.
maxDoublings number: The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
maxRetryDuration string: If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
minBackoff string: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

maxAttempts float: Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.
maxBackoff str: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.
maxDoublings float: The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.
maxRetryDuration str: If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.
minBackoff str: A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Queue

Create a Queue Resource

Queue Resource Properties

Inputs

Outputs

Look up an Existing Queue Resource

Supporting Types

QueueAppEngineRoutingOverride

QueueRateLimits

QueueRetryConfig

Package Details

On This Page