aws-native.cognito.getUserPoolGroup

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

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.

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)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

GroupName string: The name of the group. Must be unique.
UserPoolId string: The user pool ID for the user pool.

GroupName string: The name of the group. Must be unique.
UserPoolId string: The user pool ID for the user pool.

groupName String: The name of the group. Must be unique.
userPoolId String: The user pool ID for the user pool.

groupName string: The name of the group. Must be unique.
userPoolId string: The user pool ID for the user pool.

group_name str: The name of the group. Must be unique.
user_pool_id str: The user pool ID for the user pool.

groupName String: The name of the group. Must be unique.
userPoolId String: The user pool ID for the user pool.

getUserPoolGroup Result

The following output properties are available:

Description string

A string containing the description of the group.

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