software.amazon.awssdk.services.opensearch.model

Class SAMLOptionsInput

java.lang.Object

software.amazon.awssdk.services.opensearch.model.SAMLOptionsInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class SAMLOptionsInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>

The SAML authentication configuration for an Amazon OpenSearch Service domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SAMLOptionsInput.Builder

Method Summary

Modifier and Type	Method and Description
static SAMLOptionsInput.Builder	builder()
Boolean	enabled() True to enable SAML authentication for a domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SAMLIdp	idp() The SAML Identity Provider's information.
String	masterBackendRole() The backend role that the SAML master user is mapped to.
String	masterUserName() The SAML master user name, which is stored in the domain's internal user database.
String	rolesKey() Element of the SAML assertion to use for backend roles.
List<SdkField<?>>	sdkFields()
static Class<? extends SAMLOptionsInput.Builder>	serializableBuilderClass()
Integer	sessionTimeoutMinutes() The duration, in minutes, after which a user session becomes inactive.
String	subjectKey() Element of the SAML assertion to use for the user name.
SAMLOptionsInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

enabled

public final Boolean enabled()

True to enable SAML authentication for a domain.

Returns:

True to enable SAML authentication for a domain.

idp

public final SAMLIdp idp()

The SAML Identity Provider's information.

Returns:

The SAML Identity Provider's information.

masterUserName

public final String masterUserName()

The SAML master user name, which is stored in the domain's internal user database.

Returns:

The SAML master user name, which is stored in the domain's internal user database.

masterBackendRole

public final String masterBackendRole()

The backend role that the SAML master user is mapped to.

Returns:

The backend role that the SAML master user is mapped to.

subjectKey

public final String subjectKey()

Element of the SAML assertion to use for the user name. Default is NameID.

Returns:

Element of the SAML assertion to use for the user name. Default is NameID.

rolesKey

public final String rolesKey()

Element of the SAML assertion to use for backend roles. Default is roles.

Returns:

Element of the SAML assertion to use for backend roles. Default is roles.

sessionTimeoutMinutes

public final Integer 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.

Returns:

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

toBuilder

public SAMLOptionsInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>

builder

public static SAMLOptionsInput.Builder builder()

serializableBuilderClass

public static Class<? extends SAMLOptionsInput.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo