Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderSaml.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.UserPoolIdentityProviderSaml.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<UserPoolIdentityProviderSaml>
Enclosing class:
UserPoolIdentityProviderSaml
@Stability(Stable) public static final class UserPoolIdentityProviderSaml.Builder extends Object implements software.amazon.jsii.Builder<UserPoolIdentityProviderSaml>
A fluent builder for UserPoolIdentityProviderSaml.

  • Method Details

    • create

      @Stability(Stable) public static UserPoolIdentityProviderSaml.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of UserPoolIdentityProviderSaml.Builder.

    • userPool

      @Stability(Stable) public UserPoolIdentityProviderSaml.Builder userPool(IUserPool userPool)
      The user pool to which this construct provides identities.

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

    • attributeMapping

      @Stability(Stable) public UserPoolIdentityProviderSaml.Builder attributeMapping(AttributeMapping attributeMapping)
      Mapping attributes from the identity provider to standard and custom attributes of the user pool.

      Default: - no attribute mapping

      Parameters:
      attributeMapping - Mapping attributes from the identity provider to standard and custom attributes of the user pool. This parameter is required.
      Returns:
      this

    • metadata

      @Stability(Stable) public UserPoolIdentityProviderSaml.Builder metadata(UserPoolIdentityProviderSamlMetadata metadata)
      The SAML metadata.

      Parameters:
      metadata - The SAML metadata. This parameter is required.
      Returns:
      this

    • identifiers

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

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

      Default: - no identifiers used

      Parameters:
      identifiers - Identifiers. This parameter is required.
      Returns:
      this

    • idpSignout

      @Stability(Stable) public UserPoolIdentityProviderSaml.Builder idpSignout(Boolean idpSignout)
      Whether to enable the "Sign-out flow" feature.

      Default: - false

      Parameters:
      idpSignout - Whether to enable the "Sign-out flow" feature. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public UserPoolIdentityProviderSaml.Builder name(String name)
      The name of the provider.

      Must be between 3 and 32 characters.

      Default: - the unique ID of the construct

      Parameters:
      name - The name of the provider. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public UserPoolIdentityProviderSaml build()
      Specified by:
      build in interface software.amazon.jsii.Builder<UserPoolIdentityProviderSaml>
      Returns:
      a newly built instance of UserPoolIdentityProviderSaml.