Struct aws_sdk_opensearch::types::CognitoOptions

#[non_exhaustive]
pub struct CognitoOptions {
    pub enabled: Option<bool>,
    pub user_pool_id: Option<String>,
    pub identity_pool_id: Option<String>,
    pub role_arn: Option<String>,
}

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

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>

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

user_pool_id: Option<String>

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

identity_pool_id: Option<String>

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

role_arn: Option<String>

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

Implementations

impl CognitoOptions

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

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

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

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

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

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

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

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

impl CognitoOptions

pub fn builder() -> CognitoOptionsBuilder

Creates a new builder-style object to manufacture CognitoOptions.

Trait Implementations

impl Clone for CognitoOptions

fn clone(&self) -> CognitoOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CognitoOptions

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

Formats the value using the given formatter.

impl PartialEq for CognitoOptions

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