Class UserPoolClientIdentityProvider

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Identity providers supported by the UserPoolClient.

public class UserPoolClientIdentityProvider : DeputyBase

Inheritance

object

UserPoolClientIdentityProvider

Examples

var pool = new UserPool(this, "Pool");
            pool.AddClient("app-client", new UserPoolClientOptions {
                // ...
                SupportedIdentityProviders = new [] { UserPoolClientIdentityProvider.AMAZON, UserPoolClientIdentityProvider.COGNITO }
            });

Remarks

ExampleMetadata: infused

Properties

AMAZON

Allow users to sign in using 'Login With Amazon'.

public static UserPoolClientIdentityProvider AMAZON { get; }

Property Value

UserPoolClientIdentityProvider

Remarks

A UserPoolIdentityProviderAmazon must be attached to the user pool.

APPLE

Allow users to sign in using 'Sign In With Apple'.

public static UserPoolClientIdentityProvider APPLE { get; }

Property Value

UserPoolClientIdentityProvider

Remarks

A UserPoolIdentityProviderApple must be attached to the user pool.

COGNITO

Allow users to sign in directly as a user of the User Pool.

public static UserPoolClientIdentityProvider COGNITO { get; }

Property Value

UserPoolClientIdentityProvider

FACEBOOK

Allow users to sign in using 'Facebook Login'.

public static UserPoolClientIdentityProvider FACEBOOK { get; }

Property Value

UserPoolClientIdentityProvider

Remarks

A UserPoolIdentityProviderFacebook must be attached to the user pool.

GOOGLE

Allow users to sign in using 'Google Login'.

public static UserPoolClientIdentityProvider GOOGLE { get; }

Property Value

UserPoolClientIdentityProvider

Remarks

A UserPoolIdentityProviderGoogle must be attached to the user pool.

Name

The name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.

public virtual string Name { get; }

Property Value

string

Methods

Custom(string)

Specify a provider not yet supported by the CDK.

public static UserPoolClientIdentityProvider Custom(string name)

Parameters

name string

name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.

Returns

UserPoolClientIdentityProvider