getUserPools function

Future<GetUserPoolsResult> getUserPools(
  1. GetUserPoolsArgs args, {
  2. InvokeOptions? options,
})

Use this data source to get a list of cognito user pools.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const selected = aws.apigateway.getRestApi({
    name: apiGatewayName,
});
const selectedGetUserPools = aws.cognito.getUserPools({
    name: cognitoUserPoolName,
});
const cognito = new aws.apigateway.Authorizer("cognito", {
    name: "cognito",
    type: "COGNITO_USER_POOLS",
    restApi: selected.then(selected => selected.id),
    providerArns: selectedGetUserPools.then(selectedGetUserPools => selectedGetUserPools.arns),
});
import pulumi
import pulumi_aws as aws

selected = aws.apigateway.get_rest_api(name=api_gateway_name)
selected_get_user_pools = aws.cognito.get_user_pools(name=cognito_user_pool_name)
cognito = aws.apigateway.Authorizer("cognito",
    name="cognito",
    type="COGNITO_USER_POOLS",
    rest_api=selected.id,
    provider_arns=selected_get_user_pools.arns)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var selected = Aws.ApiGateway.GetRestApi.Invoke(new()
    {
        Name = apiGatewayName,
    });

    var selectedGetUserPools = Aws.Cognito.GetUserPools.Invoke(new()
    {
        Name = cognitoUserPoolName,
    });

    var cognito = new Aws.ApiGateway.Authorizer("cognito", new()
    {
        Name = "cognito",
        Type = "COGNITO_USER_POOLS",
        RestApi = selected.Apply(getRestApiResult => getRestApiResult.Id),
        ProviderArns = selectedGetUserPools.Apply(getUserPoolsResult => getUserPoolsResult.Arns),
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		selected, err := apigateway.LookupRestApi(ctx, &apigateway.LookupRestApiArgs{
			Name: apiGatewayName,
		}, nil)
		if err != nil {
			return err
		}
		selectedGetUserPools, err := cognito.GetUserPools(ctx, &cognito.GetUserPoolsArgs{
			Name: cognitoUserPoolName,
		}, nil)
		if err != nil {
			return err
		}
		_, err = apigateway.NewAuthorizer(ctx, "cognito", &apigateway.AuthorizerArgs{
			Name:         pulumi.String("cognito"),
			Type:         pulumi.String("COGNITO_USER_POOLS"),
			RestApi:      pulumi.String(selected.Id),
			ProviderArns: toPulumiStringArray(selectedGetUserPools.Arns),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
func toPulumiStringArray(arr []string) pulumi.StringArray {
	var pulumiArr pulumi.StringArray
	for _, v := range arr {
		pulumiArr = append(pulumiArr, pulumi.String(v))
	}
	return pulumiArr
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_apigateway_getrestapi" "selected" {
  name = apiGatewayName
}
data "aws_cognito_getuserpools" "selectedGetUserPools" {
  name = cognitoUserPoolName
}

resource "aws_apigateway_authorizer" "cognito" {
  name          = "cognito"
  type          = "COGNITO_USER_POOLS"
  rest_api      = data.aws_apigateway_getrestapi.selected.id
  provider_arns = data.aws_cognito_getuserpools.selectedGetUserPools.arns
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.inputs.GetRestApiArgs;
import com.pulumi.aws.cognito.CognitoFunctions;
import com.pulumi.aws.cognito.inputs.GetUserPoolsArgs;
import com.pulumi.aws.apigateway.Authorizer;
import com.pulumi.aws.apigateway.AuthorizerArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 selected = ApigatewayFunctions.getRestApi(GetRestApiArgs.builder()
            .name(apiGatewayName)
            .build());

        final var selectedGetUserPools = CognitoFunctions.getUserPools(GetUserPoolsArgs.builder()
            .name(cognitoUserPoolName)
            .build());

        var cognito = new Authorizer("cognito", AuthorizerArgs.builder()
            .name("cognito")
            .type("COGNITO_USER_POOLS")
            .restApi(selected.id())
            .providerArns(selectedGetUserPools.arns())
            .build());

    }
}
resources:
  cognito:
    type: aws:apigateway:Authorizer
    properties:
      name: cognito
      type: COGNITO_USER_POOLS
      restApi: ${selected.id}
      providerArns: ${selectedGetUserPools.arns}
variables:
  selected:
    fn::invoke:
      function: aws:apigateway:getRestApi
      arguments:
        name: ${apiGatewayName}
  selectedGetUserPools:
    fn::invoke:
      function: aws:cognito:getUserPools
      arguments:
        name: ${cognitoUserPoolName}

args Arguments passed to this invoke. Arguments for getUserPools. options Invoke options controlling this call.

Implementation

Future<GetUserPoolsResult> getUserPools(
  GetUserPoolsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:cognito/getUserPools:getUserPools',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetUserPoolsResult.fromMap(result);
}