Class UserPoolIdentityProviderAmazonProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties to initialize UserPoolAmazonIdentityProvider.

public class UserPoolIdentityProviderAmazonProps : IUserPoolIdentityProviderAmazonProps, IUserPoolIdentityProviderProps

Inheritance

object

UserPoolIdentityProviderAmazonProps

Implements

IUserPoolIdentityProviderAmazonProps

IUserPoolIdentityProviderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

var pool = new UserPool(this, "Pool");
            var provider = new UserPoolIdentityProviderAmazon(this, "Amazon", new UserPoolIdentityProviderAmazonProps {
                UserPool = pool,
                ClientId = "amzn-client-id",
                ClientSecret = "amzn-client-secret"
            });

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

            client.Node.AddDependency(provider);

Remarks

ExampleMetadata: infused

Constructors

UserPoolIdentityProviderAmazonProps()

public UserPoolIdentityProviderAmazonProps()

Properties

AttributeMapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

public IAttributeMapping? AttributeMapping { get; set; }

Property Value

IAttributeMapping

Remarks

Default: - no attribute mapping

ClientId

The client id recognized by 'Login with Amazon' APIs.

public string ClientId { get; set; }

Property Value

string

Remarks

See: https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

ClientSecret

The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.

public string ClientSecret { get; set; }

Property Value

string

Remarks

See: https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

Scopes

The types of user profile data to obtain for the Amazon profile.

public string[]? Scopes { get; set; }

Property Value

string[]

Remarks

Default: [ profile ]

See: https://developer.amazon.com/docs/login-with-amazon/customer-profile.html

UserPool

The user pool to which this construct provides identities.

public IUserPool UserPool { get; set; }

Property Value

IUserPool