com.amazonaws.services.elasticloadbalancingv2.model

Class AuthenticateCognitoActionConfig

java.lang.Object

com.amazonaws.services.elasticloadbalancingv2.model.AuthenticateCognitoActionConfig

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthenticateCognitoActionConfig
extends Object
implements Serializable, Cloneable

Request parameters to use when integrating with Amazon Cognito to authenticate users.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticateCognitoActionConfig()

Method Summary

Modifier and Type	Method and Description
AuthenticateCognitoActionConfig	addAuthenticationRequestExtraParamsEntry(String key, String value) Add a single AuthenticationRequestExtraParams entry
AuthenticateCognitoActionConfig	clearAuthenticationRequestExtraParamsEntries() Removes all the entries added into AuthenticationRequestExtraParams.
AuthenticateCognitoActionConfig	clone()
boolean	equals(Object obj)
Map<String,String>	getAuthenticationRequestExtraParams() The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
String	getOnUnauthenticatedRequest() The behavior if the user is not authenticated.
String	getScope() The set of user claims to be requested from the IdP.
String	getSessionCookieName() The name of the cookie used to maintain session information.
Long	getSessionTimeout() The maximum duration of the authentication session, in seconds.
String	getUserPoolArn() The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
String	getUserPoolClientId() The ID of the Amazon Cognito user pool client.
String	getUserPoolDomain() The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
int	hashCode()
void	setAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams) The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
void	setOnUnauthenticatedRequest(String onUnauthenticatedRequest) The behavior if the user is not authenticated.
void	setScope(String scope) The set of user claims to be requested from the IdP.
void	setSessionCookieName(String sessionCookieName) The name of the cookie used to maintain session information.
void	setSessionTimeout(Long sessionTimeout) The maximum duration of the authentication session, in seconds.
void	setUserPoolArn(String userPoolArn) The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
void	setUserPoolClientId(String userPoolClientId) The ID of the Amazon Cognito user pool client.
void	setUserPoolDomain(String userPoolDomain) The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
String	toString() Returns a string representation of this object.
AuthenticateCognitoActionConfig	withAuthenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams) The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
AuthenticateCognitoActionConfig	withOnUnauthenticatedRequest(AuthenticateCognitoActionConditionalBehaviorEnum onUnauthenticatedRequest) The behavior if the user is not authenticated.
AuthenticateCognitoActionConfig	withOnUnauthenticatedRequest(String onUnauthenticatedRequest) The behavior if the user is not authenticated.
AuthenticateCognitoActionConfig	withScope(String scope) The set of user claims to be requested from the IdP.
AuthenticateCognitoActionConfig	withSessionCookieName(String sessionCookieName) The name of the cookie used to maintain session information.
AuthenticateCognitoActionConfig	withSessionTimeout(Long sessionTimeout) The maximum duration of the authentication session, in seconds.
AuthenticateCognitoActionConfig	withUserPoolArn(String userPoolArn) The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
AuthenticateCognitoActionConfig	withUserPoolClientId(String userPoolClientId) The ID of the Amazon Cognito user pool client.
AuthenticateCognitoActionConfig	withUserPoolDomain(String userPoolDomain) The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticateCognitoActionConfig

public AuthenticateCognitoActionConfig()

Method Detail

setUserPoolArn

public void setUserPoolArn(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.

getUserPoolArn

public String getUserPoolArn()

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

Returns:

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

withUserPoolArn

public AuthenticateCognitoActionConfig withUserPoolArn(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.

setUserPoolClientId

public void setUserPoolClientId(String userPoolClientId)

The ID of the Amazon Cognito user pool client.

Parameters:

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

getUserPoolClientId

public String getUserPoolClientId()

The ID of the Amazon Cognito user pool client.

Returns:

The ID of the Amazon Cognito user pool client.

withUserPoolClientId

public AuthenticateCognitoActionConfig withUserPoolClientId(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.

setUserPoolDomain

public void setUserPoolDomain(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.

getUserPoolDomain

public String getUserPoolDomain()

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Returns:

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

withUserPoolDomain

public AuthenticateCognitoActionConfig withUserPoolDomain(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.

setSessionCookieName

public void setSessionCookieName(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.

getSessionCookieName

public String getSessionCookieName()

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

Returns:

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

withSessionCookieName

public AuthenticateCognitoActionConfig withSessionCookieName(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.

setScope

public void setScope(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.

getScope

public String getScope()

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:

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.

withScope

public AuthenticateCognitoActionConfig withScope(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.

setSessionTimeout

public void setSessionTimeout(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).

getSessionTimeout

public Long getSessionTimeout()

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

Returns:

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

withSessionTimeout

public AuthenticateCognitoActionConfig withSessionTimeout(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.

getAuthenticationRequestExtraParams

public Map<String,String> getAuthenticationRequestExtraParams()

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

Returns:

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

setAuthenticationRequestExtraParams

public void setAuthenticationRequestExtraParams(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.

withAuthenticationRequestExtraParams

public AuthenticateCognitoActionConfig withAuthenticationRequestExtraParams(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.

addAuthenticationRequestExtraParamsEntry

public AuthenticateCognitoActionConfig addAuthenticationRequestExtraParamsEntry(String key,
                                                                                String value)

Add a single AuthenticationRequestExtraParams entry

See Also:

withAuthenticationRequestExtraParams(java.util.Map<java.lang.String, java.lang.String>)

clearAuthenticationRequestExtraParamsEntries

public AuthenticateCognitoActionConfig clearAuthenticationRequestExtraParamsEntries()

Removes all the entries added into AuthenticationRequestExtraParams.

Returns:

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

setOnUnauthenticatedRequest

public void setOnUnauthenticatedRequest(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.

See Also:

AuthenticateCognitoActionConditionalBehaviorEnum

getOnUnauthenticatedRequest

public String getOnUnauthenticatedRequest()

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:

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.

See Also:

AuthenticateCognitoActionConditionalBehaviorEnum

withOnUnauthenticatedRequest

public AuthenticateCognitoActionConfig withOnUnauthenticatedRequest(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

withOnUnauthenticatedRequest

public AuthenticateCognitoActionConfig withOnUnauthenticatedRequest(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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AuthenticateCognitoActionConfig clone()

Overrides:

clone in class Object