Struct aws_sdk_qbusiness::types::SamlConfiguration

#[non_exhaustive]
pub struct SamlConfiguration {
    pub metadata_xml: String,
    pub role_arn: String,
    pub user_id_attribute: String,
    pub user_group_attribute: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

metadata_xml: String

The metadata XML that your IdP generated.

role_arn: String

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

user_id_attribute: String

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

user_group_attribute: Option<String>

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

Implementations

impl SamlConfiguration

pub fn metadata_xml(&self) -> &str

The metadata XML that your IdP generated.

pub fn role_arn(&self) -> &str

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

pub fn user_id_attribute(&self) -> &str

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

pub fn user_group_attribute(&self) -> Option<&str>

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

impl SamlConfiguration

pub fn builder() -> SamlConfigurationBuilder

Creates a new builder-style object to manufacture SamlConfiguration.

Trait Implementations

impl Clone for SamlConfiguration

fn clone(&self) -> SamlConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SamlConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SamlConfiguration

fn eq(&self, other: &SamlConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SamlConfiguration