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

#include <AuthenticateCognitoActionConfig.h>

Public Member Functions

 AuthenticateCognitoActionConfig ()
 
 AuthenticateCognitoActionConfig (const Aws::Utils::Xml::XmlNode &xmlNode)
 
AuthenticateCognitoActionConfigoperator= (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::StringGetUserPoolArn () const
 
bool UserPoolArnHasBeenSet () const
 
void SetUserPoolArn (const Aws::String &value)
 
void SetUserPoolArn (Aws::String &&value)
 
void SetUserPoolArn (const char *value)
 
AuthenticateCognitoActionConfigWithUserPoolArn (const Aws::String &value)
 
AuthenticateCognitoActionConfigWithUserPoolArn (Aws::String &&value)
 
AuthenticateCognitoActionConfigWithUserPoolArn (const char *value)
 
const Aws::StringGetUserPoolClientId () const
 
bool UserPoolClientIdHasBeenSet () const
 
void SetUserPoolClientId (const Aws::String &value)
 
void SetUserPoolClientId (Aws::String &&value)
 
void SetUserPoolClientId (const char *value)
 
AuthenticateCognitoActionConfigWithUserPoolClientId (const Aws::String &value)
 
AuthenticateCognitoActionConfigWithUserPoolClientId (Aws::String &&value)
 
AuthenticateCognitoActionConfigWithUserPoolClientId (const char *value)
 
const Aws::StringGetUserPoolDomain () const
 
bool UserPoolDomainHasBeenSet () const
 
void SetUserPoolDomain (const Aws::String &value)
 
void SetUserPoolDomain (Aws::String &&value)
 
void SetUserPoolDomain (const char *value)
 
AuthenticateCognitoActionConfigWithUserPoolDomain (const Aws::String &value)
 
AuthenticateCognitoActionConfigWithUserPoolDomain (Aws::String &&value)
 
AuthenticateCognitoActionConfigWithUserPoolDomain (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)
 
AuthenticateCognitoActionConfigWithSessionCookieName (const Aws::String &value)
 
AuthenticateCognitoActionConfigWithSessionCookieName (Aws::String &&value)
 
AuthenticateCognitoActionConfigWithSessionCookieName (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)
 
AuthenticateCognitoActionConfigWithScope (const Aws::String &value)
 
AuthenticateCognitoActionConfigWithScope (Aws::String &&value)
 
AuthenticateCognitoActionConfigWithScope (const char *value)
 
long long GetSessionTimeout () const
 
bool SessionTimeoutHasBeenSet () const
 
void SetSessionTimeout (long long value)
 
AuthenticateCognitoActionConfigWithSessionTimeout (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)
 
AuthenticateCognitoActionConfigWithAuthenticationRequestExtraParams (const Aws::Map< Aws::String, Aws::String > &value)
 
AuthenticateCognitoActionConfigWithAuthenticationRequestExtraParams (Aws::Map< Aws::String, Aws::String > &&value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (const Aws::String &key, const Aws::String &value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (Aws::String &&key, const Aws::String &value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (const Aws::String &key, Aws::String &&value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (Aws::String &&key, Aws::String &&value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (const char *key, Aws::String &&value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (Aws::String &&key, const char *value)
 
AuthenticateCognitoActionConfigAddAuthenticationRequestExtraParams (const char *key, const char *value)
 
const AuthenticateCognitoActionConditionalBehaviorEnumGetOnUnauthenticatedRequest () const
 
bool OnUnauthenticatedRequestHasBeenSet () const
 
void SetOnUnauthenticatedRequest (const AuthenticateCognitoActionConditionalBehaviorEnum &value)
 
void SetOnUnauthenticatedRequest (AuthenticateCognitoActionConditionalBehaviorEnum &&value)
 
AuthenticateCognitoActionConfigWithOnUnauthenticatedRequest (const AuthenticateCognitoActionConditionalBehaviorEnum &value)
 
AuthenticateCognitoActionConfigWithOnUnauthenticatedRequest (AuthenticateCognitoActionConditionalBehaviorEnum &&value)
 

Detailed Description

Request parameters to use when integrating with Amazon Cognito to authenticate users.

See Also:

AWS API Reference

Definition at line 34 of file AuthenticateCognitoActionConfig.h.

Constructor & Destructor Documentation

◆ AuthenticateCognitoActionConfig() [1/2]

Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::AuthenticateCognitoActionConfig ( )

◆ AuthenticateCognitoActionConfig() [2/2]

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

Member Function Documentation

◆ AddAuthenticationRequestExtraParams() [1/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 365 of file AuthenticateCognitoActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [2/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 353 of file AuthenticateCognitoActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [3/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 377 of file AuthenticateCognitoActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [4/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 359 of file AuthenticateCognitoActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [5/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 347 of file AuthenticateCognitoActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [6/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 371 of file AuthenticateCognitoActionConfig.h.

◆ AddAuthenticationRequestExtraParams() [7/7]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 383 of file AuthenticateCognitoActionConfig.h.

◆ AuthenticationRequestExtraParamsHasBeenSet()

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

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

Definition at line 317 of file AuthenticateCognitoActionConfig.h.

◆ GetAuthenticationRequestExtraParams()

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

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

Definition at line 311 of file AuthenticateCognitoActionConfig.h.

◆ GetOnUnauthenticatedRequest()

const AuthenticateCognitoActionConditionalBehaviorEnum& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 393 of file AuthenticateCognitoActionConfig.h.

◆ GetScope()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 230 of file AuthenticateCognitoActionConfig.h.

◆ GetSessionCookieName()

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

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

Definition at line 180 of file AuthenticateCognitoActionConfig.h.

◆ GetSessionTimeout()

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

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

Definition at line 286 of file AuthenticateCognitoActionConfig.h.

◆ GetUserPoolArn()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::GetUserPoolArn ( ) const
inline

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

Definition at line 48 of file AuthenticateCognitoActionConfig.h.

◆ GetUserPoolClientId()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::GetUserPoolClientId ( ) const
inline

The ID of the Amazon Cognito user pool client.

Definition at line 89 of file AuthenticateCognitoActionConfig.h.

◆ GetUserPoolDomain()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::GetUserPoolDomain ( ) const
inline

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

Definition at line 131 of file AuthenticateCognitoActionConfig.h.

◆ OnUnauthenticatedRequestHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 402 of file AuthenticateCognitoActionConfig.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ ScopeHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 237 of file AuthenticateCognitoActionConfig.h.

◆ SessionCookieNameHasBeenSet()

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

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

Definition at line 186 of file AuthenticateCognitoActionConfig.h.

◆ SessionTimeoutHasBeenSet()

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

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

Definition at line 292 of file AuthenticateCognitoActionConfig.h.

◆ SetAuthenticationRequestExtraParams() [1/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 329 of file AuthenticateCognitoActionConfig.h.

◆ SetAuthenticationRequestExtraParams() [2/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 323 of file AuthenticateCognitoActionConfig.h.

◆ SetOnUnauthenticatedRequest() [1/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetOnUnauthenticatedRequest ( AuthenticateCognitoActionConditionalBehaviorEnum &&  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 420 of file AuthenticateCognitoActionConfig.h.

◆ SetOnUnauthenticatedRequest() [2/2]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetOnUnauthenticatedRequest ( const AuthenticateCognitoActionConditionalBehaviorEnum 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 411 of file AuthenticateCognitoActionConfig.h.

◆ SetScope() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 251 of file AuthenticateCognitoActionConfig.h.

◆ SetScope() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 244 of file AuthenticateCognitoActionConfig.h.

◆ SetScope() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 258 of file AuthenticateCognitoActionConfig.h.

◆ SetSessionCookieName() [1/3]

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

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

Definition at line 198 of file AuthenticateCognitoActionConfig.h.

◆ SetSessionCookieName() [2/3]

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

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

Definition at line 192 of file AuthenticateCognitoActionConfig.h.

◆ SetSessionCookieName() [3/3]

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

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

Definition at line 204 of file AuthenticateCognitoActionConfig.h.

◆ SetSessionTimeout()

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

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

Definition at line 298 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolArn() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolArn ( Aws::String &&  value)
inline

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

Definition at line 63 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolArn() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolArn ( const Aws::String value)
inline

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

Definition at line 58 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolArn() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolArn ( const char *  value)
inline

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

Definition at line 68 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolClientId() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolClientId ( Aws::String &&  value)
inline

The ID of the Amazon Cognito user pool client.

Definition at line 104 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolClientId() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolClientId ( const Aws::String value)
inline

The ID of the Amazon Cognito user pool client.

Definition at line 99 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolClientId() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolClientId ( const char *  value)
inline

The ID of the Amazon Cognito user pool client.

Definition at line 109 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolDomain() [1/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolDomain ( Aws::String &&  value)
inline

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

Definition at line 149 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolDomain() [2/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolDomain ( const Aws::String value)
inline

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

Definition at line 143 of file AuthenticateCognitoActionConfig.h.

◆ SetUserPoolDomain() [3/3]

void Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::SetUserPoolDomain ( const char *  value)
inline

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

Definition at line 155 of file AuthenticateCognitoActionConfig.h.

◆ UserPoolArnHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::UserPoolArnHasBeenSet ( ) const
inline

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

Definition at line 53 of file AuthenticateCognitoActionConfig.h.

◆ UserPoolClientIdHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::UserPoolClientIdHasBeenSet ( ) const
inline

The ID of the Amazon Cognito user pool client.

Definition at line 94 of file AuthenticateCognitoActionConfig.h.

◆ UserPoolDomainHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::UserPoolDomainHasBeenSet ( ) const
inline

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

Definition at line 137 of file AuthenticateCognitoActionConfig.h.

◆ WithAuthenticationRequestExtraParams() [1/2]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 341 of file AuthenticateCognitoActionConfig.h.

◆ WithAuthenticationRequestExtraParams() [2/2]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 335 of file AuthenticateCognitoActionConfig.h.

◆ WithOnUnauthenticatedRequest() [1/2]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithOnUnauthenticatedRequest ( AuthenticateCognitoActionConditionalBehaviorEnum &&  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 438 of file AuthenticateCognitoActionConfig.h.

◆ WithOnUnauthenticatedRequest() [2/2]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithOnUnauthenticatedRequest ( const AuthenticateCognitoActionConditionalBehaviorEnum 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 429 of file AuthenticateCognitoActionConfig.h.

◆ WithScope() [1/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 272 of file AuthenticateCognitoActionConfig.h.

◆ WithScope() [2/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 265 of file AuthenticateCognitoActionConfig.h.

◆ WithScope() [3/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::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 279 of file AuthenticateCognitoActionConfig.h.

◆ WithSessionCookieName() [1/3]

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

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

Definition at line 216 of file AuthenticateCognitoActionConfig.h.

◆ WithSessionCookieName() [2/3]

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

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

Definition at line 210 of file AuthenticateCognitoActionConfig.h.

◆ WithSessionCookieName() [3/3]

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

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

Definition at line 222 of file AuthenticateCognitoActionConfig.h.

◆ WithSessionTimeout()

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

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

Definition at line 304 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolArn() [1/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolArn ( Aws::String &&  value)
inline

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

Definition at line 78 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolArn() [2/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolArn ( const Aws::String value)
inline

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

Definition at line 73 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolArn() [3/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolArn ( const char *  value)
inline

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

Definition at line 83 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolClientId() [1/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolClientId ( Aws::String &&  value)
inline

The ID of the Amazon Cognito user pool client.

Definition at line 119 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolClientId() [2/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolClientId ( const Aws::String value)
inline

The ID of the Amazon Cognito user pool client.

Definition at line 114 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolClientId() [3/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolClientId ( const char *  value)
inline

The ID of the Amazon Cognito user pool client.

Definition at line 124 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolDomain() [1/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolDomain ( Aws::String &&  value)
inline

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

Definition at line 167 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolDomain() [2/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolDomain ( const Aws::String value)
inline

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

Definition at line 161 of file AuthenticateCognitoActionConfig.h.

◆ WithUserPoolDomain() [3/3]

AuthenticateCognitoActionConfig& Aws::ElasticLoadBalancingv2::Model::AuthenticateCognitoActionConfig::WithUserPoolDomain ( const char *  value)
inline

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

Definition at line 173 of file AuthenticateCognitoActionConfig.h.


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