AWS CDK Reference

Appearance

v2.277.0

UserPoolIdentityProviderProps Struct ​

Properties to create a new instance of UserPoolIdentityProvider.

Source
aws-cognito/lib/user-pool-idps/base.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderProps: cognito.UserPoolIdentityProviderProps = {
  userPool: userPool,

  // the properties below are optional
  attributeMapping: {
    address: providerAttribute,
    birthdate: providerAttribute,
    custom: {
      customKey: providerAttribute,
    },
    email: providerAttribute,
    emailVerified: 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,
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito

# provider_attribute: cognito.ProviderAttribute
# user_pool: cognito.UserPool

user_pool_identity_provider_props = cognito.UserPoolIdentityProviderProps(
    user_pool=user_pool,

    # the properties below are optional
    attribute_mapping=cognito.AttributeMapping(
        address=provider_attribute,
        birthdate=provider_attribute,
        custom={
            "custom_key": provider_attribute
        },
        email=provider_attribute,
        email_verified=provider_attribute,
        family_name=provider_attribute,
        fullname=provider_attribute,
        gender=provider_attribute,
        given_name=provider_attribute,
        last_update_time=provider_attribute,
        locale=provider_attribute,
        middle_name=provider_attribute,
        nickname=provider_attribute,
        phone_number=provider_attribute,
        preferred_username=provider_attribute,
        profile_page=provider_attribute,
        profile_picture=provider_attribute,
        timezone=provider_attribute,
        website=provider_attribute
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cognito.*;

ProviderAttribute providerAttribute;
UserPool userPool;

UserPoolIdentityProviderProps userPoolIdentityProviderProps = UserPoolIdentityProviderProps.builder()
        .userPool(userPool)

        // the properties below are optional
        .attributeMapping(AttributeMapping.builder()
                .address(providerAttribute)
                .birthdate(providerAttribute)
                .custom(Map.of(
                        "customKey", providerAttribute))
                .email(providerAttribute)
                .emailVerified(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)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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,
        EmailVerified = 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
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var providerAttribute ProviderAttribute
var userPool UserPool

userPoolIdentityProviderProps := &UserPoolIdentityProviderProps{
	UserPool: userPool,

	// the properties below are optional
	AttributeMapping: &AttributeMapping{
		Address: providerAttribute,
		Birthdate: providerAttribute,
		Custom: map[string]ProviderAttribute{
			"customKey": providerAttribute,
		},
		Email: providerAttribute,
		EmailVerified: 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,
	},
}

Properties ​

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

Default: no attribute mapping

userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#
The user pool to which this construct provides identities.