public static final class AuthenticateCognitoAction.Builder
extends java.lang.Object
AuthenticateCognitoAction
.Modifier and Type | Method and Description |
---|---|
AuthenticateCognitoAction.Builder |
authenticationRequestExtraParams(java.util.Map<java.lang.String,java.lang.String> authenticationRequestExtraParams)
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
|
AuthenticateCognitoAction |
build() |
static AuthenticateCognitoAction.Builder |
create() |
AuthenticateCognitoAction.Builder |
next(ListenerAction next)
What action to execute next.
|
AuthenticateCognitoAction.Builder |
onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)
The behavior if the user is not authenticated.
|
AuthenticateCognitoAction.Builder |
scope(java.lang.String scope)
The set of user claims to be requested from the IdP.
|
AuthenticateCognitoAction.Builder |
sessionCookieName(java.lang.String sessionCookieName)
The name of the cookie used to maintain session information.
|
AuthenticateCognitoAction.Builder |
sessionTimeout(Duration sessionTimeout)
The maximum duration of the authentication session.
|
AuthenticateCognitoAction.Builder |
userPool(IUserPool userPool)
The Amazon Cognito user pool.
|
AuthenticateCognitoAction.Builder |
userPoolClient(IUserPoolClient userPoolClient)
The Amazon Cognito user pool client.
|
AuthenticateCognitoAction.Builder |
userPoolDomain(IUserPoolDomain userPoolDomain)
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
|
public static AuthenticateCognitoAction.Builder create()
AuthenticateCognitoAction.Builder
.public AuthenticateCognitoAction.Builder next(ListenerAction next)
Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.
next
- What action to execute next. This parameter is required.this
public AuthenticateCognitoAction.Builder userPool(IUserPool userPool)
userPool
- The Amazon Cognito user pool. This parameter is required.this
public AuthenticateCognitoAction.Builder userPoolClient(IUserPoolClient userPoolClient)
userPoolClient
- The Amazon Cognito user pool client. This parameter is required.this
public AuthenticateCognitoAction.Builder userPoolDomain(IUserPoolDomain userPoolDomain)
userPoolDomain
- The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. This parameter is required.this
public AuthenticateCognitoAction.Builder authenticationRequestExtraParams(java.util.Map<java.lang.String,java.lang.String> authenticationRequestExtraParams)
Default: - No extra parameters
authenticationRequestExtraParams
- The query parameters (up to 10) to include in the redirect request to the authorization endpoint. This parameter is required.this
public AuthenticateCognitoAction.Builder onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)
Default: UnauthenticatedAction.AUTHENTICATE
onUnauthenticatedRequest
- The behavior if the user is not authenticated. This parameter is required.this
public AuthenticateCognitoAction.Builder scope(java.lang.String scope)
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
Default: "openid"
scope
- The set of user claims to be requested from the IdP. This parameter is required.this
public AuthenticateCognitoAction.Builder sessionCookieName(java.lang.String sessionCookieName)
Default: "AWSELBAuthSessionCookie"
sessionCookieName
- The name of the cookie used to maintain session information. This parameter is required.this
public AuthenticateCognitoAction.Builder sessionTimeout(Duration sessionTimeout)
Default: Duration.days(7)
sessionTimeout
- The maximum duration of the authentication session. This parameter is required.this
public AuthenticateCognitoAction build()