@resistdesign/voltra
    Preparing search index...

    Type Alias AddAuthConfigWithUserPoolDomain

    AddAuthConfigWithUserPoolDomain: AddAuthConfigBase & {
        callbackUrls: any[];
        domainNameParameterName: string;
        enableUserPoolDomain?: true;
        hostedZoneIdParameterName: string;
        logoutUrls: any[];
        mainCDNCloudFrontId: string;
        sslCertificateId: string;
        supportedIdentityProviders?: any[];
    }

    Configuration for adding auth resources including a user pool domain with callback and logout URLs.

    Type Declaration

    • callbackUrls: any[]

      OAuth callback URLs for Hosted UI/federated redirect flows.

    • domainNameParameterName: string

      Parameter name for the base domain used for the auth subdomain.

    • OptionalenableUserPoolDomain?: true

      Enable Cognito Hosted UI/OAuth redirect mode by creating a custom user pool domain plus Route53 records.

      When enabled, the generated user pool client uses OAuth flows (code, implicit) and supports callback/logout URL configuration.

      Defaults to true. Set false to opt out of Hosted UI resources and use SDK/API-based sign-in flows only.

    • hostedZoneIdParameterName: string

      Parameter name for the Route53 hosted zone id that owns domainName.

    • logoutUrls: any[]

      OAuth logout redirect URLs for Hosted UI sign-out.

    • mainCDNCloudFrontId: string

      CloudFront distribution resource id used as the base-domain alias target.

    • sslCertificateId: string

      ACM certificate resource id (in us-east-1) for the Cognito custom domain.

    • OptionalsupportedIdentityProviders?: any[]

      Supported identity providers for Hosted UI/OAuth flows.

    Settings

    Member Visibility