Package software.amazon.awscdk.services.cognito

Class UserPoolDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolDomain

All Implemented Interfaces:

IResource, IUserPoolDomain, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-10T21:56:48.948Z")
@Stability(Stable)
public class UserPoolDomain
extends Resource
implements IUserPoolDomain

Define a user pool domain.

Example:

 UserPool userpool = UserPool.Builder.create(this, "UserPool").build();
 UserPoolClient client = userpool.addClient("Client", UserPoolClientOptions.builder()
         // ...
         .oAuth(OAuthSettings.builder()
                 .flows(OAuthFlows.builder()
                         .implicitCodeGrant(true)
                         .build())
                 .callbackUrls(List.of("https://myapp.com/home", "https://myapp.com/users"))
                 .build())
         .build());
 UserPoolDomain domain = userpool.addDomain("Domain", UserPoolDomainOptions.builder().build());
 String signInUrl = domain.signInUrl(client, SignInUrlOptions.builder()
         .redirectUri("https://myapp.com/home")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserPoolDomain.Builder	A fluent builder for UserPoolDomain.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolDomain

IUserPoolDomain.Jsii$Default, IUserPoolDomain.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)
	UserPoolDomain(software.constructs.Construct scope, String id, UserPoolDomainProps props)

Method Summary

Modifier and Type	Method	Description
String	baseUrl()	The URL to the hosted UI associated with this domain.
String	baseUrl(BaseUrlOptions options)	The URL to the hosted UI associated with this domain.
static IUserPoolDomain	fromDomainName(software.constructs.Construct scope, String id, String userPoolDomainName)	Import a UserPoolDomain given its domain name.
String	getCloudFrontDomainName()	Deprecated. use cloudFrontEndpoint method instead.
String	getCloudFrontEndpoint()	The domain name of the CloudFront distribution associated with the user pool domain.
String	getDomainName()	The domain that was specified to be created.
String	signInUrl(UserPoolClient client, SignInUrlOptions options)	The URL to the sign in page in this domain using a specific UserPoolClient.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

UserPoolDomain

protected UserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolDomain

protected UserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolDomain

@Stability(Stable)
public UserPoolDomain(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 UserPoolDomainProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromDomainName

@Stability(Stable)
@NotNull
public static IUserPoolDomain fromDomainName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String userPoolDomainName)

Import a UserPoolDomain given its domain name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

userPoolDomainName - This parameter is required.

baseUrl

@Stability(Stable)
@NotNull
public String baseUrl(@Nullable
 BaseUrlOptions options)

The URL to the hosted UI associated with this domain.

Parameters:

options - options to customize baseUrl.

baseUrl

@Stability(Stable)
@NotNull
public String baseUrl()

The URL to the hosted UI associated with this domain.

signInUrl

@Stability(Stable)
@NotNull
public String signInUrl(@NotNull
 UserPoolClient client,
 @NotNull
 SignInUrlOptions options)

The URL to the sign in page in this domain using a specific UserPoolClient.

Parameters:

client - [disable-awslint:ref-via-interface] the user pool client that the UI will use to interact with the UserPool. This parameter is required.

options - options to customize signInUrl. This parameter is required.

getCloudFrontDomainName

@Stability(Deprecated)
@Deprecated
@NotNull
public String getCloudFrontDomainName()

Deprecated.

use cloudFrontEndpoint method instead.

(deprecated) The domain name of the CloudFront distribution associated with the user pool domain.

This method creates a custom resource internally to get the CloudFront domain name.

getCloudFrontEndpoint

@Stability(Stable)
@NotNull
public String getCloudFrontEndpoint()

The domain name of the CloudFront distribution associated with the user pool domain.

getDomainName

@Stability(Stable)
@NotNull
public String getDomainName()

The domain that was specified to be created.

If customDomain was selected, this holds the full domain name that was specified. If the cognitoDomain was used, it contains the prefix to the Cognito hosted domain.

Specified by:

getDomainName in interface IUserPoolDomain