pulumi-aws-kotlin/com.pulumi.aws.cognito.kotlin/UserPoolDomain

UserPoolDomain

class UserPoolDomain : KotlinCustomResource

Provides a Cognito User Pool Domain resource.

Example Usage

Amazon Cognito domain

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.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");
        var main = new UserPoolDomain("main", UserPoolDomainArgs.builder()
            .domain("example-domain")
            .userPoolId(example.id())
            .build());
    }
}

Custom Cognito domain

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.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");
        var main = new UserPoolDomain("main", UserPoolDomainArgs.builder()
            .domain("example-domain")
            .certificateArn(aws_acm_certificate.cert().arn())
            .userPoolId(exampleUserPool.id())
            .build());
        final var exampleZone = 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(exampleZone.applyValue(getZoneResult -> getZoneResult.zoneId()))
            .aliases(RecordAliasArgs.builder()
                .evaluateTargetHealth(false)
                .name(main.cloudfrontDistribution())
                .zoneId(main.cloudfrontDistributionZoneId())
                .build())
            .build());
    }
}

Import

Cognito User Pool Domains can be imported using the domain, e.g.,

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

Properties

awsAccountId

val awsAccountId: Output<String>

The AWS account ID for the user pool owner.

certificateArn

val certificateArn: Output<String>?

The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain.

cloudfrontDistribution

val 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.

cloudfrontDistributionArn

val cloudfrontDistributionArn: Output<String>

The URL of the CloudFront distribution. This is required to generate the ALIAS aws.route53.Record

cloudfrontDistributionZoneId

val cloudfrontDistributionZoneId: Output<String>

The Route 53 hosted zone ID of the CloudFront distribution.

domain

val 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.