1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. getUserPoolGroup

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.cognito.getUserPoolGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    Resource Type definition for AWS::Cognito::UserPoolGroup

    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
    UserPoolId string
    GroupName string
    UserPoolId string
    groupName String
    userPoolId String
    groupName string
    userPoolId string
    groupName String
    userPoolId String

    getUserPoolGroup Result

    The following output properties are available:

    description String
    precedence Integer
    roleArn String
    description string
    precedence number
    roleArn string
    description String
    precedence Number
    roleArn String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

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

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi