Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. cognito
  5. UserPoolDomain
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

aws.cognito.UserPoolDomain

Explore with Pulumi AI

aws logo
AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a Cognito User Pool Domain resource.

    Example Usage

    Amazon Cognito domain

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.cognito.UserPool("example", {name: "example-pool"});
const main = new aws.cognito.UserPoolDomain("main", {
    domain: "example-domain",
    userPoolId: example.id,
});

    import pulumi
import pulumi_aws as aws

example = aws.cognito.UserPool("example", name="example-pool")
main = aws.cognito.UserPoolDomain("main",
    domain="example-domain",
    user_pool_id=example.id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
			Name: pulumi.String("example-pool"),
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewUserPoolDomain(ctx, "main", &cognito.UserPoolDomainArgs{
			Domain:     pulumi.String("example-domain"),
			UserPoolId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Cognito.UserPool("example", new()
    {
        Name = "example-pool",
    });

    var main = new Aws.Cognito.UserPoolDomain("main", new()
    {
        Domain = "example-domain",
        UserPoolId = example.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.UserPool;
import com.pulumi.aws.cognito.UserPoolArgs;
import com.pulumi.aws.cognito.UserPoolDomain;
import com.pulumi.aws.cognito.UserPoolDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UserPool("example", UserPoolArgs.builder()
            .name("example-pool")
            .build());

        var main = new UserPoolDomain("main", UserPoolDomainArgs.builder()
            .domain("example-domain")
            .userPoolId(example.id())
            .build());

    }
}

    resources:
  main:
    type: aws:cognito:UserPoolDomain
    properties:
      domain: example-domain
      userPoolId: ${example.id}
  example:
    type: aws:cognito:UserPool
    properties:
      name: example-pool

    Custom Cognito domain

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleUserPool = new aws.cognito.UserPool("example", {name: "example-pool"});
const main = new aws.cognito.UserPoolDomain("main", {
    domain: "auth.example.com",
    certificateArn: cert.arn,
    userPoolId: exampleUserPool.id,
});
const example = aws.route53.getZone({
    name: "example.com",
});
const auth_cognito_A = new aws.route53.Record("auth-cognito-A", {
    name: main.domain,
    type: aws.route53.RecordType.A,
    zoneId: example.then(example => example.zoneId),
    aliases: [{
        evaluateTargetHealth: false,
        name: main.cloudfrontDistribution,
        zoneId: main.cloudfrontDistributionZoneId,
    }],
});

    import pulumi
import pulumi_aws as aws

example_user_pool = aws.cognito.UserPool("example", name="example-pool")
main = aws.cognito.UserPoolDomain("main",
    domain="auth.example.com",
    certificate_arn=cert["arn"],
    user_pool_id=example_user_pool.id)
example = aws.route53.get_zone(name="example.com")
auth_cognito__a = aws.route53.Record("auth-cognito-A",
    name=main.domain,
    type=aws.route53.RecordType.A,
    zone_id=example.zone_id,
    aliases=[{
        "evaluate_target_health": False,
        "name": main.cloudfront_distribution,
        "zone_id": main.cloudfront_distribution_zone_id,
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cognito"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleUserPool, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
			Name: pulumi.String("example-pool"),
		})
		if err != nil {
			return err
		}
		main, err := cognito.NewUserPoolDomain(ctx, "main", &cognito.UserPoolDomainArgs{
			Domain:         pulumi.String("auth.example.com"),
			CertificateArn: pulumi.Any(cert.Arn),
			UserPoolId:     exampleUserPool.ID(),
		})
		if err != nil {
			return err
		}
		example, err := route53.LookupZone(ctx, &route53.LookupZoneArgs{
			Name: pulumi.StringRef("example.com"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = route53.NewRecord(ctx, "auth-cognito-A", &route53.RecordArgs{
			Name:   main.Domain,
			Type:   pulumi.String(route53.RecordTypeA),
			ZoneId: pulumi.String(example.ZoneId),
			Aliases: route53.RecordAliasArray{
				&route53.RecordAliasArgs{
					EvaluateTargetHealth: pulumi.Bool(false),
					Name:                 main.CloudfrontDistribution,
					ZoneId:               main.CloudfrontDistributionZoneId,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleUserPool = new Aws.Cognito.UserPool("example", new()
    {
        Name = "example-pool",
    });

    var main = new Aws.Cognito.UserPoolDomain("main", new()
    {
        Domain = "auth.example.com",
        CertificateArn = cert.Arn,
        UserPoolId = exampleUserPool.Id,
    });

    var example = Aws.Route53.GetZone.Invoke(new()
    {
        Name = "example.com",
    });

    var auth_cognito_A = new Aws.Route53.Record("auth-cognito-A", new()
    {
        Name = main.Domain,
        Type = Aws.Route53.RecordType.A,
        ZoneId = example.Apply(getZoneResult => getZoneResult.ZoneId),
        Aliases = new[]
        {
            new Aws.Route53.Inputs.RecordAliasArgs
            {
                EvaluateTargetHealth = false,
                Name = main.CloudfrontDistribution,
                ZoneId = main.CloudfrontDistributionZoneId,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cognito.UserPool;
import com.pulumi.aws.cognito.UserPoolArgs;
import com.pulumi.aws.cognito.UserPoolDomain;
import com.pulumi.aws.cognito.UserPoolDomainArgs;
import com.pulumi.aws.route53.Route53Functions;
import com.pulumi.aws.route53.inputs.GetZoneArgs;
import com.pulumi.aws.route53.Record;
import com.pulumi.aws.route53.RecordArgs;
import com.pulumi.aws.route53.inputs.RecordAliasArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleUserPool = new UserPool("exampleUserPool", UserPoolArgs.builder()
            .name("example-pool")
            .build());

        var main = new UserPoolDomain("main", UserPoolDomainArgs.builder()
            .domain("auth.example.com")
            .certificateArn(cert.arn())
            .userPoolId(exampleUserPool.id())
            .build());

        final var example = Route53Functions.getZone(GetZoneArgs.builder()
            .name("example.com")
            .build());

        var auth_cognito_A = new Record("auth-cognito-A", RecordArgs.builder()
            .name(main.domain())
            .type("A")
            .zoneId(example.applyValue(getZoneResult -> getZoneResult.zoneId()))
            .aliases(RecordAliasArgs.builder()
                .evaluateTargetHealth(false)
                .name(main.cloudfrontDistribution())
                .zoneId(main.cloudfrontDistributionZoneId())
                .build())
            .build());

    }
}

    resources:
  main:
    type: aws:cognito:UserPoolDomain
    properties:
      domain: auth.example.com
      certificateArn: ${cert.arn}
      userPoolId: ${exampleUserPool.id}
  exampleUserPool:
    type: aws:cognito:UserPool
    name: example
    properties:
      name: example-pool
  auth-cognito-A:
    type: aws:route53:Record
    properties:
      name: ${main.domain}
      type: A
      zoneId: ${example.zoneId}
      aliases:
        - evaluateTargetHealth: false
          name: ${main.cloudfrontDistribution}
          zoneId: ${main.cloudfrontDistributionZoneId}
variables:
  example:
    fn::invoke:
      function: aws:route53:getZone
      arguments:
        name: example.com

    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,
                   certificate_arn: Optional[str] = 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: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userPoolDomainResource = new Aws.Cognito.UserPoolDomain("userPoolDomainResource", new()
{
    Domain = "string",
    UserPoolId = "string",
    CertificateArn = "string",
});

    example, err := cognito.NewUserPoolDomain(ctx, "userPoolDomainResource", &cognito.UserPoolDomainArgs{
	Domain:         pulumi.String("string"),
	UserPoolId:     pulumi.String("string"),
	CertificateArn: pulumi.String("string"),
})

    var userPoolDomainResource = new UserPoolDomain("userPoolDomainResource", UserPoolDomainArgs.builder()
    .domain("string")
    .userPoolId("string")
    .certificateArn("string")
    .build());

    user_pool_domain_resource = aws.cognito.UserPoolDomain("userPoolDomainResource",
    domain="string",
    user_pool_id="string",
    certificate_arn="string")

    const userPoolDomainResource = new aws.cognito.UserPoolDomain("userPoolDomainResource", {
    domain: "string",
    userPoolId: "string",
    certificateArn: "string",
});

    type: aws:cognito:UserPoolDomain
properties:
    certificateArn: string
    domain: string
    userPoolId: string

    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
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    UserPoolId string
    The user pool ID.
    CertificateArn string
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    Domain string
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    UserPoolId string
    The user pool ID.
    CertificateArn string
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    domain String
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    userPoolId String
    The user pool ID.
    certificateArn String
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    domain string
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    userPoolId string
    The user pool ID.
    certificateArn string
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    domain str
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    user_pool_id str
    The user pool ID.
    certificate_arn str
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    domain String
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    userPoolId String
    The user pool ID.
    certificateArn String
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.

    Outputs

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

    AwsAccountId string
    The AWS account ID for the user pool owner.
    CloudfrontDistribution string
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CloudfrontDistributionArn string
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    CloudfrontDistributionZoneId string
    The Route 53 hosted zone ID of the CloudFront distribution.
    Id string
    The provider-assigned unique ID for this managed resource.
    S3Bucket string
    The S3 bucket where the static files for this domain are stored.
    Version string
    The app version.
    AwsAccountId string
    The AWS account ID for the user pool owner.
    CloudfrontDistribution string
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CloudfrontDistributionArn string
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    CloudfrontDistributionZoneId string
    The Route 53 hosted zone ID of the CloudFront distribution.
    Id string
    The provider-assigned unique ID for this managed resource.
    S3Bucket string
    The S3 bucket where the static files for this domain are stored.
    Version string
    The app version.
    awsAccountId String
    The AWS account ID for the user pool owner.
    cloudfrontDistribution String
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfrontDistributionArn String
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfrontDistributionZoneId String
    The Route 53 hosted zone ID of the CloudFront distribution.
    id String
    The provider-assigned unique ID for this managed resource.
    s3Bucket String
    The S3 bucket where the static files for this domain are stored.
    version String
    The app version.
    awsAccountId string
    The AWS account ID for the user pool owner.
    cloudfrontDistribution string
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfrontDistributionArn string
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfrontDistributionZoneId string
    The Route 53 hosted zone ID of the CloudFront distribution.
    id string
    The provider-assigned unique ID for this managed resource.
    s3Bucket string
    The S3 bucket where the static files for this domain are stored.
    version string
    The app version.
    aws_account_id str
    The AWS account ID for the user pool owner.
    cloudfront_distribution str
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfront_distribution_arn str
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfront_distribution_zone_id str
    The Route 53 hosted zone ID of the CloudFront distribution.
    id str
    The provider-assigned unique ID for this managed resource.
    s3_bucket str
    The S3 bucket where the static files for this domain are stored.
    version str
    The app version.
    awsAccountId String
    The AWS account ID for the user pool owner.
    cloudfrontDistribution String
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfrontDistributionArn String
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfrontDistributionZoneId String
    The Route 53 hosted zone ID of the CloudFront distribution.
    id String
    The provider-assigned unique ID for this managed resource.
    s3Bucket String
    The S3 bucket where the static files for this domain are stored.
    version String
    The app version.

    Look up Existing UserPoolDomain Resource

    Get an existing UserPoolDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserPoolDomainState, opts?: CustomResourceOptions): UserPoolDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_account_id: Optional[str] = None,
        certificate_arn: Optional[str] = None,
        cloudfront_distribution: Optional[str] = None,
        cloudfront_distribution_arn: Optional[str] = None,
        cloudfront_distribution_zone_id: Optional[str] = None,
        domain: Optional[str] = None,
        s3_bucket: Optional[str] = None,
        user_pool_id: Optional[str] = None,
        version: Optional[str] = None) -> UserPoolDomain
    func GetUserPoolDomain(ctx *Context, name string, id IDInput, state *UserPoolDomainState, opts ...ResourceOption) (*UserPoolDomain, error)
    public static UserPoolDomain Get(string name, Input<string> id, UserPoolDomainState? state, CustomResourceOptions? opts = null)
    public static UserPoolDomain get(String name, Output<String> id, UserPoolDomainState state, CustomResourceOptions options)
    resources:  _:    type: aws:cognito:UserPoolDomain    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AwsAccountId string
    The AWS account ID for the user pool owner.
    CertificateArn string
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    CloudfrontDistribution string
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CloudfrontDistributionArn string
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    CloudfrontDistributionZoneId string
    The Route 53 hosted zone ID of the CloudFront distribution.
    Domain string
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    S3Bucket string
    The S3 bucket where the static files for this domain are stored.
    UserPoolId string
    The user pool ID.
    Version string
    The app version.
    AwsAccountId string
    The AWS account ID for the user pool owner.
    CertificateArn string
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    CloudfrontDistribution string
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    CloudfrontDistributionArn string
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    CloudfrontDistributionZoneId string
    The Route 53 hosted zone ID of the CloudFront distribution.
    Domain string
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    S3Bucket string
    The S3 bucket where the static files for this domain are stored.
    UserPoolId string
    The user pool ID.
    Version string
    The app version.
    awsAccountId String
    The AWS account ID for the user pool owner.
    certificateArn String
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    cloudfrontDistribution String
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfrontDistributionArn String
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfrontDistributionZoneId String
    The Route 53 hosted zone ID of the CloudFront distribution.
    domain String
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    s3Bucket String
    The S3 bucket where the static files for this domain are stored.
    userPoolId String
    The user pool ID.
    version String
    The app version.
    awsAccountId string
    The AWS account ID for the user pool owner.
    certificateArn string
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    cloudfrontDistribution string
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfrontDistributionArn string
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfrontDistributionZoneId string
    The Route 53 hosted zone ID of the CloudFront distribution.
    domain string
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    s3Bucket string
    The S3 bucket where the static files for this domain are stored.
    userPoolId string
    The user pool ID.
    version string
    The app version.
    aws_account_id str
    The AWS account ID for the user pool owner.
    certificate_arn str
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    cloudfront_distribution str
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfront_distribution_arn str
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfront_distribution_zone_id str
    The Route 53 hosted zone ID of the CloudFront distribution.
    domain str
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    s3_bucket str
    The S3 bucket where the static files for this domain are stored.
    user_pool_id str
    The user pool ID.
    version str
    The app version.
    awsAccountId String
    The AWS account ID for the user pool owner.
    certificateArn String
    The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
    cloudfrontDistribution String
    The Amazon CloudFront endpoint (e.g. dpp0gtxikpq3y.cloudfront.net) that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    cloudfrontDistributionArn String
    The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record
    cloudfrontDistributionZoneId String
    The Route 53 hosted zone ID of the CloudFront distribution.
    domain String
    For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.
    s3Bucket String
    The S3 bucket where the static files for this domain are stored.
    userPoolId String
    The user pool ID.
    version String
    The app version.

    Import

    Using pulumi import, import Cognito User Pool Domains using the domain. For example:

    $ pulumi import aws:cognito/userPoolDomain:UserPoolDomain main auth.example.org

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-aws