Package software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

UserPoolIdentityProviderAmazonProps, UserPoolIdentityProviderAppleProps, UserPoolIdentityProviderFacebookProps, UserPoolIdentityProviderGoogleProps, UserPoolIdentityProviderOidcProps, UserPoolIdentityProviderSamlProps

All Known Implementing Classes:

UserPoolIdentityProviderAmazonProps.Jsii$Proxy, UserPoolIdentityProviderAppleProps.Jsii$Proxy, UserPoolIdentityProviderFacebookProps.Jsii$Proxy, UserPoolIdentityProviderGoogleProps.Jsii$Proxy, UserPoolIdentityProviderOidcProps.Jsii$Proxy, UserPoolIdentityProviderProps.Jsii$Proxy, UserPoolIdentityProviderSamlProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.442Z")
@Stability(Stable)
public interface UserPoolIdentityProviderProps
extends software.amazon.jsii.JsiiSerializable

Properties to create a new instance of UserPoolIdentityProvider.

Example:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserPoolIdentityProviderProps.Builder	A builder for UserPoolIdentityProviderProps
static final class	UserPoolIdentityProviderProps.Jsii$Proxy	An implementation for UserPoolIdentityProviderProps

Method Summary

Modifier and Type	Method	Description
static UserPoolIdentityProviderProps.Builder	builder()
default AttributeMapping	getAttributeMapping()	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
IUserPool	getUserPool()	The user pool to which this construct provides identities.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPool

@Stability(Stable)
@NotNull
IUserPool getUserPool()

The user pool to which this construct provides identities.

getAttributeMapping

@Stability(Stable)
@Nullable
default AttributeMapping getAttributeMapping()

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

Default: - no attribute mapping

builder

@Stability(Stable)
static UserPoolIdentityProviderProps.Builder builder()

Returns:

a UserPoolIdentityProviderProps.Builder of UserPoolIdentityProviderProps