software.amazon.awscdk.services.cognito

Class UserPoolDomain

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cognito.UserPoolDomain

All Implemented Interfaces:

IConstruct, IDependable, IResource, IUserPoolDomain

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:24.574Z")
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 and Description
static class	UserPoolDomain.Builder A fluent builder for UserPoolDomain.

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

IUserPoolDomain.Jsii$Default, IUserPoolDomain.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	baseUrl() The URL to the hosted UI associated with this domain.
java.lang.String	baseUrl(BaseUrlOptions options) The URL to the hosted UI associated with this domain.
static IUserPoolDomain	fromDomainName(software.constructs.Construct scope, java.lang.String id, java.lang.String userPoolDomainName) Import a UserPoolDomain given its domain name.
java.lang.String	getCloudFrontDomainName() The domain name of the CloudFront distribution associated with the user pool domain.
java.lang.String	getDomainName() The domain that was specified to be created.
java.lang.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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

UserPoolDomain

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

UserPoolDomain

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

UserPoolDomain

public UserPoolDomain(software.constructs.Construct scope,
                      java.lang.String id,
                      UserPoolDomainProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDomainName

public static IUserPoolDomain fromDomainName(software.constructs.Construct scope,
                                             java.lang.String id,
                                             java.lang.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

public java.lang.String baseUrl(BaseUrlOptions options)

The URL to the hosted UI associated with this domain.

Parameters:

options - options to customize baseUrl.

baseUrl

public java.lang.String baseUrl()

The URL to the hosted UI associated with this domain.

signInUrl

public java.lang.String signInUrl(UserPoolClient client,
                                  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

public java.lang.String getCloudFrontDomainName()

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

getDomainName

public java.lang.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