Struct IdentityCenterOptions

#[non_exhaustive]
pub struct IdentityCenterOptions {
    pub enabled_api_access: Option<bool>,
    pub identity_center_instance_arn: Option<String>,
    pub subject_key: Option<SubjectKeyIdCOption>,
    pub roles_key: Option<RolesKeyIdCOption>,
    pub identity_center_application_arn: Option<String>,
    pub identity_store_id: Option<String>,
}

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

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_api_access: Option<bool>

Indicates whether IAM Identity Center is enabled for the application.

identity_center_instance_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

subject_key: Option<SubjectKeyIdCOption>

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

roles_key: Option<RolesKeyIdCOption>

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

identity_center_application_arn: Option<String>

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

identity_store_id: Option<String>

The identifier of the IAM Identity Store.

Implementations

impl IdentityCenterOptions

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

Indicates whether IAM Identity Center is enabled for the application.

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

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

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

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

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

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

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

The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

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

The identifier of the IAM Identity Store.

impl IdentityCenterOptions

pub fn builder() -> IdentityCenterOptionsBuilder

Creates a new builder-style object to manufacture IdentityCenterOptions.

Trait Implementations

impl Clone for IdentityCenterOptions

fn clone(&self) -> IdentityCenterOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityCenterOptions

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

Formats the value using the given formatter.

impl PartialEq for IdentityCenterOptions

fn eq(&self, other: &IdentityCenterOptions) -> 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 IdentityCenterOptions