Package 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.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:34.146Z")
@Stability(Stable)
public interface UserPoolIdentityProviderSamlProps
extends software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

Properties to initialize UserPoolIdentityProviderSaml.

Example:

 UserPool userpool = new UserPool(this, "Pool");
 // specify the metadata as a file content
 // specify the metadata as a file content
 UserPoolIdentityProviderSaml.Builder.create(this, "userpoolIdpFile")
         .userPool(userpool)
         .metadata(UserPoolIdentityProviderSamlMetadata.file("my-file-contents"))
         // Whether to require encrypted SAML assertions from IdP
         .encryptedResponses(true)
         // The signing algorithm for the SAML requests
         .requestSigningAlgorithm(SigningAlgorithm.RSA_SHA256)
         // Enable IdP initiated SAML auth flow
         .idpInitiated(true)
         .build();
 // specify the metadata as a URL
 // specify the metadata as a URL
 UserPoolIdentityProviderSaml.Builder.create(this, "userpoolidpUrl")
         .userPool(userpool)
         .metadata(UserPoolIdentityProviderSamlMetadata.url("https://my-metadata-url.com"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserPoolIdentityProviderSamlProps.Builder	builder()
default Boolean	getEncryptedResponses()	Whether to require encrypted SAML assertions from IdP.
default List<String>	getIdentifiers()	Identifiers.
default Boolean	getIdpInitiated()	Whether to enable IdP-initiated SAML auth flows.
default Boolean	getIdpSignout()	Whether to enable the "Sign-out flow" feature.
UserPoolIdentityProviderSamlMetadata	getMetadata()	The SAML metadata.
default String	getName()	The name of the provider.
default SigningAlgorithm	getRequestSigningAlgorithm()	The signing algorithm for SAML requests.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getAttributeMapping, getUserPool

Method Details

getMetadata

@Stability(Stable)
@NotNull
UserPoolIdentityProviderSamlMetadata getMetadata()

The SAML metadata.

getEncryptedResponses

@Stability(Stable)
@Nullable
default Boolean getEncryptedResponses()

Whether to require encrypted SAML assertions from IdP.

Default: false

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html#cognito-user-pools-SAML-encryption

getIdentifiers

@Stability(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

getIdpInitiated

@Stability(Stable)
@Nullable
default Boolean getIdpInitiated()

Whether to enable IdP-initiated SAML auth flows.

Default: false

getIdpSignout

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

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

Default: - false

getName

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

The name of the provider.

Must be between 3 and 32 characters.

Default: - the unique ID of the construct

getRequestSigningAlgorithm

@Stability(Stable)
@Nullable
default SigningAlgorithm getRequestSigningAlgorithm()

The signing algorithm for SAML requests.

Default: - don't sign requests

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html#cognito-user-pools-SAML-signing

builder

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

Returns:

a UserPoolIdentityProviderSamlProps.Builder of UserPoolIdentityProviderSamlProps