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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.UserPoolDomain

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::UserPoolDomain

    Create UserPoolDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserPoolDomain(name: string, args: UserPoolDomainArgs, opts?: CustomResourceOptions);
    @overload
def UserPoolDomain(resource_name: str,
                   args: UserPoolDomainArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def UserPoolDomain(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain: Optional[str] = None,
                   user_pool_id: Optional[str] = None,
                   custom_domain_config: Optional[UserPoolDomainCustomDomainConfigTypeArgs] = None,
                   managed_login_version: Optional[int] = None)
    func NewUserPoolDomain(ctx *Context, name string, args UserPoolDomainArgs, opts ...ResourceOption) (*UserPoolDomain, error)
    public UserPoolDomain(string name, UserPoolDomainArgs args, CustomResourceOptions? opts = null)
    public UserPoolDomain(String name, UserPoolDomainArgs args)
public UserPoolDomain(String name, UserPoolDomainArgs args, CustomResourceOptions options)

    type: aws-native:cognito:UserPoolDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    UserPoolDomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserPoolDomain resource accepts the following input properties:

    Domain string
    The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
    UserPoolId string
    The ID of the user pool that is associated with the domain you're updating.
    CustomDomainConfig Pulumi.AwsNative.Cognito.Inputs.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.

    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 .
    Domain string
    The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
    UserPoolId string
    The ID of the user pool that is associated with the domain you're updating.
    CustomDomainConfig UserPoolDomainCustomDomainConfigTypeArgs

    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.

    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 .
    domain String
    The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
    userPoolId String
    The ID of the user pool that is associated with the domain you're updating.
    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.

    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 .
    domain string
    The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
    userPoolId string
    The ID of the user pool that is associated with the domain you're updating.
    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.

    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 .
    domain str
    The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
    user_pool_id str
    The ID of the user pool that is associated with the domain you're updating.
    custom_domain_config UserPoolDomainCustomDomainConfigTypeArgs

    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.

    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 .
    domain String
    The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com . For prefix domains, this is the prefix alone, such as myprefix .
    userPoolId String
    The ID of the user pool that is associated with the domain you're updating.
    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.

    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 .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPoolDomain resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    UserPoolDomainCustomDomainConfigType, UserPoolDomainCustomDomainConfigTypeArgs

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native