software.amazon.awscdk.services.elasticloadbalancingv2.actions

Class AuthenticateCognitoAction.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.actions.AuthenticateCognitoAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AuthenticateCognitoAction>

Enclosing class:

AuthenticateCognitoAction

@Stability(value=Experimental)
public static final class AuthenticateCognitoAction.Builder
extends Object
implements software.amazon.jsii.Builder<AuthenticateCognitoAction>

(experimental) A fluent builder for AuthenticateCognitoAction.

Method Summary

Modifier and Type	Method and Description
AuthenticateCognitoAction.Builder	authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams) (experimental) 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) (experimental) What action to execute next.
AuthenticateCognitoAction.Builder	onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest) (experimental) The behavior if the user is not authenticated.
AuthenticateCognitoAction.Builder	scope(String scope) (experimental) The set of user claims to be requested from the IdP.
AuthenticateCognitoAction.Builder	sessionCookieName(String sessionCookieName) (experimental) The name of the cookie used to maintain session information.
AuthenticateCognitoAction.Builder	sessionTimeout(Duration sessionTimeout) (experimental) The maximum duration of the authentication session.
AuthenticateCognitoAction.Builder	userPool(IUserPool userPool) (experimental) The Amazon Cognito user pool.
AuthenticateCognitoAction.Builder	userPoolClient(IUserPoolClient userPoolClient) (experimental) The Amazon Cognito user pool client.
AuthenticateCognitoAction.Builder	userPoolDomain(IUserPoolDomain userPoolDomain) (experimental) 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

@Stability(value=Experimental)
public static AuthenticateCognitoAction.Builder create()

Returns:

a new instance of AuthenticateCognitoAction.Builder.

next

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder next(ListenerAction next)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder userPool(IUserPool userPool)

(experimental) The Amazon Cognito user pool.

Parameters:

userPool - The Amazon Cognito user pool. This parameter is required.

Returns:

this

userPoolClient

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder userPoolClient(IUserPoolClient userPoolClient)

(experimental) The Amazon Cognito user pool client.

Parameters:

userPoolClient - The Amazon Cognito user pool client. This parameter is required.

Returns:

this

userPoolDomain

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder userPoolDomain(IUserPoolDomain userPoolDomain)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder scope(String scope)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder sessionCookieName(String sessionCookieName)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction.Builder sessionTimeout(Duration sessionTimeout)

(experimental) 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

@Stability(value=Experimental)
public AuthenticateCognitoAction build()

Specified by:

build in interface software.amazon.jsii.Builder<AuthenticateCognitoAction>