software.amazon.awssdk.services.opensearch.model.SAMLOptionsInput Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.opensearch.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The SAML authentication configuration for an Amazon OpenSearch Service domain.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SAMLOptionsInput implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Enabled").getter(getter(SAMLOptionsInput::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Enabled").build()).build();
private static final SdkField IDP_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("Idp")
.getter(getter(SAMLOptionsInput::idp)).setter(setter(Builder::idp)).constructor(SAMLIdp::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Idp").build()).build();
private static final SdkField MASTER_USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MasterUserName").getter(getter(SAMLOptionsInput::masterUserName))
.setter(setter(Builder::masterUserName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MasterUserName").build()).build();
private static final SdkField MASTER_BACKEND_ROLE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MasterBackendRole").getter(getter(SAMLOptionsInput::masterBackendRole))
.setter(setter(Builder::masterBackendRole))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MasterBackendRole").build()).build();
private static final SdkField SUBJECT_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SubjectKey").getter(getter(SAMLOptionsInput::subjectKey)).setter(setter(Builder::subjectKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubjectKey").build()).build();
private static final SdkField ROLES_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RolesKey").getter(getter(SAMLOptionsInput::rolesKey)).setter(setter(Builder::rolesKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RolesKey").build()).build();
private static final SdkField SESSION_TIMEOUT_MINUTES_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("SessionTimeoutMinutes").getter(getter(SAMLOptionsInput::sessionTimeoutMinutes))
.setter(setter(Builder::sessionTimeoutMinutes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SessionTimeoutMinutes").build())
.build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(ENABLED_FIELD, IDP_FIELD, MASTER_USER_NAME_FIELD, MASTER_BACKEND_ROLE_FIELD,
SUBJECT_KEY_FIELD, ROLES_KEY_FIELD, SESSION_TIMEOUT_MINUTES_FIELD));
private static final long serialVersionUID = 1L;
private final Boolean enabled;
private final SAMLIdp idp;
private final String masterUserName;
private final String masterBackendRole;
private final String subjectKey;
private final String rolesKey;
private final Integer sessionTimeoutMinutes;
private SAMLOptionsInput(BuilderImpl builder) {
this.enabled = builder.enabled;
this.idp = builder.idp;
this.masterUserName = builder.masterUserName;
this.masterBackendRole = builder.masterBackendRole;
this.subjectKey = builder.subjectKey;
this.rolesKey = builder.rolesKey;
this.sessionTimeoutMinutes = builder.sessionTimeoutMinutes;
}
/**
*
* True to enable SAML authentication for a domain.
*
*
* @return True to enable SAML authentication for a domain.
*/
public final Boolean enabled() {
return enabled;
}
/**
*
* The SAML Identity Provider's information.
*
*
* @return The SAML Identity Provider's information.
*/
public final SAMLIdp idp() {
return idp;
}
/**
*
* The SAML master user name, which is stored in the domain's internal user database.
*
*
* @return The SAML master user name, which is stored in the domain's internal user database.
*/
public final String masterUserName() {
return masterUserName;
}
/**
*
* The backend role that the SAML master user is mapped to.
*
*
* @return The backend role that the SAML master user is mapped to.
*/
public final String masterBackendRole() {
return masterBackendRole;
}
/**
*
* Element of the SAML assertion to use for the user name. Default is NameID.
*
*
* @return Element of the SAML assertion to use for the user name. Default is NameID.
*/
public final String subjectKey() {
return subjectKey;
}
/**
*
* Element of the SAML assertion to use for backend roles. Default is roles.
*
*
* @return Element of the SAML assertion to use for backend roles. Default is roles.
*/
public final String rolesKey() {
return rolesKey;
}
/**
*
* The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440,
* and the default value is 60.
*
*
* @return The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1
* and 1440, and the default value is 60.
*/
public final Integer sessionTimeoutMinutes() {
return sessionTimeoutMinutes;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(idp());
hashCode = 31 * hashCode + Objects.hashCode(masterUserName());
hashCode = 31 * hashCode + Objects.hashCode(masterBackendRole());
hashCode = 31 * hashCode + Objects.hashCode(subjectKey());
hashCode = 31 * hashCode + Objects.hashCode(rolesKey());
hashCode = 31 * hashCode + Objects.hashCode(sessionTimeoutMinutes());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SAMLOptionsInput)) {
return false;
}
SAMLOptionsInput other = (SAMLOptionsInput) obj;
return Objects.equals(enabled(), other.enabled()) && Objects.equals(idp(), other.idp())
&& Objects.equals(masterUserName(), other.masterUserName())
&& Objects.equals(masterBackendRole(), other.masterBackendRole())
&& Objects.equals(subjectKey(), other.subjectKey()) && Objects.equals(rolesKey(), other.rolesKey())
&& Objects.equals(sessionTimeoutMinutes(), other.sessionTimeoutMinutes());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SAMLOptionsInput").add("Enabled", enabled()).add("Idp", idp())
.add("MasterUserName", masterUserName() == null ? null : "*** Sensitive Data Redacted ***")
.add("MasterBackendRole", masterBackendRole()).add("SubjectKey", subjectKey()).add("RolesKey", rolesKey())
.add("SessionTimeoutMinutes", sessionTimeoutMinutes()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "Idp":
return Optional.ofNullable(clazz.cast(idp()));
case "MasterUserName":
return Optional.ofNullable(clazz.cast(masterUserName()));
case "MasterBackendRole":
return Optional.ofNullable(clazz.cast(masterBackendRole()));
case "SubjectKey":
return Optional.ofNullable(clazz.cast(subjectKey()));
case "RolesKey":
return Optional.ofNullable(clazz.cast(rolesKey()));
case "SessionTimeoutMinutes":
return Optional.ofNullable(clazz.cast(sessionTimeoutMinutes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SAMLOptionsInput) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* True to enable SAML authentication for a domain.
*
*
* @param enabled
* True to enable SAML authentication for a domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enabled(Boolean enabled);
/**
*
* The SAML Identity Provider's information.
*
*
* @param idp
* The SAML Identity Provider's information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder idp(SAMLIdp idp);
/**
*
* The SAML Identity Provider's information.
*
* This is a convenience method that creates an instance of the {@link SAMLIdp.Builder} avoiding the need to
* create one manually via {@link SAMLIdp#builder()}.
*
*
* When the {@link Consumer} completes, {@link SAMLIdp.Builder#build()} is called immediately and its result is
* passed to {@link #idp(SAMLIdp)}.
*
* @param idp
* a consumer that will call methods on {@link SAMLIdp.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #idp(SAMLIdp)
*/
default Builder idp(Consumer idp) {
return idp(SAMLIdp.builder().applyMutation(idp).build());
}
/**
*
* The SAML master user name, which is stored in the domain's internal user database.
*
*
* @param masterUserName
* The SAML master user name, which is stored in the domain's internal user database.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder masterUserName(String masterUserName);
/**
*
* The backend role that the SAML master user is mapped to.
*
*
* @param masterBackendRole
* The backend role that the SAML master user is mapped to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder masterBackendRole(String masterBackendRole);
/**
*
* Element of the SAML assertion to use for the user name. Default is NameID.
*
*
* @param subjectKey
* Element of the SAML assertion to use for the user name. Default is NameID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subjectKey(String subjectKey);
/**
*
* Element of the SAML assertion to use for backend roles. Default is roles.
*
*
* @param rolesKey
* Element of the SAML assertion to use for backend roles. Default is roles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rolesKey(String rolesKey);
/**
*
* The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and
* 1440, and the default value is 60.
*
*
* @param sessionTimeoutMinutes
* The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1
* and 1440, and the default value is 60.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sessionTimeoutMinutes(Integer sessionTimeoutMinutes);
}
static final class BuilderImpl implements Builder {
private Boolean enabled;
private SAMLIdp idp;
private String masterUserName;
private String masterBackendRole;
private String subjectKey;
private String rolesKey;
private Integer sessionTimeoutMinutes;
private BuilderImpl() {
}
private BuilderImpl(SAMLOptionsInput model) {
enabled(model.enabled);
idp(model.idp);
masterUserName(model.masterUserName);
masterBackendRole(model.masterBackendRole);
subjectKey(model.subjectKey);
rolesKey(model.rolesKey);
sessionTimeoutMinutes(model.sessionTimeoutMinutes);
}
public final Boolean getEnabled() {
return enabled;
}
public final void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
@Override
public final Builder enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
public final SAMLIdp.Builder getIdp() {
return idp != null ? idp.toBuilder() : null;
}
public final void setIdp(SAMLIdp.BuilderImpl idp) {
this.idp = idp != null ? idp.build() : null;
}
@Override
public final Builder idp(SAMLIdp idp) {
this.idp = idp;
return this;
}
public final String getMasterUserName() {
return masterUserName;
}
public final void setMasterUserName(String masterUserName) {
this.masterUserName = masterUserName;
}
@Override
public final Builder masterUserName(String masterUserName) {
this.masterUserName = masterUserName;
return this;
}
public final String getMasterBackendRole() {
return masterBackendRole;
}
public final void setMasterBackendRole(String masterBackendRole) {
this.masterBackendRole = masterBackendRole;
}
@Override
public final Builder masterBackendRole(String masterBackendRole) {
this.masterBackendRole = masterBackendRole;
return this;
}
public final String getSubjectKey() {
return subjectKey;
}
public final void setSubjectKey(String subjectKey) {
this.subjectKey = subjectKey;
}
@Override
public final Builder subjectKey(String subjectKey) {
this.subjectKey = subjectKey;
return this;
}
public final String getRolesKey() {
return rolesKey;
}
public final void setRolesKey(String rolesKey) {
this.rolesKey = rolesKey;
}
@Override
public final Builder rolesKey(String rolesKey) {
this.rolesKey = rolesKey;
return this;
}
public final Integer getSessionTimeoutMinutes() {
return sessionTimeoutMinutes;
}
public final void setSessionTimeoutMinutes(Integer sessionTimeoutMinutes) {
this.sessionTimeoutMinutes = sessionTimeoutMinutes;
}
@Override
public final Builder sessionTimeoutMinutes(Integer sessionTimeoutMinutes) {
this.sessionTimeoutMinutes = sessionTimeoutMinutes;
return this;
}
@Override
public SAMLOptionsInput build() {
return new SAMLOptionsInput(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}