Package software.amazon.awscdk.services.elasticloadbalancingv2.actions

Class AuthenticateCognitoActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<AuthenticateCognitoActionProps>

Enclosing interface:

AuthenticateCognitoActionProps

@Stability(Stable)
public static final class AuthenticateCognitoActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<AuthenticateCognitoActionProps>

A builder for AuthenticateCognitoActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthenticateCognitoActionProps.Builder	allowHttpsOutbound(Boolean allowHttpsOutbound)	Sets the value of AuthenticateCognitoActionProps.getAllowHttpsOutbound()
AuthenticateCognitoActionProps.Builder	authenticationRequestExtraParams(Map<String,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(String scope)	Sets the value of AuthenticateCognitoActionProps.getScope()
AuthenticateCognitoActionProps.Builder	sessionCookieName(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 Details

Builder

public Builder()

Method Details

next

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
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

allowHttpsOutbound

@Stability(Stable)
public AuthenticateCognitoActionProps.Builder allowHttpsOutbound(Boolean allowHttpsOutbound)

Sets the value of AuthenticateCognitoActionProps.getAllowHttpsOutbound()

Parameters:

allowHttpsOutbound - Allow HTTPS outbound traffic to communicate with the IdP. Set this property to false if the IP address used for the IdP endpoint is identifiable and you want to control outbound traffic. Then allow HTTPS outbound traffic to the IdP's IP address using the listener's connections property.

Returns:

this

authenticationRequestExtraParams

@Stability(Stable)
public AuthenticateCognitoActionProps.Builder authenticationRequestExtraParams(Map<String,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

@Stability(Stable)
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

@Stability(Stable)
public AuthenticateCognitoActionProps.Builder scope(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

@Stability(Stable)
public AuthenticateCognitoActionProps.Builder sessionCookieName(String sessionCookieName)

Sets the value of AuthenticateCognitoActionProps.getSessionCookieName()

Parameters:

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

Returns:

this

sessionTimeout

@Stability(Stable)
public AuthenticateCognitoActionProps.Builder sessionTimeout(Duration sessionTimeout)

Sets the value of AuthenticateCognitoActionProps.getSessionTimeout()

Parameters:

sessionTimeout - The maximum duration of the authentication session.

Returns:

this

build

@Stability(Stable)
public AuthenticateCognitoActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AuthenticateCognitoActionProps

Throws:

NullPointerException - if any required attribute was not provided