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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SamlConfiguration.Builder,SamlConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.