Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderOidc.Builder

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

  • Method Details

    • create

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

    • userPool

      @Stability(Stable) public UserPoolIdentityProviderOidc.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 UserPoolIdentityProviderOidc.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

    • clientId

      @Stability(Stable) public UserPoolIdentityProviderOidc.Builder clientId(String clientId)
      The client id.

      Parameters:
      clientId - The client id. This parameter is required.
      Returns:
      this

    • clientSecret

      @Stability(Stable) public UserPoolIdentityProviderOidc.Builder clientSecret(String clientSecret)
      The client secret.

      Parameters:
      clientSecret - The client secret. This parameter is required.
      Returns:
      this

    • issuerUrl

      @Stability(Stable) public UserPoolIdentityProviderOidc.Builder issuerUrl(String issuerUrl)
      Issuer URL.

      Parameters:
      issuerUrl - Issuer URL. This parameter is required.
      Returns:
      this

    • attributeRequestMethod

      @Stability(Stable) public UserPoolIdentityProviderOidc.Builder attributeRequestMethod(OidcAttributeRequestMethod attributeRequestMethod)
      The method to use to request attributes.

      Default: OidcAttributeRequestMethod.GET

      Parameters:
      attributeRequestMethod - The method to use to request attributes. This parameter is required.
      Returns:
      this

    • endpoints

      @Stability(Stable) public UserPoolIdentityProviderOidc.Builder endpoints(OidcEndpoints endpoints)
      OpenID connect endpoints.

      Default: - auto discovered with issuer URL

      Parameters:
      endpoints - OpenID connect endpoints. This parameter is required.
      Returns:
      this

    • identifiers

      @Stability(Stable) public UserPoolIdentityProviderOidc.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

    • name

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

      Default: - the unique ID of the construct

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

    • scopes

      @Stability(Stable) public UserPoolIdentityProviderOidc.Builder scopes(List<String> scopes)
      The OAuth 2.0 scopes that you will request from OpenID Connect. Scopes are groups of OpenID Connect user attributes to exchange with your app.

      Default: ['openid']

      Parameters:
      scopes - The OAuth 2.0 scopes that you will request from OpenID Connect. Scopes are groups of OpenID Connect user attributes to exchange with your app. This parameter is required.
      Returns:
      this

    • build

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