alicloud.rocketmq.getGroups

Explore with Pulumi AI

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

Example Usage

variable "name" {
  default = "onsInstanceName"
}

variable "group_name" {
  default = "GID-onsGroupDatasourceName"
}

resource "alicloud_ons_instance" "default" {
  instance_name = var.name
  remark        = "default_ons_instance_remark"
}

resource "alicloud_ons_group" "default" {
  group_name  = var.group_name
  instance_id = alicloud_ons_instance.default.id
  remark      = "dafault_ons_group_remark"
}

data "alicloud_ons_groups" "groups_ds" {
  instance_id = alicloud_ons_group.default.instance_id
  name_regex  = var.group_id
  output_file = "groups.txt"
}

output "first_group_name" {
  value = data.alicloud_ons_groups.groups_ds.groups.0.group_name
}

Using getGroups

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function getGroupsOutput(args: GetGroupsOutputArgs, opts?: InvokeOptions): Output<GetGroupsResult>

def get_groups(group_id_regex: Optional[str] = None,
               group_type: Optional[str] = None,
               ids: Optional[Sequence[str]] = None,
               instance_id: Optional[str] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               tags: Optional[Mapping[str, Any]] = None,
               opts: Optional[InvokeOptions] = None) -> GetGroupsResult
def get_groups_output(group_id_regex: Optional[pulumi.Input[str]] = None,
               group_type: Optional[pulumi.Input[str]] = None,
               ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               instance_id: Optional[pulumi.Input[str]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetGroupsResult]

func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
func GetGroupsOutput(ctx *Context, args *GetGroupsOutputArgs, opts ...InvokeOption) GetGroupsResultOutput

> Note: This function is named GetGroups in the Go SDK.

public static class GetGroups 
{
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupsResult> Invoke(GetGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGroupsResult> getGroups(GetGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:rocketmq/getGroups:getGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: ID of the ONS Instance that owns the groups.
GroupIdRegex string: A regex string to filter results by the group name.
GroupType string: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
Ids List<string>: A list of group names.
NameRegex string
OutputFile string: File name where to save data source results (after running pulumi preview).
Tags Dictionary<string, object>: A map of tags assigned to the Ons instance.

InstanceId string: ID of the ONS Instance that owns the groups.
GroupIdRegex string: A regex string to filter results by the group name.
GroupType string: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
Ids []string: A list of group names.
NameRegex string
OutputFile string: File name where to save data source results (after running pulumi preview).
Tags map[string]interface{}: A map of tags assigned to the Ons instance.

instanceId String: ID of the ONS Instance that owns the groups.
groupIdRegex String: A regex string to filter results by the group name.
groupType String: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
ids List<String>: A list of group names.
nameRegex String
outputFile String: File name where to save data source results (after running pulumi preview).
tags Map<String,Object>: A map of tags assigned to the Ons instance.

instanceId string: ID of the ONS Instance that owns the groups.
groupIdRegex string: A regex string to filter results by the group name.
groupType string: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
ids string[]: A list of group names.
nameRegex string
outputFile string: File name where to save data source results (after running pulumi preview).
tags {[key: string]: any}: A map of tags assigned to the Ons instance.

instance_id str: ID of the ONS Instance that owns the groups.
group_id_regex str: A regex string to filter results by the group name.
group_type str: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
ids Sequence[str]: A list of group names.
name_regex str
output_file str: File name where to save data source results (after running pulumi preview).
tags Mapping[str, Any]: A map of tags assigned to the Ons instance.

instanceId String: ID of the ONS Instance that owns the groups.
groupIdRegex String: A regex string to filter results by the group name.
groupType String: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
ids List<String>: A list of group names.
nameRegex String
outputFile String: File name where to save data source results (after running pulumi preview).
tags Map<Any>: A map of tags assigned to the Ons instance.

getGroups Result

The following output properties are available:

Groups List<Pulumi.AliCloud.RocketMQ.Outputs.GetGroupsGroup>: A list of groups. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: A list of group names.
InstanceId string
Names List<string>
GroupIdRegex string
GroupType string: Specify the protocol applicable to the created Group ID.
NameRegex string
OutputFile string
Tags Dictionary<string, object>: A map of tags assigned to the Ons group.

Groups []GetGroupsGroup: A list of groups. Each element contains the following attributes:
Id string: The provider-assigned unique ID for this managed resource.
Ids []string: A list of group names.
InstanceId string
Names []string
GroupIdRegex string
GroupType string: Specify the protocol applicable to the created Group ID.
NameRegex string
OutputFile string
Tags map[string]interface{}: A map of tags assigned to the Ons group.

groups List<GetGroupsGroup>: A list of groups. Each element contains the following attributes:
id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of group names.
instanceId String
names List<String>
groupIdRegex String
groupType String: Specify the protocol applicable to the created Group ID.
nameRegex String
outputFile String
tags Map<String,Object>: A map of tags assigned to the Ons group.

groups GetGroupsGroup[]: A list of groups. Each element contains the following attributes:
id string: The provider-assigned unique ID for this managed resource.
ids string[]: A list of group names.
instanceId string
names string[]
groupIdRegex string
groupType string: Specify the protocol applicable to the created Group ID.
nameRegex string
outputFile string
tags {[key: string]: any}: A map of tags assigned to the Ons group.

groups Sequence[GetGroupsGroup]: A list of groups. Each element contains the following attributes:
id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: A list of group names.
instance_id str
names Sequence[str]
group_id_regex str
group_type str: Specify the protocol applicable to the created Group ID.
name_regex str
output_file str
tags Mapping[str, Any]: A map of tags assigned to the Ons group.

groups List<Property Map>: A list of groups. Each element contains the following attributes:
id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of group names.
instanceId String
names List<String>
groupIdRegex String
groupType String: Specify the protocol applicable to the created Group ID.
nameRegex String
outputFile String
tags Map<Any>: A map of tags assigned to the Ons group.

Supporting Types

GetGroupsGroup

GroupName string: The name of the group.
GroupType string: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
Id string: The name of the group.
IndependentNaming bool: Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.
InstanceId string: ID of the ONS Instance that owns the groups.
Owner string: The ID of the group owner, which is the Alibaba Cloud UID.
Remark string: Remark of the group.
Tags Dictionary<string, object>: A map of tags assigned to the Ons instance.

GroupName string: The name of the group.
GroupType string: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
Id string: The name of the group.
IndependentNaming bool: Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.
InstanceId string: ID of the ONS Instance that owns the groups.
Owner string: The ID of the group owner, which is the Alibaba Cloud UID.
Remark string: Remark of the group.
Tags map[string]interface{}: A map of tags assigned to the Ons instance.

groupName String: The name of the group.
groupType String: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
id String: The name of the group.
independentNaming Boolean: Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.
instanceId String: ID of the ONS Instance that owns the groups.
owner String: The ID of the group owner, which is the Alibaba Cloud UID.
remark String: Remark of the group.
tags Map<String,Object>: A map of tags assigned to the Ons instance.

groupName string: The name of the group.
groupType string: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
id string: The name of the group.
independentNaming boolean: Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.
instanceId string: ID of the ONS Instance that owns the groups.
owner string: The ID of the group owner, which is the Alibaba Cloud UID.
remark string: Remark of the group.
tags {[key: string]: any}: A map of tags assigned to the Ons instance.

group_name str: The name of the group.
group_type str: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
id str: The name of the group.
independent_naming bool: Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.
instance_id str: ID of the ONS Instance that owns the groups.
owner str: The ID of the group owner, which is the Alibaba Cloud UID.
remark str: Remark of the group.
tags Mapping[str, Any]: A map of tags assigned to the Ons instance.

groupName String: The name of the group.
groupType String: Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp.
id String: The name of the group.
independentNaming Boolean: Indicates whether namespaces are available. Read Fields in SubscribeInfoDo for further details.
instanceId String: ID of the ONS Instance that owns the groups.
owner String: The ID of the group owner, which is the Alibaba Cloud UID.
remark String: Remark of the group.
tags Map<Any>: A map of tags assigned to the Ons instance.

Package Details

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

Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-alicloud

alicloud.rocketmq.getGroups

On this page

On this page

Example Usage

Using getGroups

getGroups Result

Supporting Types

GetGroupsGroup

Package Details

On this page

On this page