AWS SDK for C++  1.9.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig Class Reference

#include <AuthenticateOidcActionConfig.h>

Public Member Functions

 AuthenticateOidcActionConfig ()
 
 AuthenticateOidcActionConfig (const Aws::Utils::Xml::XmlNode &xmlNode)
 
AuthenticateOidcActionConfigoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetIssuer () const
 
bool IssuerHasBeenSet () const
 
void SetIssuer (const Aws::String &value)
 
void SetIssuer (Aws::String &&value)
 
void SetIssuer (const char *value)
 
AuthenticateOidcActionConfigWithIssuer (const Aws::String &value)
 
AuthenticateOidcActionConfigWithIssuer (Aws::String &&value)
 
AuthenticateOidcActionConfigWithIssuer (const char *value)
 
const Aws::StringGetAuthorizationEndpoint () const
 
bool AuthorizationEndpointHasBeenSet () const
 
void SetAuthorizationEndpoint (const Aws::String &value)
 
void SetAuthorizationEndpoint (Aws::String &&value)
 
void SetAuthorizationEndpoint (const char *value)
 
AuthenticateOidcActionConfigWithAuthorizationEndpoint (const Aws::String &value)
 
AuthenticateOidcActionConfigWithAuthorizationEndpoint (Aws::String &&value)
 
AuthenticateOidcActionConfigWithAuthorizationEndpoint (const char *value)
 
const Aws::StringGetTokenEndpoint () const
 
bool TokenEndpointHasBeenSet () const
 
void SetTokenEndpoint (const Aws::String &value)
 
void SetTokenEndpoint (Aws::String &&value)
 
void SetTokenEndpoint (const char *value)
 
AuthenticateOidcActionConfigWithTokenEndpoint (const Aws::String &value)
 
AuthenticateOidcActionConfigWithTokenEndpoint (Aws::String &&value)
 
AuthenticateOidcActionConfigWithTokenEndpoint (const char *value)
 
const Aws::StringGetUserInfoEndpoint () const
 
bool UserInfoEndpointHasBeenSet () const
 
void SetUserInfoEndpoint (const Aws::String &value)
 
void SetUserInfoEndpoint (Aws::String &&value)
 
void SetUserInfoEndpoint (const char *value)
 
AuthenticateOidcActionConfigWithUserInfoEndpoint (const Aws::String &value)
 
AuthenticateOidcActionConfigWithUserInfoEndpoint (Aws::String &&value)
 
AuthenticateOidcActionConfigWithUserInfoEndpoint (const char *value)
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
AuthenticateOidcActionConfigWithClientId (const Aws::String &value)
 
AuthenticateOidcActionConfigWithClientId (Aws::String &&value)
 
AuthenticateOidcActionConfigWithClientId (const char *value)
 
const Aws::StringGetClientSecret () const
 
bool ClientSecretHasBeenSet () const
 
void SetClientSecret (const Aws::String &value)
 
void SetClientSecret (Aws::String &&value)
 
void SetClientSecret (const char *value)
 
AuthenticateOidcActionConfigWithClientSecret (const Aws::String &value)
 
AuthenticateOidcActionConfigWithClientSecret (Aws::String &&value)
 
AuthenticateOidcActionConfigWithClientSecret (const char *value)
 
const Aws::StringGetSessionCookieName () const
 
bool SessionCookieNameHasBeenSet () const
 
void SetSessionCookieName (const Aws::String &value)
 
void SetSessionCookieName (Aws::String &&value)
 
void SetSessionCookieName (const char *value)
 
AuthenticateOidcActionConfigWithSessionCookieName (const Aws::String &value)
 
AuthenticateOidcActionConfigWithSessionCookieName (Aws::String &&value)
 
AuthenticateOidcActionConfigWithSessionCookieName (const char *value)
 
const Aws::StringGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const Aws::String &value)
 
void SetScope (Aws::String &&value)
 
void SetScope (const char *value)
 
AuthenticateOidcActionConfigWithScope (const Aws::String &value)
 
AuthenticateOidcActionConfigWithScope (Aws::String &&value)
 
AuthenticateOidcActionConfigWithScope (const char *value)
 
long long GetSessionTimeout () const
 
bool SessionTimeoutHasBeenSet () const
 
void SetSessionTimeout (long long value)
 
AuthenticateOidcActionConfigWithSessionTimeout (long long value)
 
const Aws::Map< Aws::String, Aws::String > & GetAuthenticationRequestExtraParams () const
 
