Group

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

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var name = config.Get("name") ?? "onsInstanceName";
        var groupId = config.Get("groupId") ?? "GID-onsGroupDatasourceName";
        var defaultInstance = new AliCloud.RocketMQ.Instance("defaultInstance", new AliCloud.RocketMQ.InstanceArgs
        {
            Remark = "default_ons_instance_remark",
        });
        var defaultGroup = new AliCloud.RocketMQ.Group("defaultGroup", new AliCloud.RocketMQ.GroupArgs
        {
            GroupId = groupId,
            InstanceId = defaultInstance.Id,
            Remark = "dafault_ons_group_remark",
        });
    }

}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "onsInstanceName"
group_id = config.get("groupId")
if group_id is None:
    group_id = "GID-onsGroupDatasourceName"
default_instance = alicloud.rocketmq.Instance("defaultInstance", remark="default_ons_instance_remark")
default_group = alicloud.rocketmq.Group("defaultGroup",
    group_id=group_id,
    instance_id=default_instance.id,
    remark="dafault_ons_group_remark")

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

const config = new pulumi.Config();
const name = config.get("name") || "onsInstanceName";
const groupId = config.get("groupId") || "GID-onsGroupDatasourceName";

const defaultInstance = new alicloud.rocketmq.Instance("default", {
    remark: "default_ons_instance_remark",
});
const defaultGroup = new alicloud.rocketmq.Group("default", {
    groupId: groupId,
    instanceId: defaultInstance.id,
    remark: "dafault_ons_group_remark",
});

Create a Group Resource

new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);

def Group(resource_name, opts=None, group_id=None, instance_id=None, read_enable=None, remark=None, __props__=None);

func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)

public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Group resource accepts the following input properties:

GroupId string: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
InstanceId string: ID of the ONS Instance that owns the groups.
ReadEnable bool: 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.
Remark string: This attribute is a concise description of group. The length cannot exceed 256.

GroupId string: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
InstanceId string: ID of the ONS Instance that owns the groups.
ReadEnable bool: 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.
Remark string: This attribute is a concise description of group. The length cannot exceed 256.

groupId string: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
instanceId string: ID of the ONS Instance that owns the groups.
readEnable 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.
remark string: This attribute is a concise description of group. The length cannot exceed 256.

group_id str: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
instance_id str: ID of the ONS Instance that owns the groups.
read_enable bool: 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.
remark str: This attribute is a concise description of group. The length cannot exceed 256.

Outputs

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

Look up an Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group

static get(resource_name, id, opts=None, group_id=None, instance_id=None, read_enable=None, remark=None, __props__=None);

func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)

public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

GroupId string: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
InstanceId string: ID of the ONS Instance that owns the groups.
ReadEnable bool: 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.
Remark string: This attribute is a concise description of group. The length cannot exceed 256.

GroupId string: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
InstanceId string: ID of the ONS Instance that owns the groups.
ReadEnable bool: 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.
Remark string: This attribute is a concise description of group. The length cannot exceed 256.

groupId string: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
instanceId string: ID of the ONS Instance that owns the groups.
readEnable 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.
remark string: This attribute is a concise description of group. The length cannot exceed 256.

group_id str: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
instance_id str: ID of the ONS Instance that owns the groups.
read_enable bool: 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.
remark str: This attribute is a concise description of group. The length cannot exceed 256.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud