Interface SamlConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>, SdkBuilder<SamlConfiguration.Builder,SamlConfiguration>, SdkPojo

Enclosing class:

SamlConfiguration

@Mutable
@NotThreadSafe
public static interface SamlConfiguration.Builder
extends SdkPojo, CopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>

Method Summary

Modifier and Type	Method	Description
SamlConfiguration.Builder	metadataXML(String metadataXML)	The metadata XML that your IdP generated.
SamlConfiguration.Builder	roleArn(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.
SamlConfiguration.Builder	userGroupAttribute(String userGroupAttribute)	The group attribute name in your IdP that maps to user groups.
SamlConfiguration.Builder	userIdAttribute(String userIdAttribute)	The user attribute name in your IdP that maps to the user email.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

metadataXML

SamlConfiguration.Builder metadataXML(String metadataXML)

The metadata XML that your IdP generated.

Parameters:

metadataXML - The metadata XML that your IdP generated.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

SamlConfiguration.Builder roleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

userIdAttribute

SamlConfiguration.Builder userIdAttribute(String userIdAttribute)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

userGroupAttribute

SamlConfiguration.Builder userGroupAttribute(String userGroupAttribute)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.