Package software.amazon.awscdk.services.cognito.identitypool.alpha

Interface IdentityPoolAuthenticationProviders

All Superinterfaces:

IdentityPoolProviders, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IdentityPoolAuthenticationProviders.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-18T22:17:05.769Z")
@Stability(Experimental)
public interface IdentityPoolAuthenticationProviders
extends software.amazon.jsii.JsiiSerializable, IdentityPoolProviders

(experimental) Authentication providers for using in identity pool.

Example:

 OpenIdConnectProvider openIdConnectProvider;
 IdentityPool.Builder.create(this, "myidentitypool")
         .identityPoolName("myidentitypool")
         .authenticationProviders(IdentityPoolAuthenticationProviders.builder()
                 .google(IdentityPoolGoogleLoginProvider.builder()
                         .clientId("12345678012.apps.googleusercontent.com")
                         .build())
                 .openIdConnectProviders(List.of(openIdConnectProvider))
                 .customProvider("my-custom-provider.example.com")
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/external-identity-providers.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IdentityPoolAuthenticationProviders.Builder	builder()
default String	getCustomProvider()	(experimental) The Developer Provider Name to associate with this Identity Pool.
default List<IOpenIdConnectProvider>	getOpenIdConnectProviders()	(experimental) The OpenIdConnect Provider associated with this Identity Pool.
default List<ISamlProvider>	getSamlProviders()	(experimental) The Security Assertion Markup Language Provider associated with this Identity Pool.
default List<IUserPoolAuthenticationProvider>	getUserPools()	(experimental) The User Pool Authentication Providers associated with this Identity Pool.

Methods inherited from interface software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProviders

getAmazon, getApple, getDigits, getFacebook, getGoogle, getTwitter

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomProvider

@Stability(Experimental)
@Nullable
default String getCustomProvider()

(experimental) The Developer Provider Name to associate with this Identity Pool.

Default: - no Custom Provider

getOpenIdConnectProviders

@Stability(Experimental)
@Nullable
default List<IOpenIdConnectProvider> getOpenIdConnectProviders()

(experimental) The OpenIdConnect Provider associated with this Identity Pool.

Default: - no OpenIdConnectProvider

getSamlProviders

@Stability(Experimental)
@Nullable
default List<ISamlProvider> getSamlProviders()

(experimental) The Security Assertion Markup Language Provider associated with this Identity Pool.

Default: - no SamlProvider

getUserPools

@Stability(Experimental)
@Nullable
default List<IUserPoolAuthenticationProvider> getUserPools()

(experimental) The User Pool Authentication Providers associated with this Identity Pool.

Default: - no User Pools Associated

builder

@Stability(Experimental)
static IdentityPoolAuthenticationProviders.Builder builder()

Returns:

a IdentityPoolAuthenticationProviders.Builder of IdentityPoolAuthenticationProviders