1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Queue
  5. ConsumerGroup
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Queue.ConsumerGroup

oci logo
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

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

    Creates a new consumer group.

    Example Usage

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

const testConsumerGroup = new oci.queue.ConsumerGroup("test_consumer_group", {
    displayName: consumerGroupDisplayName,
    queueId: testQueue.id,
    consumerGroupFilter: consumerGroupConsumerGroupFilter,
    deadLetterQueueDeliveryCount: consumerGroupDeadLetterQueueDeliveryCount,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    isEnabled: consumerGroupIsEnabled,
});

    import pulumi
import pulumi_oci as oci

test_consumer_group = oci.queue.ConsumerGroup("test_consumer_group",
    display_name=consumer_group_display_name,
    queue_id=test_queue["id"],
    consumer_group_filter=consumer_group_consumer_group_filter,
    dead_letter_queue_delivery_count=consumer_group_dead_letter_queue_delivery_count,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    is_enabled=consumer_group_is_enabled)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := queue.NewConsumerGroup(ctx, "test_consumer_group", &queue.ConsumerGroupArgs{
			DisplayName:                  pulumi.Any(consumerGroupDisplayName),
			QueueId:                      pulumi.Any(testQueue.Id),
			ConsumerGroupFilter:          pulumi.Any(consumerGroupConsumerGroupFilter),
			DeadLetterQueueDeliveryCount: pulumi.Any(consumerGroupDeadLetterQueueDeliveryCount),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			IsEnabled: pulumi.Any(consumerGroupIsEnabled),
		})
		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 testConsumerGroup = new Oci.Queue.ConsumerGroup("test_consumer_group", new()
    {
        DisplayName = consumerGroupDisplayName,
        QueueId = testQueue.Id,
        ConsumerGroupFilter = consumerGroupConsumerGroupFilter,
        DeadLetterQueueDeliveryCount = consumerGroupDeadLetterQueueDeliveryCount,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        IsEnabled = consumerGroupIsEnabled,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Queue.ConsumerGroup;
import com.pulumi.oci.Queue.ConsumerGroupArgs;
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 testConsumerGroup = new ConsumerGroup("testConsumerGroup", ConsumerGroupArgs.builder()
            .displayName(consumerGroupDisplayName)
            .queueId(testQueue.id())
            .consumerGroupFilter(consumerGroupConsumerGroupFilter)
            .deadLetterQueueDeliveryCount(consumerGroupDeadLetterQueueDeliveryCount)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .isEnabled(consumerGroupIsEnabled)
            .build());

    }
}

    resources:
  testConsumerGroup:
    type: oci:Queue:ConsumerGroup
    name: test_consumer_group
    properties:
      displayName: ${consumerGroupDisplayName}
      queueId: ${testQueue.id}
      consumerGroupFilter: ${consumerGroupConsumerGroupFilter}
      deadLetterQueueDeliveryCount: ${consumerGroupDeadLetterQueueDeliveryCount}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      isEnabled: ${consumerGroupIsEnabled}

    Create ConsumerGroup Resource

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

    Constructor syntax

    new ConsumerGroup(name: string, args: ConsumerGroupArgs, opts?: CustomResourceOptions);
    @overload
