software.amazon.awscdk.services.cognito

Interface SignInUrlOptions

All Superinterfaces:

BaseUrlOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SignInUrlOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.600Z")
 @Stability(value=Stable)
public interface SignInUrlOptions
extends software.amazon.jsii.JsiiSerializable, BaseUrlOptions

Options to customize the behaviour of `signInUrl()`.

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	Interface and Description
static class	SignInUrlOptions.Builder A builder for SignInUrlOptions
static class	SignInUrlOptions.Jsii$Proxy An implementation for SignInUrlOptions

Method Summary

Modifier and Type	Method and Description
static SignInUrlOptions.Builder	builder()
String	getRedirectUri() Where to redirect to after sign in.
default String	getSignInPath() The path in the URI where the sign-in page is located.

Methods inherited from interface software.amazon.awscdk.services.cognito.BaseUrlOptions

getFips

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRedirectUri

@Stability(value=Stable)
 @NotNull
String getRedirectUri()

Where to redirect to after sign in.

getSignInPath

@Stability(value=Stable)
 @Nullable
default String getSignInPath()

The path in the URI where the sign-in page is located.

Default: '/login'

builder

@Stability(value=Stable)
static SignInUrlOptions.Builder builder()

Specified by:

builder in interface BaseUrlOptions

Returns:

a SignInUrlOptions.Builder of SignInUrlOptions