IdentityPool

import type { IdentityPool } from "https://aws-api.deno.dev/v0.3/services/cognitoidentity.ts?docs=full";

An object representing an Amazon Cognito identity pool.

interface IdentityPool {

AllowClassicFlow?: boolean | null;

AllowUnauthenticatedIdentities: boolean;

CognitoIdentityProviders?: CognitoIdentityProvider[] | null;

DeveloperProviderName?: string | null;

IdentityPoolId: string;

IdentityPoolName: string;

IdentityPoolTags?: {

[key: string]: string | null | undefined;

} | null;

OpenIdConnectProviderARNs?: string[] | null;

SamlProviderARNs?: string[] | null;

SupportedLoginProviders?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

AllowClassicFlow?: boolean | null

[src]

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

AllowUnauthenticatedIdentities: boolean

[src]

TRUE if the identity pool supports unauthenticated logins.

CognitoIdentityProviders?: CognitoIdentityProvider[] | null

[src]

A list representing an Amazon Cognito user pool and its client ID.

DeveloperProviderName?: string | null

[src]

The "domain" by which Cognito will refer to your users.

IdentityPoolId: string

[src]

An identity pool ID in the format REGION:GUID.

IdentityPoolName: string

[src]

A string that you provide.

IdentityPoolTags?: {

[key: string]: string | null | undefined;

} | null

[src]

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

OpenIdConnectProviderARNs?: string[] | null

[src]

The ARNs of the OpenID Connect providers.

SamlProviderARNs?: string[] | null

[src]

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

SupportedLoginProviders?: {

[key: string]: string | null | undefined;

} | null

[src]

Optional key:value pairs mapping provider names to provider app IDs.