software.amazon.awscdk.services.elasticloadbalancingv2.actions

Class AuthenticateCognitoActionProps.Builder

java.lang.Object

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

Enclosing interface:

AuthenticateCognitoActionProps

public static final class AuthenticateCognitoActionProps.Builder
extends java.lang.Object

A builder for AuthenticateCognitoActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AuthenticateCognitoActionProps.Builder	authenticationRequestExtraParams(java.util.Map<java.lang.String,java.lang.String> authenticationRequestExtraParams) Sets the value of AuthenticateCognitoActionProps.getAuthenticationRequestExtraParams()
AuthenticateCognitoActionProps	build() Builds the configured instance.
AuthenticateCognitoActionProps.Builder	next(ListenerAction next) Sets the value of AuthenticateCognitoActionProps.getNext()
AuthenticateCognitoActionProps.Builder	onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest) Sets the value of AuthenticateCognitoActionProps.getOnUnauthenticatedRequest()
AuthenticateCognitoActionProps.Builder	scope(java.lang.String scope) Sets the value of AuthenticateCognitoActionProps.getScope()
AuthenticateCognitoActionProps.Builder	sessionCookieName(java.lang.String sessionCookieName) Sets the value of AuthenticateCognitoActionProps.getSessionCookieName()
AuthenticateCognitoActionProps.Builder	sessionTimeout(Duration sessionTimeout) Sets the value of AuthenticateCognitoActionProps.getSessionTimeout()
AuthenticateCognitoActionProps.Builder	userPool(IUserPool userPool) Sets the value of AuthenticateCognitoActionProps.getUserPool()
AuthenticateCognitoActionProps.Builder	userPoolClient(IUserPoolClient userPoolClient) Sets the value of AuthenticateCognitoActionProps.getUserPoolClient()
AuthenticateCognitoActionProps.Builder	userPoolDomain(IUserPoolDomain userPoolDomain) Sets the value of AuthenticateCognitoActionProps.getUserPoolDomain()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

next

public AuthenticateCognitoActionProps.Builder next(ListenerAction next)

Sets the value of AuthenticateCognitoActionProps.getNext()

Parameters:

next - What action to execute next. This parameter is required. Multiple actions form a linked chain; the chain must always terminate in a (weighted)forward, fixedResponse or redirect action.

Returns:

this

userPool

public AuthenticateCognitoActionProps.Builder userPool(IUserPool userPool)

Sets the value of AuthenticateCognitoActionProps.getUserPool()

Parameters:

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

Returns:

this

userPoolClient

public AuthenticateCognitoActionProps.Builder userPoolClient(IUserPoolClient userPoolClient)

Sets the value of AuthenticateCognitoActionProps.getUserPoolClient()

Parameters:

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

Returns:

this

userPoolDomain

public AuthenticateCognitoActionProps.Builder userPoolDomain(IUserPoolDomain userPoolDomain)

Sets the value of AuthenticateCognitoActionProps.getUserPoolDomain()

Parameters:

userPoolDomain - The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. This parameter is required.

Returns:

this

authenticationRequestExtraParams

public AuthenticateCognitoActionProps.Builder authenticationRequestExtraParams(java.util.Map<java.lang.String,java.lang.String> authenticationRequestExtraParams)

Sets the value of AuthenticateCognitoActionProps.getAuthenticationRequestExtraParams()

Parameters:

authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

Returns:

this

onUnauthenticatedRequest

public AuthenticateCognitoActionProps.Builder onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)

Sets the value of AuthenticateCognitoActionProps.getOnUnauthenticatedRequest()

Parameters:

onUnauthenticatedRequest - The behavior if the user is not authenticated.

Returns:

this

scope

public AuthenticateCognitoActionProps.Builder scope(java.lang.String scope)

Sets the value of AuthenticateCognitoActionProps.getScope()

Parameters:

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.

Returns:

this

sessionCookieName

public AuthenticateCognitoActionProps.Builder sessionCookieName(java.lang.String sessionCookieName)

Sets the value of AuthenticateCognitoActionProps.getSessionCookieName()

Parameters:

sessionCookieName - The name of the cookie used to maintain session information.

Returns:

this

sessionTimeout

public AuthenticateCognitoActionProps.Builder sessionTimeout(Duration sessionTimeout)

Sets the value of AuthenticateCognitoActionProps.getSessionTimeout()

Parameters:

sessionTimeout - The maximum duration of the authentication session.

Returns:

this

build

public AuthenticateCognitoActionProps build()

Builds the configured instance.

Returns:

a new instance of AuthenticateCognitoActionProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided