Struct aws_sdk_elasticloadbalancingv2::model::authenticate_cognito_action_config::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for AuthenticateCognitoActionConfig

Implementations

impl Builder

pub fn user_pool_arn(self, input: impl Into<String>) -> Self

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

pub fn set_user_pool_arn(self, input: Option<String>) -> Self

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

pub fn user_pool_client_id(self, input: impl Into<String>) -> Self

The ID of the Amazon Cognito user pool client.

pub fn set_user_pool_client_id(self, input: Option<String>) -> Self

The ID of the Amazon Cognito user pool client.

pub fn user_pool_domain(self, input: impl Into<String>) -> Self

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

pub fn set_user_pool_domain(self, input: Option<String>) -> Self

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

pub fn session_cookie_name(self, input: impl Into<String>) -> Self

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

pub fn set_session_cookie_name(self, input: Option<String>) -> Self

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

pub fn scope(self, input: impl Into<String>) -> Self

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 set_scope(self, input: Option<String>) -> Self

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, input: i64) -> Self

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

pub fn set_session_timeout(self, input: Option<i64>) -> Self

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

pub fn authentication_request_extra_params(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to authentication_request_extra_params.

To override the contents of this collection use set_authentication_request_extra_params.

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

pub fn set_authentication_request_extra_params(
    self,
    input: Option<HashMap<String, String>>
) -> Self

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

pub fn on_unauthenticated_request(
    self,
    input: AuthenticateCognitoActionConditionalBehaviorEnum
) -> Self

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.

pub fn set_on_unauthenticated_request(
    self,
    input: Option<AuthenticateCognitoActionConditionalBehaviorEnum>
) -> Self

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.

pub fn build(self) -> AuthenticateCognitoActionConfig

Consumes the builder and constructs a AuthenticateCognitoActionConfig

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Builder