Class: Aws::QBusiness::Types::SamlConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#metadata_xml ⇒ String

The metadata XML that your IdP generated.

Returns:

  • (String) 


6613
6614
6615
6616
6617
6618
6619
6620
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6613

class SamlConfiguration < Struct.new(
  :metadata_xml,
  :role_arn,
  :user_id_attribute,
  :user_group_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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:

  • (String) 


6613
6614
6615
6616
6617
6618
6619
6620
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6613

class SamlConfiguration < Struct.new(
  :metadata_xml,
  :role_arn,
  :user_id_attribute,
  :user_group_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#user_group_attribute ⇒ String

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

Returns:

  • (String) 


6613
6614
6615
6616
6617
6618
6619
6620
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6613

class SamlConfiguration < Struct.new(
  :metadata_xml,
  :role_arn,
  :user_id_attribute,
  :user_group_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#user_id_attribute ⇒ String

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

Returns:

  • (String) 


6613
6614
6615
6616
6617
6618
6619
6620
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 6613

class SamlConfiguration < Struct.new(
  :metadata_xml,
  :role_arn,
  :user_id_attribute,
  :user_group_attribute)
  SENSITIVE = []
  include Aws::Structure
end