bool AuthenticationRequestExtraParamsHasBeenSet () const
 
void SetAuthenticationRequestExtraParams (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetAuthenticationRequestExtraParams (Aws::Map< Aws::String, Aws::String > &&value)
 
AuthenticateOidcActionConfigWithAuthenticationRequestExtraParams (const Aws::Map< Aws::String, Aws::String > &value)
 
AuthenticateOidcActionConfigWithAuthenticationRequestExtraParams (Aws::Map< Aws::String, Aws::String > &&value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (const Aws::String &key, const Aws::String &value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (Aws::String &&key, const Aws::String &value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (const Aws::String &key, Aws::String &&value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (Aws::String &&key, Aws::String &&value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (const char *key, Aws::String &&value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (Aws::String &&key, const char *value)
 
AuthenticateOidcActionConfigAddAuthenticationRequestExtraParams (const char *key, const char *value)
 
const AuthenticateOidcActionConditionalBehaviorEnumGetOnUnauthenticatedRequest () const
 
bool OnUnauthenticatedRequestHasBeenSet () const
 
void SetOnUnauthenticatedRequest (const AuthenticateOidcActionConditionalBehaviorEnum &value)
 
void SetOnUnauthenticatedRequest (AuthenticateOidcActionConditionalBehaviorEnum &&value)
 
AuthenticateOidcActionConfigWithOnUnauthenticatedRequest (const AuthenticateOidcActionConditionalBehaviorEnum &value)
 
AuthenticateOidcActionConfigWithOnUnauthenticatedRequest (AuthenticateOidcActionConditionalBehaviorEnum &&value)
 
bool GetUseExistingClientSecret () const
 
bool UseExistingClientSecretHasBeenSet () const
 
void SetUseExistingClientSecret (bool value)
 
AuthenticateOidcActionConfigWithUseExistingClientSecret (bool value)
 

Detailed Description

Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

See Also:

AWS API Reference

Definition at line 34 of file AuthenticateOidcActionConfig.h.

Constructor & Destructor Documentation

◆ AuthenticateOidcActionConfig() [1/2]

Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AuthenticateOidcActionConfig ( )

◆ AuthenticateOidcActionConfig() [2/2]

Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AuthenticateOidcActionConfig ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddAuthenticationRequestExtraParams() [1/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 528 of file AuthenticateOidcActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [2/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( Aws::String &&  key,
const Aws::String value 
)
inline

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

Definition at line 516 of file AuthenticateOidcActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [3/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 540 of file AuthenticateOidcActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [4/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( const Aws::String key,
Aws::String &&  value 
)
inline

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

Definition at line 522 of file AuthenticateOidcActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [5/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( const Aws::String key,
const Aws::String value 
)
inline

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

Definition at line 510 of file AuthenticateOidcActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [6/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 534 of file AuthenticateOidcActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [7/7]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AddAuthenticationRequestExtraParams ( const char *  key,
const char *  value 
)
inline

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

Definition at line 546 of file AuthenticateOidcActionConfig.h.

◆ AuthenticationRequestExtraParamsHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AuthenticationRequestExtraParamsHasBeenSet ( ) const
inline

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

Definition at line 480 of file AuthenticateOidcActionConfig.h.

◆ AuthorizationEndpointHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::AuthorizationEndpointHasBeenSet ( ) const
inline

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

Definition at line 104 of file AuthenticateOidcActionConfig.h.

◆ ClientIdHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::ClientIdHasBeenSet ( ) const
inline

The OAuth 2.0 client identifier.

Definition at line 249 of file AuthenticateOidcActionConfig.h.

◆ ClientSecretHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::ClientSecretHasBeenSet ( ) const
inline

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.

Definition at line 294 of file AuthenticateOidcActionConfig.h.

◆ GetAuthenticationRequestExtraParams()

const Aws::Map<Aws::String, Aws::String>& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetAuthenticationRequestExtraParams ( ) const
inline

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

Definition at line 474 of file AuthenticateOidcActionConfig.h.

◆ GetAuthorizationEndpoint()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetAuthorizationEndpoint ( ) const
inline

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

Definition at line 98 of file AuthenticateOidcActionConfig.h.

◆ GetClientId()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetClientId ( ) const
inline

The OAuth 2.0 client identifier.

Definition at line 244 of file AuthenticateOidcActionConfig.h.

◆ GetClientSecret()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetClientSecret ( ) const
inline

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.

Definition at line 287 of file AuthenticateOidcActionConfig.h.

◆ GetIssuer()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetIssuer ( ) const
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 49 of file AuthenticateOidcActionConfig.h.

◆ GetOnUnauthenticatedRequest()

const AuthenticateOidcActionConditionalBehaviorEnum& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetOnUnauthenticatedRequest ( ) const
inline

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.

Definition at line 556 of file AuthenticateOidcActionConfig.h.

◆ GetScope()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetScope ( ) const
inline

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.

Definition at line 393 of file AuthenticateOidcActionConfig.h.

◆ GetSessionCookieName()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetSessionCookieName ( ) const
inline

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

Definition at line 343 of file AuthenticateOidcActionConfig.h.

◆ GetSessionTimeout()

long long Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetSessionTimeout ( ) const
inline

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

Definition at line 449 of file AuthenticateOidcActionConfig.h.

◆ GetTokenEndpoint()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetTokenEndpoint ( ) const
inline

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

Definition at line 147 of file AuthenticateOidcActionConfig.h.

◆ GetUseExistingClientSecret()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetUseExistingClientSecret ( ) const
inline

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.

Definition at line 608 of file AuthenticateOidcActionConfig.h.

◆ GetUserInfoEndpoint()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::GetUserInfoEndpoint ( ) const
inline

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

Definition at line 196 of file AuthenticateOidcActionConfig.h.

◆ IssuerHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::IssuerHasBeenSet ( ) const
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 55 of file AuthenticateOidcActionConfig.h.

◆ OnUnauthenticatedRequestHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::OnUnauthenticatedRequestHasBeenSet ( ) const
inline

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.

Definition at line 565 of file AuthenticateOidcActionConfig.h.

◆ operator=()

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ ScopeHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::ScopeHasBeenSet ( ) const
inline

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.

Definition at line 400 of file AuthenticateOidcActionConfig.h.

◆ SessionCookieNameHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SessionCookieNameHasBeenSet ( ) const
inline

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

Definition at line 349 of file AuthenticateOidcActionConfig.h.

◆ SessionTimeoutHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SessionTimeoutHasBeenSet ( ) const
inline

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

Definition at line 455 of file AuthenticateOidcActionConfig.h.

◆ SetAuthenticationRequestExtraParams() [1/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetAuthenticationRequestExtraParams ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 492 of file AuthenticateOidcActionConfig.h.

◆ SetAuthenticationRequestExtraParams() [2/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetAuthenticationRequestExtraParams ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 486 of file AuthenticateOidcActionConfig.h.

◆ SetAuthorizationEndpoint() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetAuthorizationEndpoint ( Aws::String &&  value)
inline

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

Definition at line 116 of file AuthenticateOidcActionConfig.h.

◆ SetAuthorizationEndpoint() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetAuthorizationEndpoint ( const Aws::String value)
inline

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

Definition at line 110 of file AuthenticateOidcActionConfig.h.

◆ SetAuthorizationEndpoint() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetAuthorizationEndpoint ( const char *  value)
inline

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

Definition at line 122 of file AuthenticateOidcActionConfig.h.

◆ SetClientId() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetClientId ( Aws::String &&  value)
inline

The OAuth 2.0 client identifier.

Definition at line 259 of file AuthenticateOidcActionConfig.h.

◆ SetClientId() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetClientId ( const Aws::String value)
inline

The OAuth 2.0 client identifier.

Definition at line 254 of file AuthenticateOidcActionConfig.h.

◆ SetClientId() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetClientId ( const char *  value)
inline

The OAuth 2.0 client identifier.

Definition at line 264 of file AuthenticateOidcActionConfig.h.

◆ SetClientSecret() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetClientSecret ( Aws::String &&  value)
inline

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.

Definition at line 308 of file AuthenticateOidcActionConfig.h.

◆ SetClientSecret() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetClientSecret ( const Aws::String value)
inline

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.

Definition at line 301 of file AuthenticateOidcActionConfig.h.

◆ SetClientSecret() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetClientSecret ( const char *  value)
inline

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.

Definition at line 315 of file AuthenticateOidcActionConfig.h.

◆ SetIssuer() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetIssuer ( Aws::String &&  value)
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 67 of file AuthenticateOidcActionConfig.h.

◆ SetIssuer() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetIssuer ( const Aws::String value)
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 61 of file AuthenticateOidcActionConfig.h.

◆ SetIssuer() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetIssuer ( const char *  value)
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 73 of file AuthenticateOidcActionConfig.h.

◆ SetOnUnauthenticatedRequest() [1/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetOnUnauthenticatedRequest ( AuthenticateOidcActionConditionalBehaviorEnum &&  value)
inline

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.

Definition at line 583 of file AuthenticateOidcActionConfig.h.

◆ SetOnUnauthenticatedRequest() [2/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetOnUnauthenticatedRequest ( const AuthenticateOidcActionConditionalBehaviorEnum value)
inline

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.

Definition at line 574 of file AuthenticateOidcActionConfig.h.

◆ SetScope() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetScope ( Aws::String &&  value)
inline

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.

Definition at line 414 of file AuthenticateOidcActionConfig.h.

◆ SetScope() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetScope ( const Aws::String value)
inline

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.

Definition at line 407 of file AuthenticateOidcActionConfig.h.

◆ SetScope() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetScope ( const char *  value)
inline

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.

Definition at line 421 of file AuthenticateOidcActionConfig.h.

◆ SetSessionCookieName() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetSessionCookieName ( Aws::String &&  value)
inline

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

Definition at line 361 of file AuthenticateOidcActionConfig.h.

◆ SetSessionCookieName() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetSessionCookieName ( const Aws::String value)
inline

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

Definition at line 355 of file AuthenticateOidcActionConfig.h.

◆ SetSessionCookieName() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetSessionCookieName ( const char *  value)
inline

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

Definition at line 367 of file AuthenticateOidcActionConfig.h.

◆ SetSessionTimeout()

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetSessionTimeout ( long long  value)
inline

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

Definition at line 461 of file AuthenticateOidcActionConfig.h.

◆ SetTokenEndpoint() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetTokenEndpoint ( Aws::String &&  value)
inline

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

Definition at line 165 of file AuthenticateOidcActionConfig.h.

◆ SetTokenEndpoint() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetTokenEndpoint ( const Aws::String value)
inline

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

Definition at line 159 of file AuthenticateOidcActionConfig.h.

◆ SetTokenEndpoint() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetTokenEndpoint ( const char *  value)
inline

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

Definition at line 171 of file AuthenticateOidcActionConfig.h.

◆ SetUseExistingClientSecret()

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetUseExistingClientSecret ( bool  value)
inline

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.

Definition at line 620 of file AuthenticateOidcActionConfig.h.

◆ SetUserInfoEndpoint() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetUserInfoEndpoint ( Aws::String &&  value)
inline

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

Definition at line 214 of file AuthenticateOidcActionConfig.h.

◆ SetUserInfoEndpoint() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetUserInfoEndpoint ( const Aws::String value)
inline

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

Definition at line 208 of file AuthenticateOidcActionConfig.h.

◆ SetUserInfoEndpoint() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::SetUserInfoEndpoint ( const char *  value)
inline

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

Definition at line 220 of file AuthenticateOidcActionConfig.h.

◆ TokenEndpointHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::TokenEndpointHasBeenSet ( ) const
inline

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

Definition at line 153 of file AuthenticateOidcActionConfig.h.

◆ UseExistingClientSecretHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::UseExistingClientSecretHasBeenSet ( ) const
inline

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.

Definition at line 614 of file AuthenticateOidcActionConfig.h.

◆ UserInfoEndpointHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::UserInfoEndpointHasBeenSet ( ) const
inline

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

Definition at line 202 of file AuthenticateOidcActionConfig.h.

◆ WithAuthenticationRequestExtraParams() [1/2]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithAuthenticationRequestExtraParams ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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

Definition at line 504 of file AuthenticateOidcActionConfig.h.

◆ WithAuthenticationRequestExtraParams() [2/2]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithAuthenticationRequestExtraParams ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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

Definition at line 498 of file AuthenticateOidcActionConfig.h.

◆ WithAuthorizationEndpoint() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithAuthorizationEndpoint ( Aws::String &&  value)
inline

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

Definition at line 134 of file AuthenticateOidcActionConfig.h.

◆ WithAuthorizationEndpoint() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithAuthorizationEndpoint ( const Aws::String value)
inline

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

Definition at line 128 of file AuthenticateOidcActionConfig.h.

◆ WithAuthorizationEndpoint() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithAuthorizationEndpoint ( const char *  value)
inline

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

Definition at line 140 of file AuthenticateOidcActionConfig.h.

◆ WithClientId() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithClientId ( Aws::String &&  value)
inline

The OAuth 2.0 client identifier.

Definition at line 274 of file AuthenticateOidcActionConfig.h.

◆ WithClientId() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithClientId ( const Aws::String value)
inline

The OAuth 2.0 client identifier.

Definition at line 269 of file AuthenticateOidcActionConfig.h.

◆ WithClientId() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithClientId ( const char *  value)
inline

The OAuth 2.0 client identifier.

Definition at line 279 of file AuthenticateOidcActionConfig.h.

◆ WithClientSecret() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithClientSecret ( Aws::String &&  value)
inline

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.

Definition at line 329 of file AuthenticateOidcActionConfig.h.

◆ WithClientSecret() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithClientSecret ( const Aws::String value)
inline

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.

Definition at line 322 of file AuthenticateOidcActionConfig.h.

◆ WithClientSecret() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithClientSecret ( const char *  value)
inline

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.

Definition at line 336 of file AuthenticateOidcActionConfig.h.

◆ WithIssuer() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithIssuer ( Aws::String &&  value)
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 85 of file AuthenticateOidcActionConfig.h.

◆ WithIssuer() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithIssuer ( const Aws::String value)
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 79 of file AuthenticateOidcActionConfig.h.

◆ WithIssuer() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithIssuer ( const char *  value)
inline

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Definition at line 91 of file AuthenticateOidcActionConfig.h.

◆ WithOnUnauthenticatedRequest() [1/2]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithOnUnauthenticatedRequest ( AuthenticateOidcActionConditionalBehaviorEnum &&  value)
inline

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.

Definition at line 601 of file AuthenticateOidcActionConfig.h.

◆ WithOnUnauthenticatedRequest() [2/2]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithOnUnauthenticatedRequest ( const AuthenticateOidcActionConditionalBehaviorEnum value)
inline

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.

Definition at line 592 of file AuthenticateOidcActionConfig.h.

◆ WithScope() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithScope ( Aws::String &&  value)
inline

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.

Definition at line 435 of file AuthenticateOidcActionConfig.h.

◆ WithScope() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithScope ( const Aws::String value)
inline

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.

Definition at line 428 of file AuthenticateOidcActionConfig.h.

◆ WithScope() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithScope ( const char *  value)
inline

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.

Definition at line 442 of file AuthenticateOidcActionConfig.h.

◆ WithSessionCookieName() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithSessionCookieName ( Aws::String &&  value)
inline

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

Definition at line 379 of file AuthenticateOidcActionConfig.h.

◆ WithSessionCookieName() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithSessionCookieName ( const Aws::String value)
inline

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

Definition at line 373 of file AuthenticateOidcActionConfig.h.

◆ WithSessionCookieName() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithSessionCookieName ( const char *  value)
inline

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

Definition at line 385 of file AuthenticateOidcActionConfig.h.

◆ WithSessionTimeout()

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithSessionTimeout ( long long  value)
inline

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

Definition at line 467 of file AuthenticateOidcActionConfig.h.

◆ WithTokenEndpoint() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithTokenEndpoint ( Aws::String &&  value)
inline

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

Definition at line 183 of file AuthenticateOidcActionConfig.h.

◆ WithTokenEndpoint() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithTokenEndpoint ( const Aws::String value)
inline

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

Definition at line 177 of file AuthenticateOidcActionConfig.h.

◆ WithTokenEndpoint() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithTokenEndpoint ( const char *  value)
inline

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

Definition at line 189 of file AuthenticateOidcActionConfig.h.

◆ WithUseExistingClientSecret()

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithUseExistingClientSecret ( bool  value)
inline

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.

Definition at line 626 of file AuthenticateOidcActionConfig.h.

◆ WithUserInfoEndpoint() [1/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithUserInfoEndpoint ( Aws::String &&  value)
inline

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

Definition at line 232 of file AuthenticateOidcActionConfig.h.

◆ WithUserInfoEndpoint() [2/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithUserInfoEndpoint ( const Aws::String value)
inline

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

Definition at line 226 of file AuthenticateOidcActionConfig.h.

◆ WithUserInfoEndpoint() [3/3]

AuthenticateOidcActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateOidcActionConfig::WithUserInfoEndpoint ( const char *  value)
inline

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

Definition at line 238 of file AuthenticateOidcActionConfig.h.


The documentation for this class was generated from the following file: