com.amazonaws.services.sagemaker.model.OidcConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker 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.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Use this parameter to configure your OIDC Identity Provider (IdP).
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OidcConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The OIDC IdP client ID used to configure your private workforce.
*
*/
private String clientId;
/**
*
* The OIDC IdP client secret used to configure your private workforce.
*
*/
private String clientSecret;
/**
*
* The OIDC IdP issuer used to configure your private workforce.
*
*/
private String issuer;
/**
*
* The OIDC IdP authorization endpoint used to configure your private workforce.
*
*/
private String authorizationEndpoint;
/**
*
* The OIDC IdP token endpoint used to configure your private workforce.
*
*/
private String tokenEndpoint;
/**
*
* The OIDC IdP user information endpoint used to configure your private workforce.
*
*/
private String userInfoEndpoint;
/**
*
* The OIDC IdP logout endpoint used to configure your private workforce.
*
*/
private String logoutEndpoint;
/**
*
* The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
*
*/
private String jwksUri;
/**
*
* An array of string identifiers used to refer to the specific pieces of user data or claims that the client
* application wants to access.
*
*/
private String scope;
/**
*
* A string to string map of identifiers specific to the custom identity provider (IdP) being used.
*
*/
private java.util.Map authenticationRequestExtraParams;
/**
*
* The OIDC IdP client ID used to configure your private workforce.
*
*
* @param clientId
* The OIDC IdP client ID used to configure your private workforce.
*/
public void setClientId(String clientId) {
this.clientId = clientId;
}
/**
*
* The OIDC IdP client ID used to configure your private workforce.
*
*
* @return The OIDC IdP client ID used to configure your private workforce.
*/
public String getClientId() {
return this.clientId;
}
/**
*
* The OIDC IdP client ID used to configure your private workforce.
*
*
* @param clientId
* The OIDC IdP client ID used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withClientId(String clientId) {
setClientId(clientId);
return this;
}
/**
*
* The OIDC IdP client secret used to configure your private workforce.
*
*
* @param clientSecret
* The OIDC IdP client secret used to configure your private workforce.
*/
public void setClientSecret(String clientSecret) {
this.clientSecret = clientSecret;
}
/**
*
* The OIDC IdP client secret used to configure your private workforce.
*
*
* @return The OIDC IdP client secret used to configure your private workforce.
*/
public String getClientSecret() {
return this.clientSecret;
}
/**
*
* The OIDC IdP client secret used to configure your private workforce.
*
*
* @param clientSecret
* The OIDC IdP client secret used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withClientSecret(String clientSecret) {
setClientSecret(clientSecret);
return this;
}
/**
*
* The OIDC IdP issuer used to configure your private workforce.
*
*
* @param issuer
* The OIDC IdP issuer used to configure your private workforce.
*/
public void setIssuer(String issuer) {
this.issuer = issuer;
}
/**
*
* The OIDC IdP issuer used to configure your private workforce.
*
*
* @return The OIDC IdP issuer used to configure your private workforce.
*/
public String getIssuer() {
return this.issuer;
}
/**
*
* The OIDC IdP issuer used to configure your private workforce.
*
*
* @param issuer
* The OIDC IdP issuer used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withIssuer(String issuer) {
setIssuer(issuer);
return this;
}
/**
*
* The OIDC IdP authorization endpoint used to configure your private workforce.
*
*
* @param authorizationEndpoint
* The OIDC IdP authorization endpoint used to configure your private workforce.
*/
public void setAuthorizationEndpoint(String authorizationEndpoint) {
this.authorizationEndpoint = authorizationEndpoint;
}
/**
*
* The OIDC IdP authorization endpoint used to configure your private workforce.
*
*
* @return The OIDC IdP authorization endpoint used to configure your private workforce.
*/
public String getAuthorizationEndpoint() {
return this.authorizationEndpoint;
}
/**
*
* The OIDC IdP authorization endpoint used to configure your private workforce.
*
*
* @param authorizationEndpoint
* The OIDC IdP authorization endpoint used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withAuthorizationEndpoint(String authorizationEndpoint) {
setAuthorizationEndpoint(authorizationEndpoint);
return this;
}
/**
*
* The OIDC IdP token endpoint used to configure your private workforce.
*
*
* @param tokenEndpoint
* The OIDC IdP token endpoint used to configure your private workforce.
*/
public void setTokenEndpoint(String tokenEndpoint) {
this.tokenEndpoint = tokenEndpoint;
}
/**
*
* The OIDC IdP token endpoint used to configure your private workforce.
*
*
* @return The OIDC IdP token endpoint used to configure your private workforce.
*/
public String getTokenEndpoint() {
return this.tokenEndpoint;
}
/**
*
* The OIDC IdP token endpoint used to configure your private workforce.
*
*
* @param tokenEndpoint
* The OIDC IdP token endpoint used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withTokenEndpoint(String tokenEndpoint) {
setTokenEndpoint(tokenEndpoint);
return this;
}
/**
*
* The OIDC IdP user information endpoint used to configure your private workforce.
*
*
* @param userInfoEndpoint
* The OIDC IdP user information endpoint used to configure your private workforce.
*/
public void setUserInfoEndpoint(String userInfoEndpoint) {
this.userInfoEndpoint = userInfoEndpoint;
}
/**
*
* The OIDC IdP user information endpoint used to configure your private workforce.
*
*
* @return The OIDC IdP user information endpoint used to configure your private workforce.
*/
public String getUserInfoEndpoint() {
return this.userInfoEndpoint;
}
/**
*
* The OIDC IdP user information endpoint used to configure your private workforce.
*
*
* @param userInfoEndpoint
* The OIDC IdP user information endpoint used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withUserInfoEndpoint(String userInfoEndpoint) {
setUserInfoEndpoint(userInfoEndpoint);
return this;
}
/**
*
* The OIDC IdP logout endpoint used to configure your private workforce.
*
*
* @param logoutEndpoint
* The OIDC IdP logout endpoint used to configure your private workforce.
*/
public void setLogoutEndpoint(String logoutEndpoint) {
this.logoutEndpoint = logoutEndpoint;
}
/**
*
* The OIDC IdP logout endpoint used to configure your private workforce.
*
*
* @return The OIDC IdP logout endpoint used to configure your private workforce.
*/
public String getLogoutEndpoint() {
return this.logoutEndpoint;
}
/**
*
* The OIDC IdP logout endpoint used to configure your private workforce.
*
*
* @param logoutEndpoint
* The OIDC IdP logout endpoint used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withLogoutEndpoint(String logoutEndpoint) {
setLogoutEndpoint(logoutEndpoint);
return this;
}
/**
*
* The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
*
*
* @param jwksUri
* The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
*/
public void setJwksUri(String jwksUri) {
this.jwksUri = jwksUri;
}
/**
*
* The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
*
*
* @return The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
*/
public String getJwksUri() {
return this.jwksUri;
}
/**
*
* The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
*
*
* @param jwksUri
* The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withJwksUri(String jwksUri) {
setJwksUri(jwksUri);
return this;
}
/**
*
* An array of string identifiers used to refer to the specific pieces of user data or claims that the client
* application wants to access.
*
*
* @param scope
* An array of string identifiers used to refer to the specific pieces of user data or claims that the client
* application wants to access.
*/
public void setScope(String scope) {
this.scope = scope;
}
/**
*
* An array of string identifiers used to refer to the specific pieces of user data or claims that the client
* application wants to access.
*
*
* @return An array of string identifiers used to refer to the specific pieces of user data or claims that the
* client application wants to access.
*/
public String getScope() {
return this.scope;
}
/**
*
* An array of string identifiers used to refer to the specific pieces of user data or claims that the client
* application wants to access.
*
*
* @param scope
* An array of string identifiers used to refer to the specific pieces of user data or claims that the client
* application wants to access.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withScope(String scope) {
setScope(scope);
return this;
}
/**
*
* A string to string map of identifiers specific to the custom identity provider (IdP) being used.
*
*
* @return A string to string map of identifiers specific to the custom identity provider (IdP) being used.
*/
public java.util.Map getAuthenticationRequestExtraParams() {
return authenticationRequestExtraParams;
}
/**
*
* A string to string map of identifiers specific to the custom identity provider (IdP) being used.
*
*
* @param authenticationRequestExtraParams
* A string to string map of identifiers specific to the custom identity provider (IdP) being used.
*/
public void setAuthenticationRequestExtraParams(java.util.Map authenticationRequestExtraParams) {
this.authenticationRequestExtraParams = authenticationRequestExtraParams;
}
/**
*
* A string to string map of identifiers specific to the custom identity provider (IdP) being used.
*
*
* @param authenticationRequestExtraParams
* A string to string map of identifiers specific to the custom identity provider (IdP) being used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig withAuthenticationRequestExtraParams(java.util.Map authenticationRequestExtraParams) {
setAuthenticationRequestExtraParams(authenticationRequestExtraParams);
return this;
}
/**
* Add a single AuthenticationRequestExtraParams entry
*
* @see OidcConfig#withAuthenticationRequestExtraParams
* @returns a reference to this object so that method calls can be chained together.
*/
public OidcConfig 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 OidcConfig clearAuthenticationRequestExtraParamsEntries() {
this.authenticationRequestExtraParams = null;
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 (getClientId() != null)
sb.append("ClientId: ").append(getClientId()).append(",");
if (getClientSecret() != null)
sb.append("ClientSecret: ").append("***Sensitive Data Redacted***").append(",");
if (getIssuer() != null)
sb.append("Issuer: ").append(getIssuer()).append(",");
if (getAuthorizationEndpoint() != null)
sb.append("AuthorizationEndpoint: ").append(getAuthorizationEndpoint()).append(",");
if (getTokenEndpoint() != null)
sb.append("TokenEndpoint: ").append(getTokenEndpoint()).append(",");
if (getUserInfoEndpoint() != null)
sb.append("UserInfoEndpoint: ").append(getUserInfoEndpoint()).append(",");
if (getLogoutEndpoint() != null)
sb.append("LogoutEndpoint: ").append(getLogoutEndpoint()).append(",");
if (getJwksUri() != null)
sb.append("JwksUri: ").append(getJwksUri()).append(",");
if (getScope() != null)
sb.append("Scope: ").append(getScope()).append(",");
if (getAuthenticationRequestExtraParams() != null)
sb.append("AuthenticationRequestExtraParams: ").append(getAuthenticationRequestExtraParams());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OidcConfig == false)
return false;
OidcConfig other = (OidcConfig) obj;
if (other.getClientId() == null ^ this.getClientId() == null)
return false;
if (other.getClientId() != null && other.getClientId().equals(this.getClientId()) == false)
return false;
if (other.getClientSecret() == null ^ this.getClientSecret() == null)
return false;
if (other.getClientSecret() != null && other.getClientSecret().equals(this.getClientSecret()) == false)
return false;
if (other.getIssuer() == null ^ this.getIssuer() == null)
return false;
if (other.getIssuer() != null && other.getIssuer().equals(this.getIssuer()) == false)
return false;
if (other.getAuthorizationEndpoint() == null ^ this.getAuthorizationEndpoint() == null)
return false;
if (other.getAuthorizationEndpoint() != null && other.getAuthorizationEndpoint().equals(this.getAuthorizationEndpoint()) == false)
return false;
if (other.getTokenEndpoint() == null ^ this.getTokenEndpoint() == null)
return false;
if (other.getTokenEndpoint() != null && other.getTokenEndpoint().equals(this.getTokenEndpoint()) == false)
return false;
if (other.getUserInfoEndpoint() == null ^ this.getUserInfoEndpoint() == null)
return false;
if (other.getUserInfoEndpoint() != null && other.getUserInfoEndpoint().equals(this.getUserInfoEndpoint()) == false)
return false;
if (other.getLogoutEndpoint() == null ^ this.getLogoutEndpoint() == null)
return false;
if (other.getLogoutEndpoint() != null && other.getLogoutEndpoint().equals(this.getLogoutEndpoint()) == false)
return false;
if (other.getJwksUri() == null ^ this.getJwksUri() == null)
return false;
if (other.getJwksUri() != null && other.getJwksUri().equals(this.getJwksUri()) == 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.getAuthenticationRequestExtraParams() == null ^ this.getAuthenticationRequestExtraParams() == null)
return false;
if (other.getAuthenticationRequestExtraParams() != null
&& other.getAuthenticationRequestExtraParams().equals(this.getAuthenticationRequestExtraParams()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientId() == null) ? 0 : getClientId().hashCode());
hashCode = prime * hashCode + ((getClientSecret() == null) ? 0 : getClientSecret().hashCode());
hashCode = prime * hashCode + ((getIssuer() == null) ? 0 : getIssuer().hashCode());
hashCode = prime * hashCode + ((getAuthorizationEndpoint() == null) ? 0 : getAuthorizationEndpoint().hashCode());
hashCode = prime * hashCode + ((getTokenEndpoint() == null) ? 0 : getTokenEndpoint().hashCode());
hashCode = prime * hashCode + ((getUserInfoEndpoint() == null) ? 0 : getUserInfoEndpoint().hashCode());
hashCode = prime * hashCode + ((getLogoutEndpoint() == null) ? 0 : getLogoutEndpoint().hashCode());
hashCode = prime * hashCode + ((getJwksUri() == null) ? 0 : getJwksUri().hashCode());
hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode());
hashCode = prime * hashCode + ((getAuthenticationRequestExtraParams() == null) ? 0 : getAuthenticationRequestExtraParams().hashCode());
return hashCode;
}
@Override
public OidcConfig clone() {
try {
return (OidcConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.OidcConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}