Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderSamlProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderSamlProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderSamlProps>

Enclosing interface:

UserPoolIdentityProviderSamlProps

@Stability(Stable)
public static final class UserPoolIdentityProviderSamlProps.Builder
extends Object
implements software.amazon.jsii.Builder<UserPoolIdentityProviderSamlProps>

A builder for UserPoolIdentityProviderSamlProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderSamlProps.Builder	attributeMapping(AttributeMapping attributeMapping)	Sets the value of UserPoolIdentityProviderProps.getAttributeMapping()
UserPoolIdentityProviderSamlProps	build()	Builds the configured instance.
UserPoolIdentityProviderSamlProps.Builder	encryptedResponses(Boolean encryptedResponses)	Sets the value of UserPoolIdentityProviderSamlProps.getEncryptedResponses()
UserPoolIdentityProviderSamlProps.Builder	identifiers(List<String> identifiers)	Sets the value of UserPoolIdentityProviderSamlProps.getIdentifiers()
UserPoolIdentityProviderSamlProps.Builder	idpInitiated(Boolean idpInitiated)	Sets the value of UserPoolIdentityProviderSamlProps.getIdpInitiated()
UserPoolIdentityProviderSamlProps.Builder	idpSignout(Boolean idpSignout)	Sets the value of UserPoolIdentityProviderSamlProps.getIdpSignout()
UserPoolIdentityProviderSamlProps.Builder	metadata(UserPoolIdentityProviderSamlMetadata metadata)	Sets the value of UserPoolIdentityProviderSamlProps.getMetadata()
UserPoolIdentityProviderSamlProps.Builder	name(String name)	Sets the value of UserPoolIdentityProviderSamlProps.getName()
UserPoolIdentityProviderSamlProps.Builder	requestSigningAlgorithm(SigningAlgorithm requestSigningAlgorithm)	Sets the value of UserPoolIdentityProviderSamlProps.getRequestSigningAlgorithm()
UserPoolIdentityProviderSamlProps.Builder	userPool(IUserPool userPool)	Sets the value of UserPoolIdentityProviderProps.getUserPool()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

metadata

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder metadata(UserPoolIdentityProviderSamlMetadata metadata)

Sets the value of UserPoolIdentityProviderSamlProps.getMetadata()

Parameters:

metadata - The SAML metadata. This parameter is required.

Returns:

this

encryptedResponses

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder encryptedResponses(Boolean encryptedResponses)

Sets the value of UserPoolIdentityProviderSamlProps.getEncryptedResponses()

Parameters:

encryptedResponses - Whether to require encrypted SAML assertions from IdP.

Returns:

this

identifiers

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder identifiers(List<String> identifiers)

Sets the value of UserPoolIdentityProviderSamlProps.getIdentifiers()

Parameters:

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

Returns:

this

idpInitiated

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder idpInitiated(Boolean idpInitiated)

Sets the value of UserPoolIdentityProviderSamlProps.getIdpInitiated()

Parameters:

idpInitiated - Whether to enable IdP-initiated SAML auth flows.

Returns:

this

idpSignout

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder idpSignout(Boolean idpSignout)

Sets the value of UserPoolIdentityProviderSamlProps.getIdpSignout()

Parameters:

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

Returns:

this

name

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder name(String name)

Sets the value of UserPoolIdentityProviderSamlProps.getName()

Parameters:

name - The name of the provider. Must be between 3 and 32 characters.

Returns:

this

requestSigningAlgorithm

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder requestSigningAlgorithm(SigningAlgorithm requestSigningAlgorithm)

Sets the value of UserPoolIdentityProviderSamlProps.getRequestSigningAlgorithm()

Parameters:

requestSigningAlgorithm - The signing algorithm for SAML requests.

Returns:

this

userPool

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder userPool(IUserPool userPool)

Sets the value of UserPoolIdentityProviderProps.getUserPool()

Parameters:

userPool - The user pool to which this construct provides identities. This parameter is required.

Returns:

this

attributeMapping

@Stability(Stable)
public UserPoolIdentityProviderSamlProps.Builder attributeMapping(AttributeMapping attributeMapping)

Sets the value of UserPoolIdentityProviderProps.getAttributeMapping()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public UserPoolIdentityProviderSamlProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<UserPoolIdentityProviderSamlProps>

Returns:

a new instance of UserPoolIdentityProviderSamlProps

Throws:

NullPointerException - if any required attribute was not provided