UserPoolDomain class
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)
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_cognito_userpooldomain" "main" {
domain = "example-domain"
user_pool_id = aws_cognito_userpool.example.id
}
resource "aws_cognito_userpool" "example" {
name = "example-pool"
}
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.ArrayList;
import java.util.Arrays;
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", {
aliases: [{
evaluateTargetHealth: false,
name: main.cloudfrontDistribution,
zoneId: main.cloudfrontDistributionZoneId,
}],
name: main.domain,
type: aws.route53.RecordType.A,
zoneId: example.then(example => example.zoneId),
});
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",
aliases=[{
"evaluate_target_health": False,
"name": main.cloudfront_distribution,
"zone_id": main.cloudfront_distribution_zone_id,
}],
name=main.domain,
type=aws.route53.RecordType.A,
zone_id=example.zone_id)
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()
{
Aliases = new[]
{
new Aws.Route53.Inputs.RecordAliasArgs
{
EvaluateTargetHealth = false,
Name = main.CloudfrontDistribution,
ZoneId = main.CloudfrontDistributionZoneId,
},
},
Name = main.Domain,
Type = Aws.Route53.RecordType.A,
ZoneId = example.Apply(getZoneResult => getZoneResult.ZoneId),
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
"github.com/pulumi/pulumi-aws/sdk/v7/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().ToIDOutput().ToStringOutput(),
})
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{
Aliases: route53.RecordAliasArray{
&route53.RecordAliasArgs{
EvaluateTargetHealth: pulumi.Bool(false),
Name: main.CloudfrontDistribution,
ZoneId: main.CloudfrontDistributionZoneId,
},
},
Name: main.Domain,
Type: pulumi.String(route53.RecordTypeA),
ZoneId: pulumi.String(example.ZoneId),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_route53_getzone" "example" {
name = "example.com"
}
resource "aws_cognito_userpooldomain" "main" {
domain = "auth.example.com"
certificate_arn = cert.arn
user_pool_id = aws_cognito_userpool.example.id
}
resource "aws_cognito_userpool" "example" {
name = "example-pool"
}
resource "aws_route53_record" "auth-cognito-A" {
aliases {
evaluate_target_health = false
name = aws_cognito_userpooldomain.main.cloudfront_distribution
zone_id = aws_cognito_userpooldomain.main.cloudfront_distribution_zone_id
}
name = aws_cognito_userpooldomain.main.domain
type = "A"
zone_id = data.aws_route53_getzone.example.zone_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 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.ArrayList;
import java.util.Arrays;
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()
.aliases(RecordAliasArgs.builder()
.evaluateTargetHealth(false)
.name(main.cloudfrontDistribution())
.zoneId(main.cloudfrontDistributionZoneId())
.build())
.name(main.domain())
.type("A")
.zoneId(example.zoneId())
.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:
aliases:
- evaluateTargetHealth: false
name: ${main.cloudfrontDistribution}
zoneId: ${main.cloudfrontDistributionZoneId}
name: ${main.domain}
type: A
zoneId: ${example.zoneId}
variables:
example:
fn::invoke:
function: aws:route53:getZone
arguments:
name: example.com
Import
Using pulumi import, import Cognito User Pool Domains using the domain. For example:
$ pulumi import aws:cognito/userPoolDomain:UserPoolDomain main auth.example.org
Constructors
- UserPoolDomain(String name, {UserPoolDomainArgs? args, CustomResourceOptions? options})
-
Creates a new UserPoolDomain.
nameThe Pulumi resource name.argsArguments used to configure this UserPoolDomain. The set of arguments for UserPoolDomain.optionsResource options controlling this resource's behavior. - UserPoolDomain.reference(String urn)
- Creates a typed reference to an existing UserPoolDomain resource.
Properties
-
awsAccountId
↔ Output<
String> -
The AWS account ID for the user pool owner.
latefinal
-
certificateArn
↔ Output<
String?> -
The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
cloudfrontDistribution
↔ Output<
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.latefinal -
cloudfrontDistributionArn
↔ Output<
String> -
The URL of the CloudFront distribution. This is required to generate the ALIAS
aws.route53.Recordlatefinal -
cloudfrontDistributionZoneId
↔ Output<
String> -
The Route 53 hosted zone ID of the CloudFront distribution.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domain
↔ Output<
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.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
managedLoginVersion
↔ Output<
int> -
A version number that indicates the state of managed login for your domain. Valid values:
1for hosted UI (classic),2for the newer managed login with the branding designer.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
s3Bucket
↔ Output<
String> -
The S3 bucket where the static files for this domain are stored.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userPoolId
↔ Output<
String> -
The user pool ID.
latefinal
-
version
↔ Output<
String> -
The app version.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {UserPoolDomainState? state, CustomResourceOptions? options}) → UserPoolDomain -
Gets an existing UserPoolDomain resource's state with the given
nameandid.