1. Docs
  2. Reference
  3. API
  4. AliCloud
  5. ram
  6. GetGroups

GetGroups

This data source provides a list of RAM Groups in an Alibaba Cloud account according to the specified filters.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var groupsDs = Output.Create(AliCloud.Ram.GetGroups.InvokeAsync(new AliCloud.Ram.GetGroupsArgs
        {
            NameRegex = "^group[0-9]*",
            OutputFile = "groups.txt",
            UserName = "user1",
        }));
        this.FirstGroupName = groupsDs.Apply(groupsDs => groupsDs.Groups[0].Name);
    }

    [Output("firstGroupName")]
    public Output<string> FirstGroupName { get; set; }
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

groups_ds = alicloud.ram.get_groups(name_regex="^group[0-9]*",
    output_file="groups.txt",
    user_name="user1")
pulumi.export("firstGroupName", groups_ds.groups[0]["name"])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const groupsDs = pulumi.output(alicloud.ram.getGroups({
    nameRegex: "^group[0-9]*",
    outputFile: "groups.txt",
    userName: "user1",
}, { async: true }));

export const firstGroupName = groupsDs.groups[0].name;

Using GetGroups

function getGroups(args: GetGroupsArgs, opts?: InvokeOptions): Promise<GetGroupsResult>
function  get_groups(name_regex=None, output_file=None, policy_name=None, policy_type=None, user_name=None, opts=None)
func GetGroups(ctx *Context, args *GetGroupsArgs, opts ...InvokeOption) (*GetGroupsResult, error)
public static class GetGroups {
    public static Task<GetGroupsResult> InvokeAsync(GetGroupsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

NameRegex string

A regex string to filter the returned groups by their names.

OutputFile string
PolicyName string

Filter the results by a specific policy name. If you set this parameter without setting policy_type, it will be automatically set to System.

PolicyType string

Filter the results by a specific policy type. Valid items are Custom and System. If you set this parameter, you must set policy_name as well.

UserName string

Filter the results by a specific the user name.

NameRegex string

A regex string to filter the returned groups by their names.

OutputFile string
PolicyName string

Filter the results by a specific policy name. If you set this parameter without setting policy_type, it will be automatically set to System.

PolicyType string

Filter the results by a specific policy type. Valid items are Custom and System. If you set this parameter, you must set policy_name as well.

UserName string

Filter the results by a specific the user name.

nameRegex string

A regex string to filter the returned groups by their names.

outputFile string
policyName string

Filter the results by a specific policy name. If you set this parameter without setting policy_type, it will be automatically set to System.

policyType string

Filter the results by a specific policy type. Valid items are Custom and System. If you set this parameter, you must set policy_name as well.

userName string

Filter the results by a specific the user name.

name_regex str

A regex string to filter the returned groups by their names.

output_file str
policy_name str

Filter the results by a specific policy name. If you set this parameter without setting policy_type, it will be automatically set to System.

policy_type str

Filter the results by a specific policy type. Valid items are Custom and System. If you set this parameter, you must set policy_name as well.

user_name str

Filter the results by a specific the user name.

GetGroups Result

The following output properties are available:

Groups List<Pulumi.AliCloud.Ram.Outputs.GetGroupsGroup>

A list of groups. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Names List<string>

A list of ram group names.

NameRegex string
OutputFile string
PolicyName string
PolicyType string
UserName string
Groups []GetGroupsGroup

A list of groups. Each element contains the following attributes:

Id string

The provider-assigned unique ID for this managed resource.

Names []string

A list of ram group names.

NameRegex string
OutputFile string
PolicyName string
PolicyType string
UserName string
groups GetGroupsGroup[]

A list of groups. Each element contains the following attributes:

id string

The provider-assigned unique ID for this managed resource.

names string[]

A list of ram group names.

nameRegex string
outputFile string
policyName string
policyType string
userName string
groups List[GetGroupsGroup]

A list of groups. Each element contains the following attributes:

id str

The provider-assigned unique ID for this managed resource.

names List[str]

A list of ram group names.

name_regex str
output_file str
policy_name str
policy_type str
user_name str

Supporting Types

GetGroupsGroup

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Comments string

Comments of the group.

Name string

Name of the group.

Comments string

Comments of the group.

Name string

Name of the group.

comments string

Comments of the group.

name string

Name of the group.

comments str

Comments of the group.

name str

Name of the group.

Package Details

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