aws-native.cognito.getUserPoolGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getUserPoolGroup

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.

TypeScript
Python
Go
C#
Java
YAML

function getUserPoolGroup(args: GetUserPoolGroupArgs, opts?: InvokeOptions): Promise<GetUserPoolGroupResult>
function getUserPoolGroupOutput(args: GetUserPoolGroupOutputArgs, opts?: InvokeOptions): Output<GetUserPoolGroupResult>

def get_user_pool_group(group_name: Optional[str] = None,
                        user_pool_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetUserPoolGroupResult
def get_user_pool_group_output(group_name: Optional[pulumi.Input[str]] = None,
                        user_pool_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolGroupResult]

func LookupUserPoolGroup(ctx *Context, args *LookupUserPoolGroupArgs, opts ...InvokeOption) (*LookupUserPoolGroupResult, error)
func LookupUserPoolGroupOutput(ctx *Context, args *LookupUserPoolGroupOutputArgs, opts ...InvokeOption) LookupUserPoolGroupResultOutput

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

public static class GetUserPoolGroup 
{
    public static Task<GetUserPoolGroupResult> InvokeAsync(GetUserPoolGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolGroupResult> Invoke(GetUserPoolGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUserPoolGroupResult> getUserPoolGroup(GetUserPoolGroupArgs args, InvokeOptions options)
public static Output<GetUserPoolGroupResult> getUserPoolGroup(GetUserPoolGroupArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:cognito:getUserPoolGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

GroupName string: A name for the group. This name must be unique in your user pool.
UserPoolId string: The ID of the user pool where you want to create a user group.

GroupName string: A name for the group. This name must be unique in your user pool.
UserPoolId string: The ID of the user pool where you want to create a user group.

groupName String: A name for the group. This name must be unique in your user pool.
userPoolId String: The ID of the user pool where you want to create a user group.

groupName string: A name for the group. This name must be unique in your user pool.
userPoolId string: The ID of the user pool where you want to create a user group.

group_name str: A name for the group. This name must be unique in your user pool.
user_pool_id str: The ID of the user pool where you want to create a user group.

groupName String: A name for the group. This name must be unique in your user pool.
userPoolId String: The ID of the user pool where you want to create a user group.

getUserPoolGroup Result

The following output properties are available:

Description string

A description of the group that you're creating.

Precedence int

A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1 .

RoleArn string

The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a cognito:groups claim that list all the groups that a user is a member of.

Description string

A description of the group that you're creating.

Precedence int