Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. getUserPoolDomain

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.getUserPoolDomain

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::UserPoolDomain

    Using getUserPoolDomain

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserPoolDomain(args: GetUserPoolDomainArgs, opts?: InvokeOptions): Promise<GetUserPoolDomainResult>
function getUserPoolDomainOutput(args: GetUserPoolDomainOutputArgs, opts?: InvokeOptions): Output<GetUserPoolDomainResult>
    def get_user_pool_domain(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetUserPoolDomainResult
def get_user_pool_domain_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolDomainResult]
    func LookupUserPoolDomain(ctx *Context, args *LookupUserPoolDomainArgs, opts ...InvokeOption) (*LookupUserPoolDomainResult, error)
func LookupUserPoolDomainOutput(ctx *Context, args *LookupUserPoolDomainOutputArgs, opts ...InvokeOption) LookupUserPoolDomainResultOutput

    > Note: This function is named LookupUserPoolDomain in the Go SDK.

    public static class GetUserPoolDomain 
{
    public static Task<GetUserPoolDomainResult> InvokeAsync(GetUserPoolDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolDomainResult> Invoke(GetUserPoolDomainInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserPoolDomainResult> getUserPoolDomain(GetUserPoolDomainArgs args, InvokeOptions options)
public static Output<GetUserPoolDomainResult> getUserPoolDomain(GetUserPoolDomainArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cognito:getUserPoolDomain
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The resource ID.
    Id string
    The resource ID.
    id String
    The resource ID.
    id string
    The resource ID.
    id str
    The resource ID.
    id String
    The resource ID.

    getUserPoolDomain Result

    The following output properties are available:

    CloudFrontDistribution string
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CustomDomainConfig Pulumi.AwsNative.Cognito.Outputs.UserPoolDomainCustomDomainConfigType

    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

    When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

    Id string
    The resource ID.
    ManagedLoginVersion int
    A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login .
    CloudFrontDistribution string
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CustomDomainConfig UserPoolDomainCustomDomainConfigType

    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

    When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

    Id string
    The resource ID.
    ManagedLoginVersion int
    A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login .
    cloudFrontDistribution String
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    customDomainConfig UserPoolDomainCustomDomainConfigType

    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

    When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

    id String
    The resource ID.
    managedLoginVersion Integer
    A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login .
    cloudFrontDistribution string
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    customDomainConfig UserPoolDomainCustomDomainConfigType

    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

    When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

    id string
    The resource ID.
    managedLoginVersion number
    A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login .
    cloud_front_distribution str
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    custom_domain_config UserPoolDomainCustomDomainConfigType

    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

    When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

    id str
    The resource ID.
    managed_login_version int
    A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login .
    cloudFrontDistribution String
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    customDomainConfig Property Map

    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

    When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

    id String
    The resource ID.
    managedLoginVersion Number
    A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login .

    Supporting Types

    UserPoolDomainCustomDomainConfigType

    CertificateArn string
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    CertificateArn string
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    certificateArn String
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    certificateArn string
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    certificate_arn str
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
    certificateArn String
    The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.25.0 published on Monday, Feb 3, 2025 by Pulumi
    pulumi/pulumi-aws-native