Interface CfnUserPoolIdentityProviderProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.954Z") @Stability(Stable) public interface CfnUserPoolIdentityProviderProps extends
Properties for defining a CfnUserPoolIdentityProvider.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object attributeMapping;
 Object providerDetails;
 CfnUserPoolIdentityProviderProps cfnUserPoolIdentityProviderProps = CfnUserPoolIdentityProviderProps.builder()
         // the properties below are optional
  • Method Details

    • getProviderName

      @Stability(Stable) @NotNull String getProviderName()
      The IdP name.
    • getProviderType

      @Stability(Stable) @NotNull String getProviderType()
      The IdP type.
    • getUserPoolId

      @Stability(Stable) @NotNull String getUserPoolId()
      The user pool ID.
    • getAttributeMapping

      @Stability(Stable) @Nullable default Object getAttributeMapping()
      A mapping of IdP attributes to standard and custom user pool attributes.
    • getIdpIdentifiers

      @Stability(Stable) @Nullable default List<String> getIdpIdentifiers()
      A list of IdP identifiers.
    • getProviderDetails

      @Stability(Stable) @Nullable default Object getProviderDetails()
      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
    • builder

      @Stability(Stable) static CfnUserPoolIdentityProviderProps.Builder builder()
      a CfnUserPoolIdentityProviderProps.Builder of CfnUserPoolIdentityProviderProps