Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.187.0

class IdentityPoolProviderUrl

LanguageType name
.NETAmazon.CDK.AWS.Cognito.Identitypool.IdentityPoolProviderUrl
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognitoidentitypool#IdentityPoolProviderUrl
Javasoftware.amazon.awscdk.services.cognito.identitypool.IdentityPoolProviderUrl
Pythonaws_cdk.aws_cognito_identitypool.IdentityPoolProviderUrl
TypeScript (source)aws-cdk-lib » aws_cognito_identitypool » IdentityPoolProviderUrl

Keys for Login Providers - each correspond to the client IDs of their respective federation Identity Providers.

Example

import { IdentityPoolProviderUrl } from 'aws-cdk-lib/aws-cognito-identitypool';

new IdentityPool(this, 'myidentitypool', {
  identityPoolName: 'myidentitypool',
  roleMappings: [
    {
      providerUrl: IdentityPoolProviderUrl.custom('my-custom-provider.com'),
      useToken: true,
    },
  ],
});

Initializer

new IdentityPoolProviderUrl(type: IdentityPoolProviderType, value: string)

Parameters

  • type IdentityPoolProviderType — The type of Identity Pool Provider.
  • value string — The value of the Identity Pool Provider.

Properties

NameTypeDescription
typeIdentityPoolProviderTypeThe type of Identity Pool Provider.
valuestringThe value of the Identity Pool Provider.
static AMAZONIdentityPoolProviderUrlAmazon Provider url.
static APPLEIdentityPoolProviderUrlApple Provider url.
static FACEBOOKIdentityPoolProviderUrlFacebook Provider url.
static GOOGLEIdentityPoolProviderUrlGoogle Provider url.
static TWITTERIdentityPoolProviderUrlTwitter Provider url.

type

Type: IdentityPoolProviderType

The type of Identity Pool Provider.

value

Type: string

The value of the Identity Pool Provider.

static AMAZON

Type: IdentityPoolProviderUrl

Amazon Provider url.

static APPLE

Type: IdentityPoolProviderUrl

Apple Provider url.

static FACEBOOK

Type: IdentityPoolProviderUrl

Facebook Provider url.

static GOOGLE

Type: IdentityPoolProviderUrl

Google Provider url.

static TWITTER

Type: IdentityPoolProviderUrl

Twitter Provider url.

Methods

NameDescription
static custom(url)Custom Provider url.
static openId(url)OpenId Provider url.
static saml(url)Saml Provider url.
static userPool(userPool, userPoolClient)User Pool Provider Url.

static custom(url)

public static custom(url: string): IdentityPoolProviderUrl

Parameters

  • url string

Returns

Custom Provider url.

static openId(url)

public static openId(url: string): IdentityPoolProviderUrl

Parameters

  • url string

Returns

OpenId Provider url.

static saml(url)

public static saml(url: string): IdentityPoolProviderUrl

Parameters

  • url string

Returns

Saml Provider url.

static userPool(userPool, userPoolClient)

public static userPool(userPool: IUserPool, userPoolClient: IUserPoolClient): IdentityPoolProviderUrl

Parameters

Returns

User Pool Provider Url.

← PreviousNext →