Group

class Group : KotlinCustomResource

Provides an ONS group resource. For more information about how to use it, see RocketMQ Group Management API.

NOTE: Available in 1.53.0+

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";
const config = new pulumi.Config();
const name = config.get("name") || "GID-tf-example";
const groupName = config.get("groupName") || "GID-tf-example";
const _default = new random.index.Integer("default", {
min: 10000,
max: 99999,
});
const defaultInstance = new alicloud.rocketmq.Instance("default", {instanceName: `${name}-${_default.result}`});
const defaultGroup = new alicloud.rocketmq.Group("default", {
groupName: groupName,
instanceId: defaultInstance.id,
remark: "dafault_ons_group_remark",
});
import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "GID-tf-example"
group_name = config.get("groupName")
if group_name is None:
group_name = "GID-tf-example"
default = random.index.Integer("default",
min=10000,
max=99999)
default_instance = alicloud.rocketmq.Instance("default", instance_name=f"{name}-{default['result']}")
default_group = alicloud.rocketmq.Group("default",
group_name=group_name,
instance_id=default_instance.id,
remark="dafault_ons_group_remark")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "GID-tf-example";
var groupName = config.Get("groupName") ?? "GID-tf-example";
var @default = new Random.Index.Integer("default", new()
{
Min = 10000,
Max = 99999,
});
var defaultInstance = new AliCloud.RocketMQ.Instance("default", new()
{
InstanceName = $"{name}-{@default.Result}",
});
var defaultGroup = new AliCloud.RocketMQ.Group("default", new()
{
GroupName = groupName,
InstanceId = defaultInstance.Id,
Remark = "dafault_ons_group_remark",
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rocketmq"
"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"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, "")
name := "GID-tf-example"
if param := cfg.Get("name"); param != "" {
name = param
}
groupName := "GID-tf-example"
if param := cfg.Get("groupName"); param != "" {
groupName = param
}
_default, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
Min: 10000,
Max: 99999,
})
if err != nil {
return err
}
defaultInstance, err := rocketmq.NewInstance(ctx, "default", &rocketmq.InstanceArgs{
InstanceName: pulumi.Sprintf("%v-%v", name, _default.Result),
})
if err != nil {
return err
}
_, err = rocketmq.NewGroup(ctx, "default", &rocketmq.GroupArgs{
GroupName: pulumi.String(groupName),
InstanceId: defaultInstance.ID(),
Remark: pulumi.String("dafault_ons_group_remark"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.rocketmq.Instance;
import com.pulumi.alicloud.rocketmq.InstanceArgs;
import com.pulumi.alicloud.rocketmq.Group;
import com.pulumi.alicloud.rocketmq.GroupArgs;
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 name = config.get("name").orElse("GID-tf-example");
final var groupName = config.get("groupName").orElse("GID-tf-example");
var default_ = new Integer("default", IntegerArgs.builder()
.min(10000)
.max(99999)
.build());
var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
.instanceName(String.format("%s-%s", name,default_.result()))
.build());
var defaultGroup = new Group("defaultGroup", GroupArgs.builder()
.groupName(groupName)
.instanceId(defaultInstance.id())
.remark("dafault_ons_group_remark")
.build());
}
}
configuration:
name:
type: string
default: GID-tf-example
groupName:
type: string
default: GID-tf-example
resources:
default:
type: random:integer
properties:
min: 10000
max: 99999
defaultInstance:
type: alicloud:rocketmq:Instance
name: default
properties:
instanceName: ${name}-${default.result}
defaultGroup:
type: alicloud:rocketmq:Group
name: default
properties:
groupName: ${groupName}
instanceId: ${defaultInstance.id}
remark: dafault_ons_group_remark

Import

ONS GROUP can be imported using the id, e.g.

$ pulumi import alicloud:rocketmq/group:Group group MQ_INST_1234567890_Baso1234567:GID-onsGroupDemo

Properties

Link copied to clipboard
val groupId: Output<String>

Replaced by group_name after version 1.98.0.

Link copied to clipboard
val groupName: Output<String>

Name of the group. Two groups on a single instance cannot have the same name. A group_name starts with "GID_" or "GID-", and contains letters, numbers, hyphens (-), and underscores (_).

Link copied to clipboard
val groupType: Output<String>?

Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instanceId: Output<String>

ID of the ONS Instance that owns the groups.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val readEnable: Output<Boolean>?

This attribute is used to set the message reading enabled or disabled. It can only be set after the group is used by the client.

Link copied to clipboard
val remark: Output<String>?

This attribute is a concise description of group. The length cannot exceed 256.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags to assign to the resource.

Link copied to clipboard
val urn: Output<String>