AWS CDK Reference

Appearance

v2.273.0

UserPoolAuthenticationProvider Class ​

Defines a User Pool Authentication Provider.

Source
aws-cognito-identitypool/lib/identitypool-user-pool-authentication-provider.ts
Type last changed
v2.186.0 · 27 Mar 2025

Example ​

ts
declare const identityPool: IdentityPool;
const userPool = new cognito.UserPool(this, 'Pool');
identityPool.addUserPoolAuthentication(new UserPoolAuthenticationProvider({
  userPool,
  disableServerSideTokenCheck: true,
}));
python
# identity_pool: IdentityPool

user_pool = cognito.UserPool(self, "Pool")
identity_pool.add_user_pool_authentication(UserPoolAuthenticationProvider(
    user_pool=user_pool,
    disable_server_side_token_check=True
))
java
IdentityPool identityPool;

UserPool userPool = new UserPool(this, "Pool");
identityPool.addUserPoolAuthentication(UserPoolAuthenticationProvider.Builder.create()
        .userPool(userPool)
        .disableServerSideTokenCheck(true)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
IdentityPool identityPool;

var userPool = new UserPool(this, "Pool");
identityPool.AddUserPoolAuthentication(new UserPoolAuthenticationProvider(new UserPoolAuthenticationProviderProps {
    UserPool = userPool,
    DisableServerSideTokenCheck = true
}));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var identityPool IdentityPool

userPool := cognito.NewUserPool(this, jsii.String("Pool"))
identityPool.AddUserPoolAuthentication(awscdk.NewUserPoolAuthenticationProvider(&UserPoolAuthenticationProviderProps{
	UserPool: UserPool,
	DisableServerSideTokenCheck: jsii.Boolean(true),
}))

Initializer ​

ts
new UserPoolAuthenticationProvider(props: UserPoolAuthenticationProviderProps)
python
UserPoolAuthenticationProvider(props: UserPoolAuthenticationProviderProps)
java
new UserPoolAuthenticationProvider(UserPoolAuthenticationProviderProps props)
csharp
new UserPoolAuthenticationProvider(UserPoolAuthenticationProviderProps props)
go
NewUserPoolAuthenticationProvider(Props UserPoolAuthenticationProviderProps)

Methods ​

bind(scope: Construct, identityPool: IIdentityPool, _options?: UserPoolAuthenticationProviderBindOptions): UserPoolAuthenticationProviderBindConfigdef bind(self, scope: Construct, identity_pool: IIdentityPool, _options: typing.Optional[UserPoolAuthenticationProviderBindOptions] = None) -> UserPoolAuthenticationProviderBindConfigpublic UserPoolAuthenticationProviderBindConfig bind(Construct scope, IIdentityPool identityPool, UserPoolAuthenticationProviderBindOptions _options)public UserPoolAuthenticationProviderBindConfig Bind(Construct scope, IIdentityPool identityPool, UserPoolAuthenticationProviderBindOptions? _options = null)func Bind(Scope Construct, IdentityPool IIdentityPool, _options UserPoolAuthenticationProviderBindOptions) UserPoolAuthenticationProviderBindConfig#
The method called when a given User Pool Authentication Provider is added (for the first time) to an Identity Pool.