Class 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",
});
}
}
Inherited Members
Namespace: Pulumi.AliCloud.RocketMQ
Assembly: Pulumi.AliCloud.dll
Syntax
public class Group : CustomResource
Constructors
View SourceGroup(String, GroupArgs, CustomResourceOptions)
Create a Group resource with the given unique name, arguments, and options.
Declaration
public Group(string name, GroupArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| GroupArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceGroupId
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 (_).
Declaration
public Output<string> GroupId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
InstanceId
ID of the ONS Instance that owns the groups.
Declaration
public Output<string> InstanceId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ReadEnable
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.
Declaration
public Output<bool?> ReadEnable { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Remark
This attribute is a concise description of group. The length cannot exceed 256.
Declaration
public Output<string> Remark { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, GroupState, CustomResourceOptions)
Get an existing Group resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Group Get(string name, Input<string> id, GroupState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| GroupState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Group |