AWS CDK Reference

Appearance

v2.277.0

UserPoolClientIdentityProvider Class ​

Identity providers supported by the UserPoolClient.

Source
aws-cognito/lib/user-pool-client.ts

Example ​

ts
const pool = new cognito.UserPool(this, 'Pool');
pool.addClient('app-client', {
  // ...
  supportedIdentityProviders: [
    cognito.UserPoolClientIdentityProvider.AMAZON,
    cognito.UserPoolClientIdentityProvider.COGNITO,
  ],
});
python
pool = cognito.UserPool(self, "Pool")
pool.add_client("app-client",
    # ...
    supported_identity_providers=[cognito.UserPoolClientIdentityProvider.AMAZON, cognito.UserPoolClientIdentityProvider.COGNITO
    ]
)
java
UserPool pool = new UserPool(this, "Pool");
pool.addClient("app-client", UserPoolClientOptions.builder()
        // ...
        .supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON, UserPoolClientIdentityProvider.COGNITO))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
var pool = new UserPool(this, "Pool");
pool.AddClient("app-client", new UserPoolClientOptions {
    // ...
    SupportedIdentityProviders = new [] { UserPoolClientIdentityProvider.AMAZON, UserPoolClientIdentityProvider.COGNITO }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
pool := cognito.NewUserPool(this, jsii.String("Pool"))
pool.addClient(jsii.String("app-client"), &UserPoolClientOptions{
	// ...
	SupportedIdentityProviders: []UserPoolClientIdentityProvider{
		cognito.UserPoolClientIdentityProvider_AMAZON(),
		cognito.UserPoolClientIdentityProvider_COGNITO(),
	},
})

Properties ​

AMAZONUserPoolClientIdentityProvideramazonUserPoolClientIdentityProviderAMAZONUserPoolClientIdentityProviderAMAZONUserPoolClientIdentityProviderAMAZONUserPoolClientIdentityProviderstatic#
Allow users to sign in using 'Login With Amazon'.

A UserPoolIdentityProviderAmazon must be attached to the user pool.

APPLEUserPoolClientIdentityProviderappleUserPoolClientIdentityProviderAPPLEUserPoolClientIdentityProviderAPPLEUserPoolClientIdentityProviderAPPLEUserPoolClientIdentityProviderstatic#
Allow users to sign in using 'Sign In With Apple'.

A UserPoolIdentityProviderApple must be attached to the user pool.

FACEBOOKUserPoolClientIdentityProviderfacebookUserPoolClientIdentityProviderFACEBOOKUserPoolClientIdentityProviderFACEBOOKUserPoolClientIdentityProviderFACEBOOKUserPoolClientIdentityProviderstatic#
Allow users to sign in using 'Facebook Login'.

A UserPoolIdentityProviderFacebook must be attached to the user pool.

GOOGLEUserPoolClientIdentityProvidergoogleUserPoolClientIdentityProviderGOOGLEUserPoolClientIdentityProviderGOOGLEUserPoolClientIdentityProviderGOOGLEUserPoolClientIdentityProviderstatic#
Allow users to sign in using 'Google Login'.

A UserPoolIdentityProviderGoogle must be attached to the user pool.

namestringnamestrnameStringNamestringName*string#
The name of the identity provider as recognized by CloudFormation property `SupportedIdentityProviders`.

Methods ​

custom(name: string): UserPoolClientIdentityProvider // chainable@staticmethod def custom(name: str) -> UserPoolClientIdentityProviderpublic static UserPoolClientIdentityProvider custom(String name)public static UserPoolClientIdentityProvider Custom(string name)func Custom(Name *string) UserPoolClientIdentityProviderstatic#
Specify a provider not yet supported by the CDK.
1 parameter

Parameters

  • namenamenamenameName — name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.