get User Group
Data source for managing an AWS Cognito IDP (Identity Provider) User Group.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.cognito.getUserGroup({
userPoolId: "us-west-2_aaaaaaaaa",
name: "example",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.cognito.get_user_group(user_pool_id="us-west-2_aaaaaaaaa",
name="example")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Cognito.GetUserGroup.Invoke(new()
{
UserPoolId = "us-west-2_aaaaaaaaa",
Name = "example",
});
});
Content copied to clipboard
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.LookupUserGroup(ctx, &cognito.LookupUserGroupArgs{
UserPoolId: "us-west-2_aaaaaaaaa",
Name: "example",
}, nil)
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
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.GetUserGroupArgs;
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.getUserGroup(GetUserGroupArgs.builder()
.userPoolId("us-west-2_aaaaaaaaa")
.name("example")
.build());
}
}
Content copied to clipboard
variables:
example:
fn::invoke:
function: aws:cognito:getUserGroup
arguments:
userPoolId: us-west-2_aaaaaaaaa
name: example
Content copied to clipboard
Return
A collection of values returned by getUserGroup.
Parameters
argument
A collection of arguments for invoking getUserGroup.
Return
A collection of values returned by getUserGroup.
Parameters
name
Name of the user group.
user Pool Id
User pool the client belongs to.
See also
suspend fun getUserGroup(argument: suspend GetUserGroupPlainArgsBuilder.() -> Unit): GetUserGroupResult
Return
A collection of values returned by getUserGroup.
Parameters
argument
Builder for com.pulumi.aws.cognito.kotlin.inputs.GetUserGroupPlainArgs.