#[non_exhaustive]pub struct AuthenticateOidcActionConfigBuilder { /* private fields */ }
Expand description
A builder for AuthenticateOidcActionConfig
.
Implementations§
Source§impl AuthenticateOidcActionConfigBuilder
impl AuthenticateOidcActionConfigBuilder
Sourcepub fn issuer(self, input: impl Into<String>) -> Self
pub fn issuer(self, input: impl Into<String>) -> Self
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
This field is required.Sourcepub fn set_issuer(self, input: Option<String>) -> Self
pub fn set_issuer(self, input: Option<String>) -> Self
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
Sourcepub fn get_issuer(&self) -> &Option<String>
pub fn get_issuer(&self) -> &Option<String>
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
This field is required.The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
Sourcepub fn token_endpoint(self, input: impl Into<String>) -> Self
pub fn token_endpoint(self, input: impl Into<String>) -> Self
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
This field is required.Sourcepub fn set_token_endpoint(self, input: Option<String>) -> Self
pub fn set_token_endpoint(self, input: Option<String>) -> Self
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
Sourcepub fn get_token_endpoint(&self) -> &Option<String>
pub fn get_token_endpoint(&self) -> &Option<String>
The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
Sourcepub fn user_info_endpoint(self, input: impl Into<String>) -> Self
pub fn user_info_endpoint(self, input: impl Into<String>) -> Self
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
This field is required.Sourcepub fn set_user_info_endpoint(self, input: Option<String>) -> Self
pub fn set_user_info_endpoint(self, input: Option<String>) -> Self
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
Sourcepub fn get_user_info_endpoint(&self) -> &Option<String>
pub fn get_user_info_endpoint(&self) -> &Option<String>
The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
Sourcepub fn client_id(self, input: impl Into<String>) -> Self
pub fn client_id(self, input: impl Into<String>) -> Self
The OAuth 2.0 client identifier.
This field is required.Sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The OAuth 2.0 client identifier.
Sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The OAuth 2.0 client identifier.
Sourcepub fn client_secret(self, input: impl Into<String>) -> Self
pub fn client_secret(self, input: impl Into<String>) -> Self
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret
to true.
Sourcepub fn set_client_secret(self, input: Option<String>) -> Self
pub fn set_client_secret(self, input: Option<String>) -> Self
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret
to true.
Sourcepub fn get_client_secret(&self) -> &Option<String>
pub fn get_client_secret(&self) -> &Option<String>
The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret
to true.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
Sourcepub fn scope(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_scope(self, input: Option<String>) -> Self
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.
Sourcepub fn get_scope(&self) -> &Option<String>
pub fn get_scope(&self) -> &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.
Sourcepub fn session_timeout(self, input: i64) -> Self
pub fn session_timeout(self, input: i64) -> Self
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
Sourcepub fn set_session_timeout(self, input: Option<i64>) -> Self
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).
Sourcepub fn get_session_timeout(&self) -> &Option<i64>
pub fn get_session_timeout(&self) -> &Option<i64>
The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
Sourcepub fn authentication_request_extra_params(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
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.
Sourcepub fn set_authentication_request_extra_params(
self,
input: Option<HashMap<String, String>>,
) -> Self
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.
Sourcepub fn get_authentication_request_extra_params(
&self,
) -> &Option<HashMap<String, String>>
pub fn get_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.
Sourcepub fn on_unauthenticated_request(
self,
input: AuthenticateOidcActionConditionalBehaviorEnum,
) -> Self
pub fn on_unauthenticated_request( self, input: AuthenticateOidcActionConditionalBehaviorEnum, ) -> 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.
Sourcepub fn set_on_unauthenticated_request(
self,
input: Option<AuthenticateOidcActionConditionalBehaviorEnum>,
) -> Self
pub fn set_on_unauthenticated_request( self, input: Option<AuthenticateOidcActionConditionalBehaviorEnum>, ) -> 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.
Sourcepub fn get_on_unauthenticated_request(
&self,
) -> &Option<AuthenticateOidcActionConditionalBehaviorEnum>
pub fn get_on_unauthenticated_request( &self, ) -> &Option<AuthenticateOidcActionConditionalBehaviorEnum>
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.
Sourcepub fn use_existing_client_secret(self, input: bool) -> Self
pub fn use_existing_client_secret(self, input: bool) -> Self
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
Sourcepub fn set_use_existing_client_secret(self, input: Option<bool>) -> Self
pub fn set_use_existing_client_secret(self, input: Option<bool>) -> Self
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
Sourcepub fn get_use_existing_client_secret(&self) -> &Option<bool>
pub fn get_use_existing_client_secret(&self) -> &Option<bool>
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.
Sourcepub fn build(self) -> AuthenticateOidcActionConfig
pub fn build(self) -> AuthenticateOidcActionConfig
Consumes the builder and constructs a AuthenticateOidcActionConfig
.
Trait Implementations§
Source§impl Clone for AuthenticateOidcActionConfigBuilder
impl Clone for AuthenticateOidcActionConfigBuilder
Source§fn clone(&self) -> AuthenticateOidcActionConfigBuilder
fn clone(&self) -> AuthenticateOidcActionConfigBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for AuthenticateOidcActionConfigBuilder
impl Default for AuthenticateOidcActionConfigBuilder
Source§fn default() -> AuthenticateOidcActionConfigBuilder
fn default() -> AuthenticateOidcActionConfigBuilder
Source§impl PartialEq for AuthenticateOidcActionConfigBuilder
impl PartialEq for AuthenticateOidcActionConfigBuilder
Source§fn eq(&self, other: &AuthenticateOidcActionConfigBuilder) -> bool
fn eq(&self, other: &AuthenticateOidcActionConfigBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AuthenticateOidcActionConfigBuilder
Auto Trait Implementations§
impl Freeze for AuthenticateOidcActionConfigBuilder
impl RefUnwindSafe for AuthenticateOidcActionConfigBuilder
impl Send for AuthenticateOidcActionConfigBuilder
impl Sync for AuthenticateOidcActionConfigBuilder
impl Unpin for AuthenticateOidcActionConfigBuilder
impl UnwindSafe for AuthenticateOidcActionConfigBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);