aws-cdk-lib/aws-cognito-identitypool/lib/identitypool-user-pool-authentication-provider.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Construct } from 'constructs';
import { IIdentityPool } from './identitypool';
import { IUserPool, IUserPoolClient } from '../../aws-cognito';
/**
 * Represents the concept of a User Pool Authentication Provider.
 * You use user pool authentication providers to configure User Pools
 * and User Pool Clients for use with Identity Pools
 */
export interface IUserPoolAuthenticationProvider {
    /**
     * The method called when a given User Pool Authentication Provider is added
     * (for the first time) to an Identity Pool.
     */
    bind(scope: Construct, identityPool: IIdentityPool, options?: UserPoolAuthenticationProviderBindOptions): UserPoolAuthenticationProviderBindConfig;
}
/**
 * Props for the User Pool Authentication Provider
 */
export interface UserPoolAuthenticationProviderProps {
    /**
     * The User Pool of the Associated Identity Providers
     */
    readonly userPool: IUserPool;
    /**
     * The User Pool Client for the provided User Pool
     * @default - A default user pool client will be added to User Pool
     */
    readonly userPoolClient?: IUserPoolClient;
    /**
     * Setting this to true turns off identity pool checks for this user pool to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user
     * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html
     * @default false
     */
    readonly disableServerSideTokenCheck?: boolean;
}
/**
 * Represents UserPoolAuthenticationProvider Bind Options
 */
export interface UserPoolAuthenticationProviderBindOptions {
}
/**
 * Represents a UserPoolAuthenticationProvider Bind Configuration
 */
export interface UserPoolAuthenticationProviderBindConfig {
    /**
     * Client Id of the Associated User Pool Client
     */
    readonly clientId: string;
    /**
     * The identity providers associated with the UserPool
     */
    readonly providerName: string;
    /**
     * Whether to enable the identity pool's server side token check
     */
    readonly serverSideTokenCheck: boolean;
}
/**
 * Defines a User Pool Authentication Provider
 */
export declare class UserPoolAuthenticationProvider implements IUserPoolAuthenticationProvider {
    /**
     * The User Pool of the Associated Identity Providers
     */
    private userPool;
    /**
     * The User Pool Client for the provided User Pool
     */
    private userPoolClient;
    /**
     * Whether to disable the pool's default server side token check
     */
    private disableServerSideTokenCheck;
    constructor(props: UserPoolAuthenticationProviderProps);
    bind(scope: Construct, identityPool: IIdentityPool, _options?: UserPoolAuthenticationProviderBindOptions): UserPoolAuthenticationProviderBindConfig;
}