aws.cognito.getIdentityPool

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

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

const example = aws.cognito.getIdentityPool({
    identityPoolName: "test pool",
});

import pulumi
import pulumi_aws as aws

example = aws.cognito.get_identity_pool(identity_pool_name="test pool")

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.LookupIdentityPool(ctx, &cognito.LookupIdentityPoolArgs{
			IdentityPoolName: "test pool",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Cognito.GetIdentityPool.Invoke(new()
    {
        IdentityPoolName = "test pool",
    });

});

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.GetIdentityPoolArgs;
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.getIdentityPool(GetIdentityPoolArgs.builder()
            .identityPoolName("test pool")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:cognito:getIdentityPool
      arguments:
        identityPoolName: test pool

Using getIdentityPool

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 getIdentityPool(args: GetIdentityPoolArgs, opts?: InvokeOptions): Promise<GetIdentityPoolResult>
function getIdentityPoolOutput(args: GetIdentityPoolOutputArgs, opts?: InvokeOptions): Output<GetIdentityPoolResult>

def get_identity_pool(identity_pool_name: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIdentityPoolResult
def get_identity_pool_output(identity_pool_name: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIdentityPoolResult]

func LookupIdentityPool(ctx *Context, args *LookupIdentityPoolArgs, opts ...InvokeOption) (*LookupIdentityPoolResult, error)
func LookupIdentityPoolOutput(ctx *Context, args *LookupIdentityPoolOutputArgs, opts ...InvokeOption) LookupIdentityPoolResultOutput

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

public static class GetIdentityPool 
{
    public static Task<GetIdentityPoolResult> InvokeAsync(GetIdentityPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityPoolResult> Invoke(GetIdentityPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIdentityPoolResult> getIdentityPool(GetIdentityPoolArgs args, InvokeOptions options)
public static Output<GetIdentityPoolResult> getIdentityPool(GetIdentityPoolArgs args, InvokeOptions options)

fn::invoke:
  function: aws:cognito/getIdentityPool:getIdentityPool
  arguments:
    # arguments dictionary

The following arguments are supported:

IdentityPoolName string: The Cognito Identity Pool name.
Tags Dictionary<string, string>: A map of tags to assigned to the Identity Pool.

IdentityPoolName string: The Cognito Identity Pool name.
Tags map[string]string: A map of tags to assigned to the Identity Pool.

identityPoolName String: The Cognito Identity Pool name.
tags Map<String,String>: A map of tags to assigned to the Identity Pool.

identityPoolName string: The Cognito Identity Pool name.
tags {[key: string]: string}: A map of tags to assigned to the Identity Pool.

identity_pool_name str: The Cognito Identity Pool name.
tags Mapping[str, str]: A map of tags to assigned to the Identity Pool.

identityPoolName String: The Cognito Identity Pool name.
tags Map<String>: A map of tags to assigned to the Identity Pool.

getIdentityPool Result

The following output properties are available:

AllowClassicFlow bool: Whether the classic / basic authentication flow is enabled.
AllowUnauthenticatedIdentities bool: Whether the identity pool supports unauthenticated logins or not.
Arn string: ARN of the Pool.
CognitoIdentityProviders List<GetIdentityPoolCognitoIdentityProvider>: An array of Amazon Cognito Identity user pools and their client IDs.
DeveloperProviderName string: The "domain" by which Cognito will refer to your users.
Id string: The provider-assigned unique ID for this managed resource.
IdentityPoolName string
OpenidConnectProviderArns List<string>: Set of OpendID Connect provider ARNs.
SamlProviderArns List<string>: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
SupportedLoginProviders Dictionary<string, string>: Key-Value pairs mapping provider names to provider app IDs.
Tags Dictionary<string, string>: A map of tags to assigned to the Identity Pool.

AllowClassicFlow bool: Whether the classic / basic authentication flow is enabled.
AllowUnauthenticatedIdentities bool: Whether the identity pool supports unauthenticated logins or not.
Arn string: ARN of the Pool.
CognitoIdentityProviders []GetIdentityPoolCognitoIdentityProvider: An array of Amazon Cognito Identity user pools and their client IDs.
DeveloperProviderName string: The "domain" by which Cognito will refer to your users.
Id string: The provider-assigned unique ID for this managed resource.
IdentityPoolName string
OpenidConnectProviderArns []string: Set of OpendID Connect provider ARNs.
SamlProviderArns []string: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
SupportedLoginProviders map[string]string: Key-Value pairs mapping provider names to provider app IDs.
Tags map[string]string: A map of tags to assigned to the Identity Pool.

allowClassicFlow Boolean: Whether the classic / basic authentication flow is enabled.
allowUnauthenticatedIdentities Boolean: Whether the identity pool supports unauthenticated logins or not.
arn String: ARN of the Pool.
cognitoIdentityProviders List<GetIdentityPoolCognitoIdentityProvider>: An array of Amazon Cognito Identity user pools and their client IDs.
developerProviderName String: The "domain" by which Cognito will refer to your users.
id String: The provider-assigned unique ID for this managed resource.
identityPoolName String
openidConnectProviderArns List<String>: Set of OpendID Connect provider ARNs.
samlProviderArns List<String>: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
supportedLoginProviders Map<String,String>: Key-Value pairs mapping provider names to provider app IDs.
tags Map<String,String>: A map of tags to assigned to the Identity Pool.

allowClassicFlow boolean: Whether the classic / basic authentication flow is enabled.
allowUnauthenticatedIdentities boolean: Whether the identity pool supports unauthenticated logins or not.
arn string: ARN of the Pool.
cognitoIdentityProviders GetIdentityPoolCognitoIdentityProvider[]: An array of Amazon Cognito Identity user pools and their client IDs.
developerProviderName string: The "domain" by which Cognito will refer to your users.
id string: The provider-assigned unique ID for this managed resource.
identityPoolName string
openidConnectProviderArns string[]: Set of OpendID Connect provider ARNs.
samlProviderArns string[]: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
supportedLoginProviders {[key: string]: string}: Key-Value pairs mapping provider names to provider app IDs.
tags {[key: string]: string}: A map of tags to assigned to the Identity Pool.

allow_classic_flow bool: Whether the classic / basic authentication flow is enabled.
allow_unauthenticated_identities bool: Whether the identity pool supports unauthenticated logins or not.
arn str: ARN of the Pool.
cognito_identity_providers Sequence[GetIdentityPoolCognitoIdentityProvider]: An array of Amazon Cognito Identity user pools and their client IDs.
developer_provider_name str: The "domain" by which Cognito will refer to your users.
id str: The provider-assigned unique ID for this managed resource.
identity_pool_name str
openid_connect_provider_arns Sequence[str]: Set of OpendID Connect provider ARNs.
saml_provider_arns Sequence[str]: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
supported_login_providers Mapping[str, str]: Key-Value pairs mapping provider names to provider app IDs.
tags Mapping[str, str]: A map of tags to assigned to the Identity Pool.

allowClassicFlow Boolean: Whether the classic / basic authentication flow is enabled.
allowUnauthenticatedIdentities Boolean: Whether the identity pool supports unauthenticated logins or not.
arn String: ARN of the Pool.
cognitoIdentityProviders List<Property Map>: An array of Amazon Cognito Identity user pools and their client IDs.
developerProviderName String: The "domain" by which Cognito will refer to your users.
id String: The provider-assigned unique ID for this managed resource.
identityPoolName String
openidConnectProviderArns List<String>: Set of OpendID Connect provider ARNs.
samlProviderArns List<String>: An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
supportedLoginProviders Map<String>: Key-Value pairs mapping provider names to provider app IDs.
tags Map<String>: A map of tags to assigned to the Identity Pool.