Class UserPoolIdentityProviderProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties to create a new instance of UserPoolIdentityProvider.

public class UserPoolIdentityProviderProps : IUserPoolIdentityProviderProps

Inheritance

object

UserPoolIdentityProviderProps

Implements

IUserPoolIdentityProviderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Cognito;

            ProviderAttribute providerAttribute;
            UserPool userPool;

            var userPoolIdentityProviderProps = new UserPoolIdentityProviderProps {
                UserPool = userPool,

                // the properties below are optional
                AttributeMapping = new AttributeMapping {
                    Address = providerAttribute,
                    Birthdate = providerAttribute,
                    Custom = new Dictionary<string, ProviderAttribute> {
                        { "customKey", providerAttribute }
                    },
                    Email = providerAttribute,
                    FamilyName = providerAttribute,
                    Fullname = providerAttribute,
                    Gender = providerAttribute,
                    GivenName = providerAttribute,
                    LastUpdateTime = providerAttribute,
                    Locale = providerAttribute,
                    MiddleName = providerAttribute,
                    Nickname = providerAttribute,
                    PhoneNumber = providerAttribute,
                    PreferredUsername = providerAttribute,
                    ProfilePage = providerAttribute,
                    ProfilePicture = providerAttribute,
                    Timezone = providerAttribute,
                    Website = providerAttribute
                }
            };

Remarks

ExampleMetadata: fixture=_generated

Constructors

UserPoolIdentityProviderProps()

public UserPoolIdentityProviderProps()

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

UserPool

The user pool to which this construct provides identities.

public IUserPool UserPool { get; set; }

Property Value

IUserPool