getUserGroups

Data source for managing AWS Cognito IDP (Identity Provider) User Groups.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.cognito.getUserGroups({
userPoolId: "us-west-2_aaaaaaaaa",
});
import pulumi
import pulumi_aws as aws
example = aws.cognito.get_user_groups(user_pool_id="us-west-2_aaaaaaaaa")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Cognito.GetUserGroups.Invoke(new()
{
UserPoolId = "us-west-2_aaaaaaaaa",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cognito.GetUserGroups(ctx, &cognito.GetUserGroupsArgs{
UserPoolId: "us-west-2_aaaaaaaaa",
}, nil)
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.aws.cognito.CognitoFunctions;
import com.pulumi.aws.cognito.inputs.GetUserGroupsArgs;
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 example = CognitoFunctions.getUserGroups(GetUserGroupsArgs.builder()
.userPoolId("us-west-2_aaaaaaaaa")
.build());
}
}
variables:
example:
fn::invoke:
function: aws:cognito:getUserGroups
arguments:
userPoolId: us-west-2_aaaaaaaaa

Return

A collection of values returned by getUserGroups.

Parameters

argument

A collection of arguments for invoking getUserGroups.


suspend fun getUserGroups(userPoolId: String): GetUserGroupsResult

Return

A collection of values returned by getUserGroups.

Parameters

userPoolId

User pool the client belongs to.

See also


Return

A collection of values returned by getUserGroups.

Parameters

argument

Builder for com.pulumi.aws.cognito.kotlin.inputs.GetUserGroupsPlainArgs.

See also