software.amazon.awssdk.services.elasticloadbalancingv2.model

Interface AuthenticateCognitoActionConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AuthenticateCognitoActionConfig.Builder,AuthenticateCognitoActionConfig>, SdkBuilder<AuthenticateCognitoActionConfig.Builder,AuthenticateCognitoActionConfig>, SdkPojo

Enclosing class:

AuthenticateCognitoActionConfig

public static interface AuthenticateCognitoActionConfig.Builder
extends SdkPojo, CopyableBuilder<AuthenticateCognitoActionConfig.Builder,AuthenticateCognitoActionConfig>

Method Summary

Modifier and Type	Method and Description
AuthenticateCognitoActionConfig.Builder	authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams) The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
AuthenticateCognitoActionConfig.Builder	onUnauthenticatedRequest(AuthenticateCognitoActionConditionalBehaviorEnum onUnauthenticatedRequest) The behavior if the user is not authenticated.
AuthenticateCognitoActionConfig.Builder	onUnauthenticatedRequest(String onUnauthenticatedRequest) The behavior if the user is not authenticated.
AuthenticateCognitoActionConfig.Builder	scope(String scope) The set of user claims to be requested from the IdP.
AuthenticateCognitoActionConfig.Builder	sessionCookieName(String sessionCookieName) The name of the cookie used to maintain session information.
AuthenticateCognitoActionConfig.Builder	sessionTimeout(Long sessionTimeout) The maximum duration of the authentication session, in seconds.
AuthenticateCognitoActionConfig.Builder	userPoolArn(String userPoolArn) The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
AuthenticateCognitoActionConfig.Builder	userPoolClientId(String userPoolClientId) The ID of the Amazon Cognito user pool client.
AuthenticateCognitoActionConfig.Builder	userPoolDomain(String userPoolDomain) The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

userPoolArn

AuthenticateCognitoActionConfig.Builder userPoolArn(String userPoolArn)

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

Parameters:

userPoolArn - The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolClientId

AuthenticateCognitoActionConfig.Builder userPoolClientId(String userPoolClientId)

The ID of the Amazon Cognito user pool client.

Parameters:

userPoolClientId - The ID of the Amazon Cognito user pool client.

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolDomain

AuthenticateCognitoActionConfig.Builder userPoolDomain(String 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionCookieName

AuthenticateCognitoActionConfig.Builder sessionCookieName(String sessionCookieName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

scope

AuthenticateCognitoActionConfig.Builder scope(String 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.

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:

Returns a reference to this object so that method calls can be chained together.

sessionTimeout

AuthenticateCognitoActionConfig.Builder sessionTimeout(Long sessionTimeout)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationRequestExtraParams

AuthenticateCognitoActionConfig.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

onUnauthenticatedRequest

AuthenticateCognitoActionConfig.Builder onUnauthenticatedRequest(String 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.

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticateCognitoActionConditionalBehaviorEnum, AuthenticateCognitoActionConditionalBehaviorEnum

onUnauthenticatedRequest

AuthenticateCognitoActionConfig.Builder onUnauthenticatedRequest(AuthenticateCognitoActionConditionalBehaviorEnum 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.

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticateCognitoActionConditionalBehaviorEnum, AuthenticateCognitoActionConditionalBehaviorEnum