def ConsumerGroup(resource_name: str,
                  args: ConsumerGroupArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ConsumerGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  queue_id: Optional[str] = None,
                  consumer_group_filter: 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,
                  is_enabled: Optional[bool] = None)
    func NewConsumerGroup(ctx *Context, name string, args ConsumerGroupArgs, opts ...ResourceOption) (*ConsumerGroup, error)
    public ConsumerGroup(string name, ConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public ConsumerGroup(String name, ConsumerGroupArgs args)
public ConsumerGroup(String name, ConsumerGroupArgs args, CustomResourceOptions options)

    type: oci:Queue:ConsumerGroup
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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    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 ConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsumerGroupArgs
    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 consumerGroupResource = new Oci.Queue.ConsumerGroup("consumerGroupResource", new()
{
    DisplayName = "string",
    QueueId = "string",
    ConsumerGroupFilter = "string",
    DeadLetterQueueDeliveryCount = 0,
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsEnabled = false,
});

    example, err := queue.NewConsumerGroup(ctx, "consumerGroupResource", &queue.ConsumerGroupArgs{
	DisplayName:                  pulumi.String("string"),
	QueueId:                      pulumi.String("string"),
	ConsumerGroupFilter:          pulumi.String("string"),
	DeadLetterQueueDeliveryCount: pulumi.Int(0),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsEnabled: pulumi.Bool(false),
})

    var consumerGroupResource = new ConsumerGroup("consumerGroupResource", ConsumerGroupArgs.builder()
    .displayName("string")
    .queueId("string")
    .consumerGroupFilter("string")
    .deadLetterQueueDeliveryCount(0)
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .isEnabled(false)
    .build());

    consumer_group_resource = oci.queue.ConsumerGroup("consumerGroupResource",
    display_name="string",
    queue_id="string",
    consumer_group_filter="string",
    dead_letter_queue_delivery_count=0,
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    is_enabled=False)

    const consumerGroupResource = new oci.queue.ConsumerGroup("consumerGroupResource", {
    displayName: "string",
    queueId: "string",
    consumerGroupFilter: "string",
    deadLetterQueueDeliveryCount: 0,
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    isEnabled: false,
});

    type: oci:Queue:ConsumerGroup
properties:
    consumerGroupFilter: string
    deadLetterQueueDeliveryCount: 0
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    isEnabled: false
    queueId: string

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

    DisplayName string
    (Updatable) The user-friendly name of the consumer group.
    QueueId string

    The OCID of the associated queue.

    ** 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

    ConsumerGroupFilter string
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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"}
    IsEnabled bool
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    DisplayName string
    (Updatable) The user-friendly name of the consumer group.
    QueueId string

    The OCID of the associated queue.

    ** 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

    ConsumerGroupFilter string
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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"}
    IsEnabled bool
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    displayName String
    (Updatable) The user-friendly name of the consumer group.
    queueId String

    The OCID of the associated queue.

    ** 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

    consumerGroupFilter String
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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"}
    isEnabled Boolean
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    displayName string
    (Updatable) The user-friendly name of the consumer group.
    queueId string

    The OCID of the associated queue.

    ** 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

    consumerGroupFilter string
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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"}
    isEnabled boolean
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    display_name str
    (Updatable) The user-friendly name of the consumer group.
    queue_id str

    The OCID of the associated queue.

    ** 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

    consumer_group_filter str
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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"}
    is_enabled bool
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    displayName String
    (Updatable) The user-friendly name of the consumer group.
    queueId String

    The OCID of the associated queue.

    ** 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

    consumerGroupFilter String
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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"}
    isEnabled Boolean
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsumerGroup 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 consumer group.
    State string
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the consumer group 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 consumer group.
    State string
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the consumer group 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 consumer group.
    state String
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the consumer group 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 consumer group.
    state string
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated string
    The time that the consumer group 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 consumer group.
    state str
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    time_updated str
    The time that the consumer group 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 consumer group.
    state String
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Look up Existing ConsumerGroup Resource

    Get an existing ConsumerGroup 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?: ConsumerGroupState, opts?: CustomResourceOptions): ConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer_group_filter: 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,
        is_enabled: Optional[bool] = None,
        lifecycle_details: Optional[str] = None,
        queue_id: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ConsumerGroup
    func GetConsumerGroup(ctx *Context, name string, id IDInput, state *ConsumerGroupState, opts ...ResourceOption) (*ConsumerGroup, error)
    public static ConsumerGroup Get(string name, Input<string> id, ConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static ConsumerGroup get(String name, Output<String> id, ConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: oci:Queue:ConsumerGroup    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:
    ConsumerGroupFilter string
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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 consumer group.
    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"}
    IsEnabled bool
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    LifecycleDetails string
    Any additional details about the current state of the consumer group.
    QueueId string

    The OCID of the associated queue.

    ** 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

    State string
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    ConsumerGroupFilter string
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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 consumer group.
    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"}
    IsEnabled bool
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    LifecycleDetails string
    Any additional details about the current state of the consumer group.
    QueueId string

    The OCID of the associated queue.

    ** 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

    State string
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    TimeUpdated string
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumerGroupFilter String
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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 consumer group.
    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"}
    isEnabled Boolean
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    lifecycleDetails String
    Any additional details about the current state of the consumer group.
    queueId String

    The OCID of the associated queue.

    ** 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

    state String
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumerGroupFilter string
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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 consumer group.
    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"}
    isEnabled boolean
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    lifecycleDetails string
    Any additional details about the current state of the consumer group.
    queueId string

    The OCID of the associated queue.

    ** 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

    state string
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated string
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumer_group_filter str
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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 consumer group.
    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"}
    is_enabled bool
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    lifecycle_details str
    Any additional details about the current state of the consumer group.
    queue_id str

    The OCID of the associated queue.

    ** 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

    state str
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    time_updated str
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    consumerGroupFilter String
    (Updatable) The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. The primary consumer group cannot have any filter.
    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. If the value isn't specified, it will be using the value defined at the queue level.
    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 consumer group.
    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"}
    isEnabled Boolean
    (Updatable) Used to enable or disable the consumer group. An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
    lifecycleDetails String
    Any additional details about the current state of the consumer group.
    queueId String

    The OCID of the associated queue.

    ** 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

    state String
    The current state of the consumer group.
    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 consumer group was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    timeUpdated String
    The time that the consumer group was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Import

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

    $ pulumi import oci:Queue/consumerGroup:ConsumerGroup test_consumer_group "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 v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate