Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. DmsRocketmqConsumerGroup
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.DmsRocketmqConsumerGroup

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages DMS RocketMQ consumer group resources within FlexibleEngine.

    Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const test = new flexibleengine.DmsRocketmqConsumerGroup("test", {
    instanceId: instanceId,
    enabled: true,
    broadcast: true,
    brokers: [
        "broker-0",
        "broker-1",
    ],
    retryMaxTimes: 3,
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
test = flexibleengine.DmsRocketmqConsumerGroup("test",
    instance_id=instance_id,
    enabled=True,
    broadcast=True,
    brokers=[
        "broker-0",
        "broker-1",
    ],
    retry_max_times=3)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		_, err := flexibleengine.NewDmsRocketmqConsumerGroup(ctx, "test", &flexibleengine.DmsRocketmqConsumerGroupArgs{
			InstanceId: pulumi.Any(instanceId),
			Enabled:    pulumi.Bool(true),
			Broadcast:  pulumi.Bool(true),
			Brokers: pulumi.StringArray{
				pulumi.String("broker-0"),
				pulumi.String("broker-1"),
			},
			RetryMaxTimes: pulumi.Float64(3),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var test = new Flexibleengine.DmsRocketmqConsumerGroup("test", new()
    {
        InstanceId = instanceId,
        Enabled = true,
        Broadcast = true,
        Brokers = new[]
        {
            "broker-0",
            "broker-1",
        },
        RetryMaxTimes = 3,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.DmsRocketmqConsumerGroup;
import com.pulumi.flexibleengine.DmsRocketmqConsumerGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        var test = new DmsRocketmqConsumerGroup("test", DmsRocketmqConsumerGroupArgs.builder()
            .instanceId(instanceId)
            .enabled(true)
            .broadcast(true)
            .brokers(            
                "broker-0",
                "broker-1")
            .retryMaxTimes(3)
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
resources:
  test:
    type: flexibleengine:DmsRocketmqConsumerGroup
    properties:
      instanceId: ${instanceId}
      enabled: true
      broadcast: true
      brokers:
        - broker-0
        - broker-1
      retryMaxTimes: 3

    Create DmsRocketmqConsumerGroup Resource

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

    Constructor syntax

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

@overload
def DmsRocketmqConsumerGroup(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             brokers: Optional[Sequence[str]] = None,
                             instance_id: Optional[str] = None,
                             retry_max_times: Optional[float] = None,
                             broadcast: Optional[bool] = None,
                             dms_rocketmq_consumer_group_id: Optional[str] = None,
                             enabled: Optional[bool] = None,
                             name: Optional[str] = None,
                             region: Optional[str] = None)
    func NewDmsRocketmqConsumerGroup(ctx *Context, name string, args DmsRocketmqConsumerGroupArgs, opts ...ResourceOption) (*DmsRocketmqConsumerGroup, error)
    public DmsRocketmqConsumerGroup(string name, DmsRocketmqConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public DmsRocketmqConsumerGroup(String name, DmsRocketmqConsumerGroupArgs args)
public DmsRocketmqConsumerGroup(String name, DmsRocketmqConsumerGroupArgs args, CustomResourceOptions options)

    type: flexibleengine:DmsRocketmqConsumerGroup
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 DmsRocketmqConsumerGroupArgs
    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 DmsRocketmqConsumerGroupArgs
    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 DmsRocketmqConsumerGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DmsRocketmqConsumerGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DmsRocketmqConsumerGroupArgs
    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 dmsRocketmqConsumerGroupResource = new Flexibleengine.DmsRocketmqConsumerGroup("dmsRocketmqConsumerGroupResource", new()
{
    Brokers = new[]
    {
        "string",
    },
    InstanceId = "string",
    RetryMaxTimes = 0,
    Broadcast = false,
    DmsRocketmqConsumerGroupId = "string",
    Enabled = false,
    Name = "string",
    Region = "string",
});

    example, err := flexibleengine.NewDmsRocketmqConsumerGroup(ctx, "dmsRocketmqConsumerGroupResource", &flexibleengine.DmsRocketmqConsumerGroupArgs{
	Brokers: pulumi.StringArray{
		pulumi.String("string"),
	},
	InstanceId:                 pulumi.String("string"),
	RetryMaxTimes:              pulumi.Float64(0),
	Broadcast:                  pulumi.Bool(false),
	DmsRocketmqConsumerGroupId: pulumi.String("string"),
	Enabled:                    pulumi.Bool(false),
	Name:                       pulumi.String("string"),
	Region:                     pulumi.String("string"),
})

    var dmsRocketmqConsumerGroupResource = new DmsRocketmqConsumerGroup("dmsRocketmqConsumerGroupResource", DmsRocketmqConsumerGroupArgs.builder()
    .brokers("string")
    .instanceId("string")
    .retryMaxTimes(0)
    .broadcast(false)
    .dmsRocketmqConsumerGroupId("string")
    .enabled(false)
    .name("string")
    .region("string")
    .build());

    dms_rocketmq_consumer_group_resource = flexibleengine.DmsRocketmqConsumerGroup("dmsRocketmqConsumerGroupResource",
    brokers=["string"],
    instance_id="string",
    retry_max_times=0,
    broadcast=False,
    dms_rocketmq_consumer_group_id="string",
    enabled=False,
    name="string",
    region="string")

    const dmsRocketmqConsumerGroupResource = new flexibleengine.DmsRocketmqConsumerGroup("dmsRocketmqConsumerGroupResource", {
    brokers: ["string"],
    instanceId: "string",
    retryMaxTimes: 0,
    broadcast: false,
    dmsRocketmqConsumerGroupId: "string",
    enabled: false,
    name: "string",
    region: "string",
});

    type: flexibleengine:DmsRocketmqConsumerGroup
properties:
    broadcast: false
    brokers:
        - string
    dmsRocketmqConsumerGroupId: string
    enabled: false
    instanceId: string
    name: string
    region: string
    retryMaxTimes: 0

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

    Brokers List<string>

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    InstanceId string

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    RetryMaxTimes double
    Specifies the maximum number of retry times.
    Broadcast bool
    Specifies whether to broadcast of the consumer group.
    DmsRocketmqConsumerGroupId string
    The resource ID.
    Enabled bool
    Specifies the consumer group is enabled or not. Default to true.
    Name string

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    Region string
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    Brokers []string

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    InstanceId string

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    RetryMaxTimes float64
    Specifies the maximum number of retry times.
    Broadcast bool
    Specifies whether to broadcast of the consumer group.
    DmsRocketmqConsumerGroupId string
    The resource ID.
    Enabled bool
    Specifies the consumer group is enabled or not. Default to true.
    Name string

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    Region string
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    brokers List<String>

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    instanceId String

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    retryMaxTimes Double
    Specifies the maximum number of retry times.
    broadcast Boolean
    Specifies whether to broadcast of the consumer group.
    dmsRocketmqConsumerGroupId String
    The resource ID.
    enabled Boolean
    Specifies the consumer group is enabled or not. Default to true.
    name String

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region String
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    brokers string[]

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    instanceId string

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    retryMaxTimes number
    Specifies the maximum number of retry times.
    broadcast boolean
    Specifies whether to broadcast of the consumer group.
    dmsRocketmqConsumerGroupId string
    The resource ID.
    enabled boolean
    Specifies the consumer group is enabled or not. Default to true.
    name string

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region string
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    brokers Sequence[str]

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    instance_id str

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    retry_max_times float
    Specifies the maximum number of retry times.
    broadcast bool
    Specifies whether to broadcast of the consumer group.
    dms_rocketmq_consumer_group_id str
    The resource ID.
    enabled bool
    Specifies the consumer group is enabled or not. Default to true.
    name str

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region str
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    brokers List<String>

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    instanceId String

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    retryMaxTimes Number
    Specifies the maximum number of retry times.
    broadcast Boolean
    Specifies whether to broadcast of the consumer group.
    dmsRocketmqConsumerGroupId String
    The resource ID.
    enabled Boolean
    Specifies the consumer group is enabled or not. Default to true.
    name String

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region String
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DmsRocketmqConsumerGroup 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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DmsRocketmqConsumerGroup Resource

    Get an existing DmsRocketmqConsumerGroup 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?: DmsRocketmqConsumerGroupState, opts?: CustomResourceOptions): DmsRocketmqConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        broadcast: Optional[bool] = None,
        brokers: Optional[Sequence[str]] = None,
        dms_rocketmq_consumer_group_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        retry_max_times: Optional[float] = None) -> DmsRocketmqConsumerGroup
    func GetDmsRocketmqConsumerGroup(ctx *Context, name string, id IDInput, state *DmsRocketmqConsumerGroupState, opts ...ResourceOption) (*DmsRocketmqConsumerGroup, error)
    public static DmsRocketmqConsumerGroup Get(string name, Input<string> id, DmsRocketmqConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static DmsRocketmqConsumerGroup get(String name, Output<String> id, DmsRocketmqConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:DmsRocketmqConsumerGroup    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:
    Broadcast bool
    Specifies whether to broadcast of the consumer group.
    Brokers List<string>

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    DmsRocketmqConsumerGroupId string
    The resource ID.
    Enabled bool
    Specifies the consumer group is enabled or not. Default to true.
    InstanceId string

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    Name string

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    Region string
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    RetryMaxTimes double
    Specifies the maximum number of retry times.
    Broadcast bool
    Specifies whether to broadcast of the consumer group.
    Brokers []string

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    DmsRocketmqConsumerGroupId string
    The resource ID.
    Enabled bool
    Specifies the consumer group is enabled or not. Default to true.
    InstanceId string

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    Name string

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    Region string
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    RetryMaxTimes float64
    Specifies the maximum number of retry times.
    broadcast Boolean
    Specifies whether to broadcast of the consumer group.
    brokers List<String>

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    dmsRocketmqConsumerGroupId String
    The resource ID.
    enabled Boolean
    Specifies the consumer group is enabled or not. Default to true.
    instanceId String

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    name String

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region String
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    retryMaxTimes Double
    Specifies the maximum number of retry times.
    broadcast boolean
    Specifies whether to broadcast of the consumer group.
    brokers string[]

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    dmsRocketmqConsumerGroupId string
    The resource ID.
    enabled boolean
    Specifies the consumer group is enabled or not. Default to true.
    instanceId string

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    name string

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region string
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    retryMaxTimes number
    Specifies the maximum number of retry times.
    broadcast bool
    Specifies whether to broadcast of the consumer group.
    brokers Sequence[str]

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    dms_rocketmq_consumer_group_id str
    The resource ID.
    enabled bool
    Specifies the consumer group is enabled or not. Default to true.
    instance_id str

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    name str

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region str
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    retry_max_times float
    Specifies the maximum number of retry times.
    broadcast Boolean
    Specifies whether to broadcast of the consumer group.
    brokers List<String>

    Specifies the list of associated brokers of the consumer group.

    Changing this parameter will create a new resource.

    dmsRocketmqConsumerGroupId String
    The resource ID.
    enabled Boolean
    Specifies the consumer group is enabled or not. Default to true.
    instanceId String

    Specifies the ID of the rocketMQ instance.

    Changing this parameter will create a new resource.

    name String

    Specifies the name of the consumer group.

    Changing this parameter will create a new resource.

    region String
    Specifies the region in which to create the resource. If omitted, the provider-level region will be used. Changing this parameter will create a new resource.
    retryMaxTimes Number
    Specifies the maximum number of retry times.

    Import

    The rocketmq consumer group can be imported using the rocketMQ instance ID and group name separated by a slash, e.g.

    $ pulumi import flexibleengine:index/dmsRocketmqConsumerGroup:DmsRocketmqConsumerGroup test 8d3c7938-dc47-4937-a30f-c80de381c5e3/group_1

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine