Class UserPoolClientIdentityProvider
Identity providers supported by the UserPoolClient.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class UserPoolClientIdentityProvider : DeputyBase
Syntax (vb)
Public Class UserPoolClientIdentityProvider
Inherits DeputyBase
Remarks
ExampleMetadata: infused
Examples
var pool = new UserPool(this, "Pool");
pool.AddClient("app-client", new UserPoolClientOptions {
// ...
SupportedIdentityProviders = new [] { UserPoolClientIdentityProvider.AMAZON, UserPoolClientIdentityProvider.COGNITO }
});
Synopsis
Constructors
UserPoolClientIdentityProvider(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
UserPoolClientIdentityProvider(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AMAZON | Allow users to sign in using 'Login With Amazon'. |
APPLE | Allow users to sign in using 'Sign In With Apple'. |
COGNITO | Allow users to sign in directly as a user of the User Pool. |
Allow users to sign in using 'Facebook Login'. |
|
Allow users to sign in using 'Google Login'. |
|
Name | The name of the identity provider as recognized by CloudFormation property |
Methods
Custom(String) | Specify a provider not yet supported by the CDK. |
Constructors
UserPoolClientIdentityProvider(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected UserPoolClientIdentityProvider(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
UserPoolClientIdentityProvider(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected UserPoolClientIdentityProvider(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
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
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.
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
System.String
Methods
Custom(String)
Specify a provider not yet supported by the CDK.
public static UserPoolClientIdentityProvider Custom(string name)
Parameters
- name System.String
name of the identity provider as recognized by CloudFormation property
SupportedIdentityProviders
.
Returns
UserPoolClientIdentityProvider