interface IdentityPoolAuthenticationProviders
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Cognito.IdentityPool.Alpha.IdentityPoolAuthenticationProviders |
Go | github.com/aws/aws-cdk-go/awscdkcognitoidentitypoolalpha/v2#IdentityPoolAuthenticationProviders |
Java | software.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolAuthenticationProviders |
Python | aws_cdk.aws_cognito_identitypool_alpha.IdentityPoolAuthenticationProviders |
TypeScript (source) | @aws-cdk/aws-cognito-identitypool-alpha ยป IdentityPoolAuthenticationProviders |
External Authentication Providers for usage 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
Name | Type | Description |
---|---|---|
amazon? | Identity | The Amazon Authentication Provider associated with this Identity Pool. |
apple? | Identity | The Apple Authentication Provider associated with this Identity Pool. |
custom | string | The developer provider name to associate with this Identity Pool. |
facebook? | Identity | The Facebook Authentication Provider associated with this Identity Pool. |
google? | Identity | The Google Authentication Provider associated with this Identity Pool. |
open | IOpen [] | The OpenIdConnect Provider associated with this Identity Pool. |
saml | ISaml [] | The Security Assertion Markup Language provider associated with this Identity Pool. |
twitter? | Identity | The Twitter Authentication Provider associated with this Identity Pool. |
user | IUser [] | The User Pool Authentication Providers associated with this Identity Pool. |
amazon?
Type:
Identity
(optional, default: No Amazon Authentication Provider used without OpenIdConnect or a User Pool)
The Amazon Authentication Provider associated with this Identity Pool.
apple?
Type:
Identity
(optional, default: No Apple Authentication Provider used without OpenIdConnect or a User Pool)
The Apple Authentication Provider associated with this Identity Pool.
customProvider?
Type:
string
(optional, default: no custom provider)
The developer provider name to associate with this Identity Pool.
facebook?
Type:
Identity
(optional, default: No Facebook Authentication Provider used without OpenIdConnect or a User Pool)
The Facebook Authentication Provider associated with this Identity Pool.
google?
Type:
Identity
(optional, default: No Google Authentication Provider used without OpenIdConnect or a User Pool)
The Google Authentication Provider associated with this Identity Pool.
openIdConnectProviders?
Type:
IOpen
[]
(optional, default: no OpenIdConnectProvider)
The OpenIdConnect Provider associated with this Identity Pool.
samlProviders?
Type:
ISaml
[]
(optional, default: no SamlProvider)
The Security Assertion Markup Language provider associated with this Identity Pool.
twitter?
Type:
Identity
(optional, default: No Twitter Authentication Provider used without OpenIdConnect or a User Pool)
The Twitter Authentication Provider associated with this Identity Pool.
userPools?
Type:
IUser
[]
(optional, default: no User Pools associated)
The User Pool Authentication Providers associated with this Identity Pool.