AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.ElasticLoadBalancingV2.Model.AuthenticateCognitoActionConfig

Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z

Syntax

C#
public class AuthenticateCognitoActionConfig

The AuthenticateCognitoActionConfig type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AuthenticationRequestExtraParams System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property AuthenticationRequestExtraParams.

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

Public Property OnUnauthenticatedRequest Amazon.ElasticLoadBalancingV2.AuthenticateCognitoActionConditionalBehaviorEnum

Gets and sets the property OnUnauthenticatedRequest.

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.

Public Property Scope System.String

Gets and sets the property Scope.

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.

Public Property SessionCookieName System.String

Gets and sets the property SessionCookieName.

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

Public Property SessionTimeout System.Int64

Gets and sets the property SessionTimeout.

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

Public Property UserPoolArn System.String

Gets and sets the property UserPoolArn.

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

Public Property UserPoolClientId System.String

Gets and sets the property UserPoolClientId.

The ID of the Amazon Cognito user pool client.

Public Property UserPoolDomain System.String

Gets and sets the property UserPoolDomain.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5