1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. TdmqRocketmqGroup
tencentcloud 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack

tencentcloud.TdmqRocketmqGroup

Explore with Pulumi AI

Provides a resource to create a tdmqRocketmq group

Example Usage

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

const exampleTdmqRocketmqCluster = new tencentcloud.TdmqRocketmqCluster("exampleTdmqRocketmqCluster", {
    clusterName: "tf_example",
    remark: "remark.",
});
const exampleTdmqRocketmqNamespace = new tencentcloud.TdmqRocketmqNamespace("exampleTdmqRocketmqNamespace", {
    clusterId: exampleTdmqRocketmqCluster.clusterId,
    namespaceName: "tf_example",
    remark: "remark.",
});
const exampleTdmqRocketmqGroup = new tencentcloud.TdmqRocketmqGroup("exampleTdmqRocketmqGroup", {
    groupName: "tf_example",
    clusterId: exampleTdmqRocketmqCluster.clusterId,
    namespace: exampleTdmqRocketmqNamespace.namespaceName,
    readEnable: true,
    broadcastEnable: true,
    remark: "remark.",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

example_tdmq_rocketmq_cluster = tencentcloud.TdmqRocketmqCluster("exampleTdmqRocketmqCluster",
    cluster_name="tf_example",
    remark="remark.")
example_tdmq_rocketmq_namespace = tencentcloud.TdmqRocketmqNamespace("exampleTdmqRocketmqNamespace",
    cluster_id=example_tdmq_rocketmq_cluster.cluster_id,
    namespace_name="tf_example",
    remark="remark.")
example_tdmq_rocketmq_group = tencentcloud.TdmqRocketmqGroup("exampleTdmqRocketmqGroup",
    group_name="tf_example",
    cluster_id=example_tdmq_rocketmq_cluster.cluster_id,
    namespace=example_tdmq_rocketmq_namespace.namespace_name,
    read_enable=True,
    broadcast_enable=True,
    remark="remark.")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleTdmqRocketmqCluster, err := tencentcloud.NewTdmqRocketmqCluster(ctx, "exampleTdmqRocketmqCluster", &tencentcloud.TdmqRocketmqClusterArgs{
			ClusterName: pulumi.String("tf_example"),
			Remark:      pulumi.String("remark."),
		})
		if err != nil {
			return err
		}
		exampleTdmqRocketmqNamespace, err := tencentcloud.NewTdmqRocketmqNamespace(ctx, "exampleTdmqRocketmqNamespace", &tencentcloud.TdmqRocketmqNamespaceArgs{
			ClusterId:     exampleTdmqRocketmqCluster.ClusterId,
			NamespaceName: pulumi.String("tf_example"),
			Remark:        pulumi.String("remark."),
		})
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewTdmqRocketmqGroup(ctx, "exampleTdmqRocketmqGroup", &tencentcloud.TdmqRocketmqGroupArgs{
			GroupName:       pulumi.String("tf_example"),
			ClusterId:       exampleTdmqRocketmqCluster.ClusterId,
			Namespace:       exampleTdmqRocketmqNamespace.NamespaceName,
			ReadEnable:      pulumi.Bool(true),
			BroadcastEnable: pulumi.Bool(true),
			Remark:          pulumi.String("remark."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var exampleTdmqRocketmqCluster = new Tencentcloud.TdmqRocketmqCluster("exampleTdmqRocketmqCluster", new()
    {
        ClusterName = "tf_example",
        Remark = "remark.",
    });

    var exampleTdmqRocketmqNamespace = new Tencentcloud.TdmqRocketmqNamespace("exampleTdmqRocketmqNamespace", new()
    {
        ClusterId = exampleTdmqRocketmqCluster.ClusterId,
        NamespaceName = "tf_example",
        Remark = "remark.",
    });

    var exampleTdmqRocketmqGroup = new Tencentcloud.TdmqRocketmqGroup("exampleTdmqRocketmqGroup", new()
    {
        GroupName = "tf_example",
        ClusterId = exampleTdmqRocketmqCluster.ClusterId,
        Namespace = exampleTdmqRocketmqNamespace.NamespaceName,
        ReadEnable = true,
        BroadcastEnable = true,
        Remark = "remark.",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TdmqRocketmqCluster;
import com.pulumi.tencentcloud.TdmqRocketmqClusterArgs;
import com.pulumi.tencentcloud.TdmqRocketmqNamespace;
import com.pulumi.tencentcloud.TdmqRocketmqNamespaceArgs;
import com.pulumi.tencentcloud.TdmqRocketmqGroup;
import com.pulumi.tencentcloud.TdmqRocketmqGroupArgs;
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 exampleTdmqRocketmqCluster = new TdmqRocketmqCluster("exampleTdmqRocketmqCluster", TdmqRocketmqClusterArgs.builder()
            .clusterName("tf_example")
            .remark("remark.")
            .build());

        var exampleTdmqRocketmqNamespace = new TdmqRocketmqNamespace("exampleTdmqRocketmqNamespace", TdmqRocketmqNamespaceArgs.builder()
            .clusterId(exampleTdmqRocketmqCluster.clusterId())
            .namespaceName("tf_example")
            .remark("remark.")
            .build());

        var exampleTdmqRocketmqGroup = new TdmqRocketmqGroup("exampleTdmqRocketmqGroup", TdmqRocketmqGroupArgs.builder()
            .groupName("tf_example")
            .clusterId(exampleTdmqRocketmqCluster.clusterId())
            .namespace(exampleTdmqRocketmqNamespace.namespaceName())
            .readEnable(true)
            .broadcastEnable(true)
            .remark("remark.")
            .build());

    }
}
Copy
resources:
  exampleTdmqRocketmqCluster:
    type: tencentcloud:TdmqRocketmqCluster
    properties:
      clusterName: tf_example
      remark: remark.
  exampleTdmqRocketmqNamespace:
    type: tencentcloud:TdmqRocketmqNamespace
    properties:
      clusterId: ${exampleTdmqRocketmqCluster.clusterId}
      namespaceName: tf_example
      remark: remark.
  exampleTdmqRocketmqGroup:
    type: tencentcloud:TdmqRocketmqGroup
    properties:
      groupName: tf_example
      clusterId: ${exampleTdmqRocketmqCluster.clusterId}
      namespace: ${exampleTdmqRocketmqNamespace.namespaceName}
      readEnable: true
      broadcastEnable: true
      remark: remark.
Copy

Create TdmqRocketmqGroup Resource

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

Constructor syntax

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

@overload
def TdmqRocketmqGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      broadcast_enable: Optional[bool] = None,
                      cluster_id: Optional[str] = None,
                      group_name: Optional[str] = None,
                      namespace: Optional[str] = None,
                      read_enable: Optional[bool] = None,
                      remark: Optional[str] = None,
                      tdmq_rocketmq_group_id: Optional[str] = None)
func NewTdmqRocketmqGroup(ctx *Context, name string, args TdmqRocketmqGroupArgs, opts ...ResourceOption) (*TdmqRocketmqGroup, error)
public TdmqRocketmqGroup(string name, TdmqRocketmqGroupArgs args, CustomResourceOptions? opts = null)
public TdmqRocketmqGroup(String name, TdmqRocketmqGroupArgs args)
public TdmqRocketmqGroup(String name, TdmqRocketmqGroupArgs args, CustomResourceOptions options)
type: tencentcloud:TdmqRocketmqGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TdmqRocketmqGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TdmqRocketmqGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TdmqRocketmqGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TdmqRocketmqGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TdmqRocketmqGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

BroadcastEnable This property is required. bool
Whether to enable broadcast consumption.
ClusterId This property is required. string
Cluster ID.
GroupName This property is required. string
Group name (8-64 characters).
Namespace This property is required. string
Namespace. Currently, only one namespace is supported.
ReadEnable This property is required. bool
Whether to enable consumption.
Remark string
Remarks (up to 128 characters).
TdmqRocketmqGroupId string
ID of the resource.
BroadcastEnable This property is required. bool
Whether to enable broadcast consumption.
ClusterId This property is required. string
Cluster ID.
GroupName This property is required. string
Group name (8-64 characters).
Namespace This property is required. string
Namespace. Currently, only one namespace is supported.
ReadEnable This property is required. bool
Whether to enable consumption.
Remark string
Remarks (up to 128 characters).
TdmqRocketmqGroupId string
ID of the resource.
broadcastEnable This property is required. Boolean
Whether to enable broadcast consumption.
clusterId This property is required. String
Cluster ID.
groupName This property is required. String
Group name (8-64 characters).
namespace This property is required. String
Namespace. Currently, only one namespace is supported.
readEnable This property is required. Boolean
Whether to enable consumption.
remark String
Remarks (up to 128 characters).
tdmqRocketmqGroupId String
ID of the resource.
broadcastEnable This property is required. boolean
Whether to enable broadcast consumption.
clusterId This property is required. string
Cluster ID.
groupName This property is required. string
Group name (8-64 characters).
namespace This property is required. string
Namespace. Currently, only one namespace is supported.
readEnable This property is required. boolean
Whether to enable consumption.
remark string
Remarks (up to 128 characters).
tdmqRocketmqGroupId string
ID of the resource.
broadcast_enable This property is required. bool
Whether to enable broadcast consumption.
cluster_id This property is required. str
Cluster ID.
group_name This property is required. str
Group name (8-64 characters).
namespace This property is required. str
Namespace. Currently, only one namespace is supported.
read_enable This property is required. bool
Whether to enable consumption.
remark str
Remarks (up to 128 characters).
tdmq_rocketmq_group_id str
ID of the resource.
broadcastEnable This property is required. Boolean
Whether to enable broadcast consumption.
clusterId This property is required. String
Cluster ID.
groupName This property is required. String
Group name (8-64 characters).
namespace This property is required. String
Namespace. Currently, only one namespace is supported.
readEnable This property is required. Boolean
Whether to enable consumption.
remark String
Remarks (up to 128 characters).
tdmqRocketmqGroupId String
ID of the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the TdmqRocketmqGroup resource produces the following output properties:

ClientProtocol string
Client protocol.
ConsumerNum double
The number of online consumers.
ConsumerType string
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
ConsumptionMode double
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
CreateTime double
Creation time in milliseconds.
Id string
The provider-assigned unique ID for this managed resource.
RetryPartitionNum double
The number of partitions in a retry topic.
TotalAccumulative double
The total number of heaped messages.
Tps double
Consumption TPS.
UpdateTime double
Modification time in milliseconds.
ClientProtocol string
Client protocol.
ConsumerNum float64
The number of online consumers.
ConsumerType string
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
ConsumptionMode float64
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
CreateTime float64
Creation time in milliseconds.
Id string
The provider-assigned unique ID for this managed resource.
RetryPartitionNum float64
The number of partitions in a retry topic.
TotalAccumulative float64
The total number of heaped messages.
Tps float64
Consumption TPS.
UpdateTime float64
Modification time in milliseconds.
clientProtocol String
Client protocol.
consumerNum Double
The number of online consumers.
consumerType String
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumptionMode Double
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
createTime Double
Creation time in milliseconds.
id String
The provider-assigned unique ID for this managed resource.
retryPartitionNum Double
The number of partitions in a retry topic.
totalAccumulative Double
The total number of heaped messages.
tps Double
Consumption TPS.
updateTime Double
Modification time in milliseconds.
clientProtocol string
Client protocol.
consumerNum number
The number of online consumers.
consumerType string
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumptionMode number
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
createTime number
Creation time in milliseconds.
id string
The provider-assigned unique ID for this managed resource.
retryPartitionNum number
The number of partitions in a retry topic.
totalAccumulative number
The total number of heaped messages.
tps number
Consumption TPS.
updateTime number
Modification time in milliseconds.
client_protocol str
Client protocol.
consumer_num float
The number of online consumers.
consumer_type str
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumption_mode float
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
create_time float
Creation time in milliseconds.
id str
The provider-assigned unique ID for this managed resource.
retry_partition_num float
The number of partitions in a retry topic.
total_accumulative float
The total number of heaped messages.
tps float
Consumption TPS.
update_time float
Modification time in milliseconds.
clientProtocol String
Client protocol.
consumerNum Number
The number of online consumers.
consumerType String
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumptionMode Number
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
createTime Number
Creation time in milliseconds.
id String
The provider-assigned unique ID for this managed resource.
retryPartitionNum Number
The number of partitions in a retry topic.
totalAccumulative Number
The total number of heaped messages.
tps Number
Consumption TPS.
updateTime Number
Modification time in milliseconds.

Look up Existing TdmqRocketmqGroup Resource

Get an existing TdmqRocketmqGroup 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?: TdmqRocketmqGroupState, opts?: CustomResourceOptions): TdmqRocketmqGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        broadcast_enable: Optional[bool] = None,
        client_protocol: Optional[str] = None,
        cluster_id: Optional[str] = None,
        consumer_num: Optional[float] = None,
        consumer_type: Optional[str] = None,
        consumption_mode: Optional[float] = None,
        create_time: Optional[float] = None,
        group_name: Optional[str] = None,
        namespace: Optional[str] = None,
        read_enable: Optional[bool] = None,
        remark: Optional[str] = None,
        retry_partition_num: Optional[float] = None,
        tdmq_rocketmq_group_id: Optional[str] = None,
        total_accumulative: Optional[float] = None,
        tps: Optional[float] = None,
        update_time: Optional[float] = None) -> TdmqRocketmqGroup
func GetTdmqRocketmqGroup(ctx *Context, name string, id IDInput, state *TdmqRocketmqGroupState, opts ...ResourceOption) (*TdmqRocketmqGroup, error)
public static TdmqRocketmqGroup Get(string name, Input<string> id, TdmqRocketmqGroupState? state, CustomResourceOptions? opts = null)
public static TdmqRocketmqGroup get(String name, Output<String> id, TdmqRocketmqGroupState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:TdmqRocketmqGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BroadcastEnable bool
Whether to enable broadcast consumption.
ClientProtocol string
Client protocol.
ClusterId string
Cluster ID.
ConsumerNum double
The number of online consumers.
ConsumerType string
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
ConsumptionMode double
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
CreateTime double
Creation time in milliseconds.
GroupName string
Group name (8-64 characters).
Namespace string
Namespace. Currently, only one namespace is supported.
ReadEnable bool
Whether to enable consumption.
Remark string
Remarks (up to 128 characters).
RetryPartitionNum double
The number of partitions in a retry topic.
TdmqRocketmqGroupId string
ID of the resource.
TotalAccumulative double
The total number of heaped messages.
Tps double
Consumption TPS.
UpdateTime double
Modification time in milliseconds.
BroadcastEnable bool
Whether to enable broadcast consumption.
ClientProtocol string
Client protocol.
ClusterId string
Cluster ID.
ConsumerNum float64
The number of online consumers.
ConsumerType string
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
ConsumptionMode float64
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
CreateTime float64
Creation time in milliseconds.
GroupName string
Group name (8-64 characters).
Namespace string
Namespace. Currently, only one namespace is supported.
ReadEnable bool
Whether to enable consumption.
Remark string
Remarks (up to 128 characters).
RetryPartitionNum float64
The number of partitions in a retry topic.
TdmqRocketmqGroupId string
ID of the resource.
TotalAccumulative float64
The total number of heaped messages.
Tps float64
Consumption TPS.
UpdateTime float64
Modification time in milliseconds.
broadcastEnable Boolean
Whether to enable broadcast consumption.
clientProtocol String
Client protocol.
clusterId String
Cluster ID.
consumerNum Double
The number of online consumers.
consumerType String
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumptionMode Double
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
createTime Double
Creation time in milliseconds.
groupName String
Group name (8-64 characters).
namespace String
Namespace. Currently, only one namespace is supported.
readEnable Boolean
Whether to enable consumption.
remark String
Remarks (up to 128 characters).
retryPartitionNum Double
The number of partitions in a retry topic.
tdmqRocketmqGroupId String
ID of the resource.
totalAccumulative Double
The total number of heaped messages.
tps Double
Consumption TPS.
updateTime Double
Modification time in milliseconds.
broadcastEnable boolean
Whether to enable broadcast consumption.
clientProtocol string
Client protocol.
clusterId string
Cluster ID.
consumerNum number
The number of online consumers.
consumerType string
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumptionMode number
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
createTime number
Creation time in milliseconds.
groupName string
Group name (8-64 characters).
namespace string
Namespace. Currently, only one namespace is supported.
readEnable boolean
Whether to enable consumption.
remark string
Remarks (up to 128 characters).
retryPartitionNum number
The number of partitions in a retry topic.
tdmqRocketmqGroupId string
ID of the resource.
totalAccumulative number
The total number of heaped messages.
tps number
Consumption TPS.
updateTime number
Modification time in milliseconds.
broadcast_enable bool
Whether to enable broadcast consumption.
client_protocol str
Client protocol.
cluster_id str
Cluster ID.
consumer_num float
The number of online consumers.
consumer_type str
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumption_mode float
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
create_time float
Creation time in milliseconds.
group_name str
Group name (8-64 characters).
namespace str
Namespace. Currently, only one namespace is supported.
read_enable bool
Whether to enable consumption.
remark str
Remarks (up to 128 characters).
retry_partition_num float
The number of partitions in a retry topic.
tdmq_rocketmq_group_id str
ID of the resource.
total_accumulative float
The total number of heaped messages.
tps float
Consumption TPS.
update_time float
Modification time in milliseconds.
broadcastEnable Boolean
Whether to enable broadcast consumption.
clientProtocol String
Client protocol.
clusterId String
Cluster ID.
consumerNum Number
The number of online consumers.
consumerType String
Consumer type. Enumerated values: ACTIVELY or PASSIVELY.
consumptionMode Number
0: Cluster consumption mode; 1: Broadcast consumption mode; -1: Unknown.
createTime Number
Creation time in milliseconds.
groupName String
Group name (8-64 characters).
namespace String
Namespace. Currently, only one namespace is supported.
readEnable Boolean
Whether to enable consumption.
remark String
Remarks (up to 128 characters).
retryPartitionNum Number
The number of partitions in a retry topic.
tdmqRocketmqGroupId String
ID of the resource.
totalAccumulative Number
The total number of heaped messages.
tps Number
Consumption TPS.
updateTime Number
Modification time in milliseconds.

Import

tdmqRocketmq group can be imported using the id, e.g.

$ pulumi import tencentcloud:index/tdmqRocketmqGroup:TdmqRocketmqGroup group group_id
Copy

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

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.