@aws-cdk_aws-cognito-identitypool-alpha.IdentityPoolAuthenticationProviders

interface IdentityPoolAuthenticationProviders ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Cognito.IdentityPool.Alpha.IdentityPoolAuthenticationProviders
Gogithub.com/aws/aws-cdk-go/awscdkcognitoidentitypoolalpha/v2#IdentityPoolAuthenticationProviders
Javasoftware.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolAuthenticationProviders
Pythonaws_cdk.aws_cognito_identitypool_alpha.IdentityPoolAuthenticationProviders
TypeScript (source)@aws-cdk/aws-cognito-identitypool-alpha ยป IdentityPoolAuthenticationProviders

Authentication providers for using in identity pool.

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

Example

declare const openIdConnectProvider: iam.OpenIdConnectProvider;
new IdentityPool(this, 'myidentitypool', {
  identityPoolName: 'myidentitypool',
  authenticationProviders: {
    google: {
      clientId: '12345678012.apps.googleusercontent.com',
    },
    openIdConnectProviders: [openIdConnectProvider],
    customProvider: 'my-custom-provider.example.com',
  },
});

Properties

NameTypeDescription
amazon?๐Ÿ”นIdentityPoolAmazonLoginProviderApp Id for Amazon Identity Federation.
apple?๐Ÿ”นIdentityPoolAppleLoginProviderServices Id for Apple Identity Federation.
customProvider?๐Ÿ”นstringThe Developer Provider Name to associate with this Identity Pool.
digits?๐Ÿ”นIdentityPoolDigitsLoginProviderConsumer Key and Secret for Digits Identity Federation.
facebook?๐Ÿ”นIdentityPoolFacebookLoginProviderApp Id for Facebook Identity Federation.
google?๐Ÿ”นIdentityPoolGoogleLoginProviderClient Id for Google Identity Federation.
openIdConnectProviders?๐Ÿ”นIOpenIdConnectProvider[]The OpenIdConnect Provider associated with this Identity Pool.
samlProviders?๐Ÿ”นISamlProvider[]The Security Assertion Markup Language Provider associated with this Identity Pool.
twitter?๐Ÿ”นIdentityPoolTwitterLoginProviderConsumer Key and Secret for Twitter Identity Federation.
userPools?๐Ÿ”นIUserPoolAuthenticationProvider[]The User Pool Authentication Providers associated with this Identity Pool.

amazon?๐Ÿ”น

Type: IdentityPoolAmazonLoginProvider (optional, default: No Amazon Authentication Provider used without OpenIdConnect or a User Pool)

App Id for Amazon Identity Federation.


apple?๐Ÿ”น

Type: IdentityPoolAppleLoginProvider (optional, default: No Apple Authentication Provider used without OpenIdConnect or a User Pool)

Services Id for Apple Identity Federation.


customProvider?๐Ÿ”น

Type: string (optional, default: no Custom Provider)

The Developer Provider Name to associate with this Identity Pool.


digits?๐Ÿ”น

Type: IdentityPoolDigitsLoginProvider (optional, default: No Digits Authentication Provider used without OpenIdConnect or a User Pool)

Consumer Key and Secret for Digits Identity Federation.


facebook?๐Ÿ”น

Type: IdentityPoolFacebookLoginProvider (optional, default: No Facebook Authentication Provider used without OpenIdConnect or a User Pool)

App Id for Facebook Identity Federation.


google?๐Ÿ”น

Type: IdentityPoolGoogleLoginProvider (optional, default: No Google Authentication Provider used without OpenIdConnect or a User Pool)

Client Id for Google Identity Federation.


openIdConnectProviders?๐Ÿ”น

Type: IOpenIdConnectProvider[] (optional, default: no OpenIdConnectProvider)

The OpenIdConnect Provider associated with this Identity Pool.


samlProviders?๐Ÿ”น

Type: ISamlProvider[] (optional, default: no SamlProvider)

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


twitter?๐Ÿ”น

Type: IdentityPoolTwitterLoginProvider (optional, default: No Twitter Authentication Provider used without OpenIdConnect or a User Pool)

Consumer Key and Secret for Twitter Identity Federation.


userPools?๐Ÿ”น

Type: IUserPoolAuthenticationProvider[] (optional, default: no User Pools Associated)

The User Pool Authentication Providers associated with this Identity Pool.