Struct aws_sdk_elasticloadbalancingv2::types::builders::AuthenticateOidcActionConfigBuilder

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

A builder for AuthenticateOidcActionConfig.

Implementations

impl AuthenticateOidcActionConfigBuilder

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.

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.

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.

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

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.

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

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

pub fn get_authorization_endpoint(&self) -> &Option<String>

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

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.

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.

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.

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.

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.

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.

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

The OAuth 2.0 client identifier.

This field is required.

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

The OAuth 2.0 client identifier.

pub fn get_client_id(&self) -> &Option<String>

The OAuth 2.0 client identifier.

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.

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.

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.

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 get_session_cookie_name(&self) -> &Option<String>

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

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 get_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, 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 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.

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.

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.

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.

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.

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.

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.

pub fn build(self) -> AuthenticateOidcActionConfig

Consumes the builder and constructs a AuthenticateOidcActionConfig.

Trait Implementations

impl Clone for AuthenticateOidcActionConfigBuilder

fn clone(&self) -> AuthenticateOidcActionConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticateOidcActionConfigBuilder

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

Formats the value using the given formatter.

impl Default for AuthenticateOidcActionConfigBuilder

fn default() -> AuthenticateOidcActionConfigBuilder

Returns the “default value” for a type.

impl PartialEq for AuthenticateOidcActionConfigBuilder

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