Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Queue
  5. Queue
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.Queue.Queue

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Queue resource in Oracle Cloud Infrastructure Queue service.

    Creates a new queue.

    Example Usage

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

const testQueue = new oci.queue.Queue("test_queue", {
    compartmentId: compartmentId,
    displayName: queueDisplayName,
    channelConsumptionLimit: queueChannelConsumptionLimit,
    customEncryptionKeyId: testKey.id,
    deadLetterQueueDeliveryCount: queueDeadLetterQueueDeliveryCount,
    purgeTrigger: purgeTrigger,
    purgeType: purgeType,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    retentionInSeconds: queueRetentionInSeconds,
    timeoutInSeconds: queueTimeoutInSeconds,
    visibilityInSeconds: queueVisibilityInSeconds,
});

    import pulumi
import pulumi_oci as oci

test_queue = oci.queue.Queue("test_queue",
    compartment_id=compartment_id,
    display_name=queue_display_name,
    channel_consumption_limit=queue_channel_consumption_limit,
    custom_encryption_key_id=test_key["id"],
    dead_letter_queue_delivery_count=queue_dead_letter_queue_delivery_count,
    purge_trigger=purge_trigger,
    purge_type=purge_type,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    retention_in_seconds=queue_retention_in_seconds,
    timeout_in_seconds=queue_timeout_in_seconds,
    visibility_in_seconds=queue_visibility_in_seconds)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/queue"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := queue.NewQueue(ctx, "test_queue", &queue.QueueArgs{
			CompartmentId:                pulumi.Any(compartmentId),
			DisplayName:                  pulumi.Any(queueDisplayName),
			ChannelConsumptionLimit:      pulumi.Any(queueChannelConsumptionLimit),
			CustomEncryptionKeyId:        pulumi.Any(testKey.Id),
			DeadLetterQueueDeliveryCount: pulumi.Any(queueDeadLetterQueueDeliveryCount),
			PurgeTrigger:                 pulumi.Any(purgeTrigger),
			PurgeType:                    pulumi.Any(purgeType),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			RetentionInSeconds:  pulumi.Any(queueRetentionInSeconds),
			TimeoutInSeconds:    pulumi.Any(queueTimeoutInSeconds),
			VisibilityInSeconds: pulumi.Any(queueVisibilityInSeconds),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testQueue = new Oci.Queue.Queue("test_queue", new()
    {
        CompartmentId = compartmentId,
        DisplayName = queueDisplayName,
        ChannelConsumptionLimit = queueChannelConsumptionLimit,
        CustomEncryptionKeyId = testKey.Id,
        DeadLetterQueueDeliveryCount = queueDeadLetterQueueDeliveryCount,
        PurgeTrigger = purgeTrigger,
        PurgeType = purgeType,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        RetentionInSeconds = queueRetentionInSeconds,
        TimeoutInSeconds = queueTimeoutInSeconds,
        VisibilityInSeconds = queueVisibilityInSeconds,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Queue.Queue;
import com.pulumi.oci.Queue.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 testQueue = new Queue("testQueue", QueueArgs.builder()
            .compartmentId(compartmentId)
            .displayName(queueDisplayName)
            .channelConsumptionLimit(queueChannelConsumptionLimit)
            .customEncryptionKeyId(testKey.id())
            .deadLetterQueueDeliveryCount(queueDeadLetterQueueDeliveryCount)
            .purgeTrigger(purgeTrigger)
            .purgeType(purgeType)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .retentionInSeconds(queueRetentionInSeconds)
            .timeoutInSeconds(queueTimeoutInSeconds)
            .visibilityInSeconds(queueVisibilityInSeconds)
            .build());

    }
}

    resources:
  testQueue:
    type: oci:Queue:Queue
    name: test_queue
    properties:
      compartmentId: ${compartmentId}
      displayName: ${queueDisplayName}
      channelConsumptionLimit: ${queueChannelConsumptionLimit}
      customEncryptionKeyId: ${testKey.id}
      deadLetterQueueDeliveryCount: ${queueDeadLetterQueueDeliveryCount}
      purgeTrigger: ${purgeTrigger}
      purgeType: ${purgeType}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      retentionInSeconds: ${queueRetentionInSeconds}
      timeoutInSeconds: ${queueTimeoutInSeconds}
      visibilityInSeconds: ${queueVisibilityInSeconds}

    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,
          compartment_id: Optional[str] = None,
          display_name: Optional[str] = None,
          channel_consumption_limit: Optional[int] = None,
          custom_encryption_key_id: Optional[str] = None,
          dead_letter_queue_delivery_count: Optional[int] = None,
          defined_tags: Optional[Mapping[str, str]] = None,
          freeform_tags: Optional[Mapping[str, str]] = None,
          purge_trigger: Optional[int] = None,
          purge_type: Optional[str] = None,
          retention_in_seconds: Optional[int] = None,
          timeout_in_seconds: Optional[int] = None,
          visibility_in_seconds: Optional[int] = 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: oci:Queue: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 Oci.Queue.Queue("queueResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    ChannelConsumptionLimit = 0,
    CustomEncryptionKeyId = "string",
    DeadLetterQueueDeliveryCount = 0,
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    PurgeTrigger = 0,
    PurgeType = "string",
    RetentionInSeconds = 0,
    TimeoutInSeconds = 0,
    VisibilityInSeconds = 0,
});

    example, err := Queue.NewQueue(ctx, "queueResource", &Queue.QueueArgs{
	CompartmentId:                pulumi.String("string"),
	DisplayName:                  pulumi.String("string"),
	ChannelConsumptionLimit:      pulumi.Int(0),
	CustomEncryptionKeyId:        pulumi.String("string"),
	DeadLetterQueueDeliveryCount: pulumi.Int(0),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PurgeTrigger:        pulumi.Int(0),
	PurgeType:           pulumi.String("string"),
	RetentionInSeconds:  pulumi.Int(0),
	TimeoutInSeconds:    pulumi.Int(0),
	VisibilityInSeconds: pulumi.Int(0),
})

    var queueResource = new Queue("queueResource", QueueArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .channelConsumptionLimit(0)
    .customEncryptionKeyId("string")
    .deadLetterQueueDeliveryCount(0)
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .purgeTrigger(0)
    .purgeType("string")
    .retentionInSeconds(0)
    .timeoutInSeconds(0)
    .visibilityInSeconds(0)
    .build());

    queue_resource = oci.queue.Queue("queueResource",
    compartment_id="string",
    display_name="string",
    channel_consumption_limit=0,
    custom_encryption_key_id="string",
    dead_letter_queue_delivery_count=0,
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    purge_trigger=0,
    purge_type="string",
    retention_in_seconds=0,
    timeout_in_seconds=0,
    visibility_in_seconds=0)

    const queueResource = new oci.queue.Queue("queueResource", {
    compartmentId: "string",
    displayName: "string",
    channelConsumptionLimit: 0,
    customEncryptionKeyId: "string",
    deadLetterQueueDeliveryCount: 0,
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    purgeTrigger: 0,
    purgeType: "string",
    retentionInSeconds: 0,
    timeoutInSeconds: 0,
    visibilityInSeconds: 0,
});

    type: oci:Queue:Queue
