Interface UserPoolIdentityProviderSamlProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,UserPoolIdentityProviderProps
- All Known Implementing Classes:
UserPoolIdentityProviderSamlProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
date="2023-10-26T00:56:05.955Z")
@Stability(Stable)
public interface UserPoolIdentityProviderSamlProps
extends software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps
Properties to initialize UserPoolIdentityProviderSaml.
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;
UserPoolIdentityProviderSamlMetadata userPoolIdentityProviderSamlMetadata;
UserPoolIdentityProviderSamlProps userPoolIdentityProviderSamlProps = UserPoolIdentityProviderSamlProps.builder()
.metadata(userPoolIdentityProviderSamlMetadata)
.userPool(userPool)
// the properties below are optional
.attributeMapping(AttributeMapping.builder()
.address(providerAttribute)
.birthdate(providerAttribute)
.custom(Map.of(
"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)
.build())
.identifiers(List.of("identifiers"))
.idpSignout(false)
.name("name")
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forUserPoolIdentityProviderSamlPropsstatic final classAn implementation forUserPoolIdentityProviderSamlProps -
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps
getAttributeMapping, getUserPool
-
Method Details
-
getMetadata
The SAML metadata. -
getIdentifiers
Identifiers.Identifiers can be used to redirect users to the correct IdP in multitenant apps.
Default: - no identifiers used
-
getIdpSignout
Whether to enable the "Sign-out flow" feature.Default: - false
-
getName
The name of the provider.Must be between 3 and 32 characters.
Default: - the unique ID of the construct
-
builder
-