com.amazonaws.services.elasticloadbalancingv2.model.AuthenticateCognitoActionConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticloadbalancingv2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticloadbalancingv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Request parameters to use when integrating with Amazon Cognito to authenticate users.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AuthenticateCognitoActionConfig implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*
*/
private String userPoolArn;
/**
*
* The ID of the Amazon Cognito user pool client.
*
*/
private String userPoolClientId;
/**
*
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*
*/
private String userPoolDomain;
/**
*
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*
*/
private String sessionCookieName;
/**
*
* 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.
*
*/
private String scope;
/**
*
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*
*/
private Long sessionTimeout;
/**
*
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*
*/
private java.util.Map authenticationRequestExtraParams;
/**
*
* The behavior if the user is not authenticated. The following are possible values:
*
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
*
*/
private String onUnauthenticatedRequest;
/**
*
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*
*
* @param userPoolArn
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*/
public void setUserPoolArn(String userPoolArn) {
this.userPoolArn = userPoolArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*/
public String getUserPoolArn() {
return this.userPoolArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
*
*
* @param userPoolArn
* The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withUserPoolArn(String userPoolArn) {
setUserPoolArn(userPoolArn);
return this;
}
/**
*
* The ID of the Amazon Cognito user pool client.
*
*
* @param userPoolClientId
* The ID of the Amazon Cognito user pool client.
*/
public void setUserPoolClientId(String userPoolClientId) {
this.userPoolClientId = userPoolClientId;
}
/**
*
* The ID of the Amazon Cognito user pool client.
*
*
* @return The ID of the Amazon Cognito user pool client.
*/
public String getUserPoolClientId() {
return this.userPoolClientId;
}
/**
*
* The ID of the Amazon Cognito user pool client.
*
*
* @param userPoolClientId
* The ID of the Amazon Cognito user pool client.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withUserPoolClientId(String userPoolClientId) {
setUserPoolClientId(userPoolClientId);
return this;
}
/**
*
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*
*
* @param userPoolDomain
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*/
public void setUserPoolDomain(String userPoolDomain) {
this.userPoolDomain = userPoolDomain;
}
/**
*
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*
*
* @return The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*/
public String getUserPoolDomain() {
return this.userPoolDomain;
}
/**
*
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
*
*
* @param userPoolDomain
* The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withUserPoolDomain(String userPoolDomain) {
setUserPoolDomain(userPoolDomain);
return this;
}
/**
*
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*
*
* @param sessionCookieName
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*/
public void setSessionCookieName(String sessionCookieName) {
this.sessionCookieName = sessionCookieName;
}
/**
*
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*
*
* @return The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*/
public String getSessionCookieName() {
return this.sessionCookieName;
}
/**
*
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
*
*
* @param sessionCookieName
* The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withSessionCookieName(String sessionCookieName) {
setSessionCookieName(sessionCookieName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setScope(String scope) {
this.scope = 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.
*
*
* @return 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.
*/
public String getScope() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withScope(String scope) {
setScope(scope);
return this;
}
/**
*
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*
*
* @param sessionTimeout
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*/
public void setSessionTimeout(Long sessionTimeout) {
this.sessionTimeout = sessionTimeout;
}
/**
*
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*
*
* @return The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*/
public Long getSessionTimeout() {
return this.sessionTimeout;
}
/**
*
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
*
*
* @param sessionTimeout
* The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withSessionTimeout(Long sessionTimeout) {
setSessionTimeout(sessionTimeout);
return this;
}
/**
*
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*
*
* @return The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*/
public java.util.Map getAuthenticationRequestExtraParams() {
return authenticationRequestExtraParams;
}
/**
*
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*
*
* @param authenticationRequestExtraParams
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*/
public void setAuthenticationRequestExtraParams(java.util.Map authenticationRequestExtraParams) {
this.authenticationRequestExtraParams = authenticationRequestExtraParams;
}
/**
*
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
*
*
* @param authenticationRequestExtraParams
* The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig withAuthenticationRequestExtraParams(java.util.Map authenticationRequestExtraParams) {
setAuthenticationRequestExtraParams(authenticationRequestExtraParams);
return this;
}
/**
* Add a single AuthenticationRequestExtraParams entry
*
* @see AuthenticateCognitoActionConfig#withAuthenticationRequestExtraParams
* @returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig addAuthenticationRequestExtraParamsEntry(String key, String value) {
if (null == this.authenticationRequestExtraParams) {
this.authenticationRequestExtraParams = new java.util.HashMap();
}
if (this.authenticationRequestExtraParams.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.authenticationRequestExtraParams.put(key, value);
return this;
}
/**
* Removes all the entries added into AuthenticationRequestExtraParams.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AuthenticateCognitoActionConfig clearAuthenticationRequestExtraParamsEntries() {
this.authenticationRequestExtraParams = null;
return this;
}
/**
*
* The behavior if the user is not authenticated. The following are possible values:
*
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
*
*
* @param onUnauthenticatedRequest
* The behavior if the user is not authenticated. The following are possible values:
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
* @see AuthenticateCognitoActionConditionalBehaviorEnum
*/
public void setOnUnauthenticatedRequest(String onUnauthenticatedRequest) {
this.onUnauthenticatedRequest = onUnauthenticatedRequest;
}
/**
*
* The behavior if the user is not authenticated. The following are possible values:
*
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
*
*
* @return The behavior if the user is not authenticated. The following are possible values:
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
* @see AuthenticateCognitoActionConditionalBehaviorEnum
*/
public String getOnUnauthenticatedRequest() {
return this.onUnauthenticatedRequest;
}
/**
*
* The behavior if the user is not authenticated. The following are possible values:
*
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
*
*
* @param onUnauthenticatedRequest
* The behavior if the user is not authenticated. The following are possible values:
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticateCognitoActionConditionalBehaviorEnum
*/
public AuthenticateCognitoActionConfig withOnUnauthenticatedRequest(String onUnauthenticatedRequest) {
setOnUnauthenticatedRequest(onUnauthenticatedRequest);
return this;
}
/**
*
* The behavior if the user is not authenticated. The following are possible values:
*
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
*
*
* @param onUnauthenticatedRequest
* The behavior if the user is not authenticated. The following are possible values:
*
* -
*
* deny
*
* -
*
* allow
*
* -
*
* authenticate
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthenticateCognitoActionConditionalBehaviorEnum
*/
public AuthenticateCognitoActionConfig withOnUnauthenticatedRequest(AuthenticateCognitoActionConditionalBehaviorEnum onUnauthenticatedRequest) {
this.onUnauthenticatedRequest = onUnauthenticatedRequest.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserPoolArn() != null)
sb.append("UserPoolArn: ").append(getUserPoolArn()).append(",");
if (getUserPoolClientId() != null)
sb.append("UserPoolClientId: ").append(getUserPoolClientId()).append(",");
if (getUserPoolDomain() != null)
sb.append("UserPoolDomain: ").append(getUserPoolDomain()).append(",");
if (getSessionCookieName() != null)
sb.append("SessionCookieName: ").append(getSessionCookieName()).append(",");
if (getScope() != null)
sb.append("Scope: ").append(getScope()).append(",");
if (getSessionTimeout() != null)
sb.append("SessionTimeout: ").append(getSessionTimeout()).append(",");
if (getAuthenticationRequestExtraParams() != null)
sb.append("AuthenticationRequestExtraParams: ").append(getAuthenticationRequestExtraParams()).append(",");
if (getOnUnauthenticatedRequest() != null)
sb.append("OnUnauthenticatedRequest: ").append(getOnUnauthenticatedRequest());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AuthenticateCognitoActionConfig == false)
return false;
AuthenticateCognitoActionConfig other = (AuthenticateCognitoActionConfig) obj;
if (other.getUserPoolArn() == null ^ this.getUserPoolArn() == null)
return false;
if (other.getUserPoolArn() != null && other.getUserPoolArn().equals(this.getUserPoolArn()) == false)
return false;
if (other.getUserPoolClientId() == null ^ this.getUserPoolClientId() == null)
return false;
if (other.getUserPoolClientId() != null && other.getUserPoolClientId().equals(this.getUserPoolClientId()) == false)
return false;
if (other.getUserPoolDomain() == null ^ this.getUserPoolDomain() == null)
return false;
if (other.getUserPoolDomain() != null && other.getUserPoolDomain().equals(this.getUserPoolDomain()) == false)
return false;
if (other.getSessionCookieName() == null ^ this.getSessionCookieName() == null)
return false;
if (other.getSessionCookieName() != null && other.getSessionCookieName().equals(this.getSessionCookieName()) == false)
return false;
if (other.getScope() == null ^ this.getScope() == null)
return false;
if (other.getScope() != null && other.getScope().equals(this.getScope()) == false)
return false;
if (other.getSessionTimeout() == null ^ this.getSessionTimeout() == null)
return false;
if (other.getSessionTimeout() != null && other.getSessionTimeout().equals(this.getSessionTimeout()) == false)
return false;
if (other.getAuthenticationRequestExtraParams() == null ^ this.getAuthenticationRequestExtraParams() == null)
return false;
if (other.getAuthenticationRequestExtraParams() != null
&& other.getAuthenticationRequestExtraParams().equals(this.getAuthenticationRequestExtraParams()) == false)
return false;
if (other.getOnUnauthenticatedRequest() == null ^ this.getOnUnauthenticatedRequest() == null)
return false;
if (other.getOnUnauthenticatedRequest() != null && other.getOnUnauthenticatedRequest().equals(this.getOnUnauthenticatedRequest()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserPoolArn() == null) ? 0 : getUserPoolArn().hashCode());
hashCode = prime * hashCode + ((getUserPoolClientId() == null) ? 0 : getUserPoolClientId().hashCode());
hashCode = prime * hashCode + ((getUserPoolDomain() == null) ? 0 : getUserPoolDomain().hashCode());
hashCode = prime * hashCode + ((getSessionCookieName() == null) ? 0 : getSessionCookieName().hashCode());
hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode());
hashCode = prime * hashCode + ((getSessionTimeout() == null) ? 0 : getSessionTimeout().hashCode());
hashCode = prime * hashCode + ((getAuthenticationRequestExtraParams() == null) ? 0 : getAuthenticationRequestExtraParams().hashCode());
hashCode = prime * hashCode + ((getOnUnauthenticatedRequest() == null) ? 0 : getOnUnauthenticatedRequest().hashCode());
return hashCode;
}
@Override
public AuthenticateCognitoActionConfig clone() {
try {
return (AuthenticateCognitoActionConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}