Package software.amazon.awscdk.services.cognito

Class CfnUserPoolIdentityProvider.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnUserPoolIdentityProvider.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnUserPoolIdentityProvider.Builder.

    • providerName

      @Stability(Stable) public CfnUserPoolIdentityProvider.Builder providerName(String providerName)
      The IdP name.

      Parameters:
      providerName - The IdP name. This parameter is required.
      Returns:
      this

    • providerType

      @Stability(Stable) public CfnUserPoolIdentityProvider.Builder providerType(String providerType)
      The IdP type.

      Parameters:
      providerType - The IdP type. This parameter is required.
      Returns:
      this

    • userPoolId

      @Stability(Stable) public CfnUserPoolIdentityProvider.Builder userPoolId(String userPoolId)
      The user pool ID.

      Parameters:
      userPoolId - The user pool ID. This parameter is required.
      Returns:
      this

    • attributeMapping

      @Stability(Stable) public CfnUserPoolIdentityProvider.Builder attributeMapping(Object attributeMapping)
      A mapping of IdP attributes to standard and custom user pool attributes.

      Parameters:
      attributeMapping - A mapping of IdP attributes to standard and custom user pool attributes. This parameter is required.
      Returns:
      this

    • idpIdentifiers

      @Stability(Stable) public CfnUserPoolIdentityProvider.Builder idpIdentifiers(List<String> idpIdentifiers)
      A list of IdP identifiers.

      Parameters:
      idpIdentifiers - A list of IdP identifiers. This parameter is required.
      Returns:
      this

    • providerDetails

      @Stability(Stable) public CfnUserPoolIdentityProvider.Builder providerDetails(Object providerDetails)
      The IdP details. The following list describes the provider detail keys for each IdP type.

      • For Google and Login with Amazon:
      • client_id
      • client_secret
      • authorize_scopes
      • For Facebook:
      • client_id
      • client_secret
      • authorize_scopes
      • api_version
      • For Sign in with Apple:
      • client_id
      • team_id
      • key_id
      • private_key
      • authorize_scopes
      • For OpenID Connect (OIDC) providers:
      • client_id
      • client_secret
      • attributes_request_method
      • oidc_issuer
      • authorize_scopes
      • The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
      • authorize_url
      • token_url
      • attributes_url
      • jwks_uri
      • Amazon Cognito sets the value of the following keys automatically. They are read-only.
      • attributes_url_add_attributes
      • For SAML providers:
      • MetadataFile or MetadataURL
      • IDPSignout optional

      Parameters:
      providerDetails - The IdP details. The following list describes the provider detail keys for each IdP type. This parameter is required.
      Returns:
      this

    • build

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