Package 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.103.1 (build bef2dea)",
           date="2024-10-25T14:21:12.533Z")
@Stability(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	Description
static final class	SignInUrlOptions.Builder	A builder for SignInUrlOptions
static final class	SignInUrlOptions.Jsii$Proxy	An implementation for SignInUrlOptions

Method Summary

Modifier and Type	Method	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 Details

getRedirectUri

@Stability(Stable)
@NotNull
String getRedirectUri()

Where to redirect to after sign in.

getSignInPath

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

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

Default: '/login'

builder

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

Returns:

a SignInUrlOptions.Builder of SignInUrlOptions