Struct aws_sdk_opensearch::model::CognitoOptions

#[non_exhaustive]
pub struct CognitoOptions { /* private fields */ }

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.

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() -> Builder

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<CognitoOptions> 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