Struct AuthenticateCognitoActionConfig

#[non_exhaustive]
pub struct AuthenticateCognitoActionConfig {
    pub user_pool_arn: Option<String>,
    pub user_pool_client_id: Option<String>,
    pub user_pool_domain: Option<String>,
    pub session_cookie_name: Option<String>,
    pub scope: Option<String>,
    pub session_timeout: Option<i64>,
    pub authentication_request_extra_params: Option<HashMap<String, String>>,
    pub on_unauthenticated_request: Option<AuthenticateCognitoActionConditionalBehaviorEnum>,
}

Request parameters to use when integrating with Amazon Cognito to authenticate users.

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.

user_pool_arn: Option<String>

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

user_pool_client_id: Option<String>

The ID of the Amazon Cognito user pool client.

user_pool_domain: Option<String>

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

session_cookie_name: Option<String>

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

scope: Option<String>

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

session_timeout: Option<i64>

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

authentication_request_extra_params: Option<HashMap<String, String>>

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

on_unauthenticated_request: Option<AuthenticateCognitoActionConditionalBehaviorEnum>

The behavior if the user is not authenticated. The following are possible values:

• deny - Return an HTTP 401 Unauthorized error.

• allow - Allow the request to be forwarded to the target.

• authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

Implementations

impl AuthenticateCognitoActionConfig

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

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

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

The ID of the Amazon Cognito user pool client.

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

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

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

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

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

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

pub fn session_timeout(&self) -> Option<i64>

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

pub fn authentication_request_extra_params( &self, ) -> Option<&HashMap<String, String>>

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

pub fn on_unauthenticated_request( &self, ) -> Option<&AuthenticateCognitoActionConditionalBehaviorEnum>

The behavior if the user is not authenticated. The following are possible values:

• deny - Return an HTTP 401 Unauthorized error.

• allow - Allow the request to be forwarded to the target.

• authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

impl AuthenticateCognitoActionConfig

pub fn builder() -> AuthenticateCognitoActionConfigBuilder

Creates a new builder-style object to manufacture AuthenticateCognitoActionConfig.

Trait Implementations

impl Clone for AuthenticateCognitoActionConfig

fn clone(&self) -> AuthenticateCognitoActionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticateCognitoActionConfig

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

Formats the value using the given formatter.

impl PartialEq for AuthenticateCognitoActionConfig

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