properties:
    channelConsumptionLimit: 0
    compartmentId: string
    customEncryptionKeyId: string
    deadLetterQueueDeliveryCount: 0
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    purgeTrigger: 0
    purgeType: string
    retentionInSeconds: 0
    timeoutInSeconds: 0
    visibilityInSeconds: 0

    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:

    CompartmentId string
    (Updatable) The OCID of the compartment containing the queue.
    DisplayName string
    (Updatable) The user-friendly name of the queue.
    ChannelConsumptionLimit int
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    CustomEncryptionKeyId string
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    DeadLetterQueueDeliveryCount int
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    PurgeTrigger int
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    PurgeType string

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RetentionInSeconds int
    The retention period of messages in the queue, in seconds.
    TimeoutInSeconds int
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    VisibilityInSeconds int
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the queue.
    DisplayName string
    (Updatable) The user-friendly name of the queue.
    ChannelConsumptionLimit int
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    CustomEncryptionKeyId string
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    DeadLetterQueueDeliveryCount int
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    PurgeTrigger int
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    PurgeType string

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RetentionInSeconds int
    The retention period of messages in the queue, in seconds.
    TimeoutInSeconds int
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    VisibilityInSeconds int
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    compartmentId String
    (Updatable) The OCID of the compartment containing the queue.
    displayName String
    (Updatable) The user-friendly name of the queue.
    channelConsumptionLimit Integer
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    customEncryptionKeyId String
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount Integer
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    purgeTrigger Integer
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purgeType String

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionInSeconds Integer
    The retention period of messages in the queue, in seconds.
    timeoutInSeconds Integer
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds Integer
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    compartmentId string
    (Updatable) The OCID of the compartment containing the queue.
    displayName string
    (Updatable) The user-friendly name of the queue.
    channelConsumptionLimit number
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    customEncryptionKeyId string
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount number
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    purgeTrigger number
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purgeType string

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionInSeconds number
    The retention period of messages in the queue, in seconds.
    timeoutInSeconds number
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds number
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    compartment_id str
    (Updatable) The OCID of the compartment containing the queue.
    display_name str
    (Updatable) The user-friendly name of the queue.
    channel_consumption_limit int
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    custom_encryption_key_id str
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    dead_letter_queue_delivery_count int
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    purge_trigger int
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purge_type str

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retention_in_seconds int
    The retention period of messages in the queue, in seconds.
    timeout_in_seconds int
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibility_in_seconds int
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    compartmentId String
    (Updatable) The OCID of the compartment containing the queue.
    displayName String
    (Updatable) The user-friendly name of the queue.
    channelConsumptionLimit Number
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    customEncryptionKeyId String
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount Number
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    purgeTrigger Number
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purgeType String

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionInSeconds Number
    The retention period of messages in the queue, in seconds.
    timeoutInSeconds Number
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds Number
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.

    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.
    LifecycleDetails string
    Any additional details about the current state of the queue.
    MessagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    State string
    The current state of the queue.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    Any additional details about the current state of the queue.
    MessagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    State string
    The current state of the queue.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Any additional details about the current state of the queue.
    messagesEndpoint String
    The endpoint to use to consume or publish messages in the queue.
    state String
    The current state of the queue.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    Any additional details about the current state of the queue.
    messagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    state string
    The current state of the queue.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    Any additional details about the current state of the queue.
    messages_endpoint str
    The endpoint to use to consume or publish messages in the queue.
    state str
    The current state of the queue.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    time_updated str
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    Any additional details about the current state of the queue.
    messagesEndpoint String
    The endpoint to use to consume or publish messages in the queue.
    state String
    The current state of the queue.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    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,
        channel_consumption_limit: Optional[int] = None,
        compartment_id: Optional[str] = None,
        custom_encryption_key_id: Optional[str] = None,
        dead_letter_queue_delivery_count: Optional[int] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        messages_endpoint: Optional[str] = None,
        purge_trigger: Optional[int] = None,
        purge_type: Optional[str] = None,
        retention_in_seconds: Optional[int] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        timeout_in_seconds: Optional[int] = None,
        visibility_in_seconds: Optional[int] = 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)
    resources:  _:    type: oci:Queue:Queue    get:      id: ${id}
    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:
    ChannelConsumptionLimit int
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the queue.
    CustomEncryptionKeyId string
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    DeadLetterQueueDeliveryCount int
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) The user-friendly name of the queue.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    Any additional details about the current state of the queue.
    MessagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    PurgeTrigger int
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    PurgeType string

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RetentionInSeconds int
    The retention period of messages in the queue, in seconds.
    State string
    The current state of the queue.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeoutInSeconds int
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    VisibilityInSeconds int
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    ChannelConsumptionLimit int
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    CompartmentId string
    (Updatable) The OCID of the compartment containing the queue.
    CustomEncryptionKeyId string
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    DeadLetterQueueDeliveryCount int
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) The user-friendly name of the queue.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails string
    Any additional details about the current state of the queue.
    MessagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    PurgeTrigger int
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    PurgeType string

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RetentionInSeconds int
    The retention period of messages in the queue, in seconds.
    State string
    The current state of the queue.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeoutInSeconds int
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    VisibilityInSeconds int
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    channelConsumptionLimit Integer
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    compartmentId String
    (Updatable) The OCID of the compartment containing the queue.
    customEncryptionKeyId String
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount Integer
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) The user-friendly name of the queue.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    Any additional details about the current state of the queue.
    messagesEndpoint String
    The endpoint to use to consume or publish messages in the queue.
    purgeTrigger Integer
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purgeType String

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionInSeconds Integer
    The retention period of messages in the queue, in seconds.
    state String
    The current state of the queue.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeoutInSeconds Integer
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds Integer
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    channelConsumptionLimit number
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    compartmentId string
    (Updatable) The OCID of the compartment containing the queue.
    customEncryptionKeyId string
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount number
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) The user-friendly name of the queue.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails string
    Any additional details about the current state of the queue.
    messagesEndpoint string
    The endpoint to use to consume or publish messages in the queue.
    purgeTrigger number
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purgeType string

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionInSeconds number
    The retention period of messages in the queue, in seconds.
    state string
    The current state of the queue.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated string
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeoutInSeconds number
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds number
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    channel_consumption_limit int
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    compartment_id str
    (Updatable) The OCID of the compartment containing the queue.
    custom_encryption_key_id str
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    dead_letter_queue_delivery_count int
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) The user-friendly name of the queue.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycle_details str
    Any additional details about the current state of the queue.
    messages_endpoint str
    The endpoint to use to consume or publish messages in the queue.
    purge_trigger int
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purge_type str

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retention_in_seconds int
    The retention period of messages in the queue, in seconds.
    state str
    The current state of the queue.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    time_updated str
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeout_in_seconds int
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibility_in_seconds int
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
    channelConsumptionLimit Number
    (Updatable) The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
    compartmentId String
    (Updatable) The OCID of the compartment containing the queue.
    customEncryptionKeyId String
    (Updatable) The OCID of the custom encryption key to be used to encrypt messages content.
    deadLetterQueueDeliveryCount Number
    (Updatable) The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) The user-friendly name of the queue.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails String
    Any additional details about the current state of the queue.
    messagesEndpoint String
    The endpoint to use to consume or publish messages in the queue.
    purgeTrigger Number
    (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
    purgeType String

    (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    retentionInSeconds Number
    The retention period of messages in the queue, in seconds.
    state String
    The current state of the queue.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time that the queue was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the queue was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeoutInSeconds Number
    (Updatable) The default polling timeout of the messages in the queue, in seconds.
    visibilityInSeconds Number
    (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.

    Import

    Queues can be imported using the id, e.g.

    $ pulumi import oci:Queue/queue:Queue test_queue "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci