software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderSamlProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderSamlProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.695Z")
 @Stability(value=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 Classes

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

Method Summary

Modifier and Type	Method and Description
static UserPoolIdentityProviderSamlProps.Builder	builder()
default List<String>	getIdentifiers() Identifiers.
default Boolean	getIdpSignout() Whether to enable the "Sign-out flow" feature.
UserPoolIdentityProviderSamlMetadata	getMetadata() The SAML metadata.
default String	getName() The name of the provider.

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps

getAttributeMapping, getUserPool

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetadata

@Stability(value=Stable)
 @NotNull
UserPoolIdentityProviderSamlMetadata getMetadata()

The SAML metadata.

getIdentifiers

@Stability(value=Stable)
 @Nullable
default List<String> getIdentifiers()

Identifiers.

Identifiers can be used to redirect users to the correct IdP in multitenant apps.

Default: - no identifiers used

getIdpSignout

@Stability(value=Stable)
 @Nullable
default Boolean getIdpSignout()

Whether to enable the "Sign-out flow" feature.

Default: - false

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of the provider.

Must be between 3 and 32 characters.

Default: - the unique ID of the construct

builder

@Stability(value=Stable)
static UserPoolIdentityProviderSamlProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderSamlProps.Builder of UserPoolIdentityProviderSamlProps