@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)", date="2022-08-02T20:25:33.941Z") public class UserPoolDomain extends Resource implements IUserPoolDomain
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());
Modifier and Type | Class and Description |
---|---|
static class |
UserPoolDomain.Builder
A fluent builder for
UserPoolDomain . |
IUserPoolDomain.Jsii$Default, IUserPoolDomain.Jsii$Proxy
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) |
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.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected UserPoolDomain(software.amazon.jsii.JsiiObjectRef objRef)
protected UserPoolDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public UserPoolDomain(software.constructs.Construct scope, java.lang.String id, UserPoolDomainProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public static IUserPoolDomain fromDomainName(software.constructs.Construct scope, java.lang.String id, java.lang.String userPoolDomainName)
scope
- This parameter is required.id
- This parameter is required.userPoolDomainName
- This parameter is required.public java.lang.String baseUrl(BaseUrlOptions options)
options
- options to customize baseUrl.public java.lang.String baseUrl()
public java.lang.String signInUrl(UserPoolClient client, SignInUrlOptions options)
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.public java.lang.String getCloudFrontDomainName()
public java.lang.String getDomainName()
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.
getDomainName
in interface IUserPoolDomain