Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnListenerRule.AuthenticateCognitoConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.AuthenticateCognitoConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnListenerRule.AuthenticateCognitoConfigProperty>

Enclosing interface:

CfnListenerRule.AuthenticateCognitoConfigProperty

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

A builder for CfnListenerRule.AuthenticateCognitoConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getAuthenticationRequestExtraParams()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	authenticationRequestExtraParams(IResolvable authenticationRequestExtraParams)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getAuthenticationRequestExtraParams()
CfnListenerRule.AuthenticateCognitoConfigProperty	build()	Builds the configured instance.
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	onUnauthenticatedRequest(String onUnauthenticatedRequest)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getOnUnauthenticatedRequest()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	scope(String scope)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getScope()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	sessionCookieName(String sessionCookieName)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getSessionCookieName()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	sessionTimeout(Number sessionTimeout)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getSessionTimeout()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	userPoolArn(String userPoolArn)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getUserPoolArn()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	userPoolClientId(String userPoolClientId)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getUserPoolClientId()
CfnListenerRule.AuthenticateCognitoConfigProperty.Builder	userPoolDomain(String userPoolDomain)	Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.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

userPoolArn

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder userPoolArn(String userPoolArn)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getUserPoolArn()

Parameters:

userPoolArn - The Amazon Resource Name (ARN) of the Amazon Cognito user pool. This parameter is required.

Returns:

this

userPoolClientId

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder userPoolClientId(String userPoolClientId)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getUserPoolClientId()

Parameters:

userPoolClientId - The ID of the Amazon Cognito user pool client. This parameter is required.

Returns:

this

userPoolDomain

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder userPoolDomain(String userPoolDomain)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getUserPoolDomain()

Parameters:

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

Returns:

this

authenticationRequestExtraParams

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getAuthenticationRequestExtraParams()

Parameters:

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

Returns:

this

authenticationRequestExtraParams

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder authenticationRequestExtraParams(IResolvable authenticationRequestExtraParams)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.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 CfnListenerRule.AuthenticateCognitoConfigProperty.Builder onUnauthenticatedRequest(String onUnauthenticatedRequest)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getOnUnauthenticatedRequest()

Parameters:

onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values:.

• deny `` - Return an HTTP 401 Unauthorized error.
• allow `` - Allow the request to be forwarded to the target.
• authenticate `` - Redirect the request to the IdP authorization endpoint. This is the default value.

Returns:

this

scope

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder scope(String scope)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getScope()

Parameters:

scope - The set of user claims to be requested from the IdP. The default is openid . 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 CfnListenerRule.AuthenticateCognitoConfigProperty.Builder sessionCookieName(String sessionCookieName)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getSessionCookieName()

Parameters:

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

Returns:

this

sessionTimeout

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty.Builder sessionTimeout(Number sessionTimeout)

Sets the value of CfnListenerRule.AuthenticateCognitoConfigProperty.getSessionTimeout()

Parameters:

sessionTimeout - The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

Returns:

this

build

@Stability(Stable)
public CfnListenerRule.AuthenticateCognitoConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnListenerRule.AuthenticateCognitoConfigProperty>

Returns:

a new instance of CfnListenerRule.AuthenticateCognitoConfigProperty

Throws:

NullPointerException - if any required attribute was not provided