Package software.amazon.awssdk.services.qbusiness.model

Class SamlConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.SamlConfiguration

All Implemented Interfaces:

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

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

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SamlConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SamlConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	metadataXML()	The metadata XML that your IdP generated.
String	roleArn()	The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
List<SdkField<?>>	sdkFields()
static Class<? extends SamlConfiguration.Builder>	serializableBuilderClass()
SamlConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userGroupAttribute()	The group attribute name in your IdP that maps to user groups.
String	userIdAttribute()	The user attribute name in your IdP that maps to the user email.

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

metadataXML

public final String metadataXML()

The metadata XML that your IdP generated.

Returns:

The metadata XML that your IdP generated.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

Returns:

The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

userIdAttribute

public final String userIdAttribute()

The user attribute name in your IdP that maps to the user email.

Returns:

The user attribute name in your IdP that maps to the user email.

userGroupAttribute

public final String userGroupAttribute()

The group attribute name in your IdP that maps to user groups.

Returns:

The group attribute name in your IdP that maps to user groups.

toBuilder

public SamlConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>

builder

public static SamlConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SamlConfiguration.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