pub struct Builder { /* private fields */ }
Expand description
A builder for AuthenticateOidcActionConfig
.
Implementations
sourceimpl Builder
impl Builder
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.
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.
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.
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 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.
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 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 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.
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 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 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 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 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 build(self) -> AuthenticateOidcActionConfig
pub fn build(self) -> AuthenticateOidcActionConfig
Consumes the builder and constructs a AuthenticateOidcActionConfig
.