Struct SamlOptionsInput

#[non_exhaustive]
pub struct SamlOptionsInput {
    pub enabled: Option<bool>,
    pub idp: Option<SamlIdp>,
    pub master_user_name: Option<String>,
    pub master_backend_role: Option<String>,
    pub subject_key: Option<String>,
    pub roles_key: Option<String>,
    pub session_timeout_minutes: Option<i32>,
}

The SAML authentication configuration for an Amazon OpenSearch Service domain.

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.

enabled: Option<bool>

True to enable SAML authentication for a domain.

idp: Option<SamlIdp>

The SAML Identity Provider's information.

master_user_name: Option<String>

The SAML master user name, which is stored in the domain's internal user database.

master_backend_role: Option<String>

The backend role that the SAML master user is mapped to.

subject_key: Option<String>

Element of the SAML assertion to use for the user name. Default is NameID.

roles_key: Option<String>

Element of the SAML assertion to use for backend roles. Default is roles.

session_timeout_minutes: Option<i32>

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

Implementations

impl SamlOptionsInput

pub fn enabled(&self) -> Option<bool>

True to enable SAML authentication for a domain.

pub fn idp(&self) -> Option<&SamlIdp>

The SAML Identity Provider's information.

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

The SAML master user name, which is stored in the domain's internal user database.

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

The backend role that the SAML master user is mapped to.

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

Element of the SAML assertion to use for the user name. Default is NameID.

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

Element of the SAML assertion to use for backend roles. Default is roles.

pub fn session_timeout_minutes(&self) -> Option<i32>

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

impl SamlOptionsInput

pub fn builder() -> SamlOptionsInputBuilder

Creates a new builder-style object to manufacture SamlOptionsInput.

Trait Implementations

impl Clone for SamlOptionsInput

fn clone(&self) -> SamlOptionsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamlOptionsInput

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

Formats the value using the given formatter.

impl PartialEq for SamlOptionsInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SamlOptionsInput