AuthenticateCognitoAction.Builder

java.lang.Object
- software.amazon.awscdk.services.elasticloadbalancingv2.actions.AuthenticateCognitoAction.Builder

Enclosing class:

AuthenticateCognitoAction
```
public static final class AuthenticateCognitoAction.Builder
extends java.lang.Object
```
A fluent builder for AuthenticateCognitoAction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class AuthenticateCognitoAction.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

next

userPool

userPoolClient

userPoolDomain

authenticationRequestExtraParams

onUnauthenticatedRequest

scope

sessionCookieName

sessionTimeout

build