Class CfnListenerRule.AuthenticateCognitoConfigProperty
Specifies information required when integrating with Amazon Cognito to authenticate users.
Inheritance
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AuthenticateCognitoConfigProperty : Object, CfnListenerRule.IAuthenticateCognitoConfigPropertySyntax (vb)
Public Class AuthenticateCognitoConfigProperty
Inherits Object
Implements CfnListenerRule.IAuthenticateCognitoConfigPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
var authenticateCognitoConfigProperty = new AuthenticateCognitoConfigProperty {
UserPoolArn = "userPoolArn",
UserPoolClientId = "userPoolClientId",
UserPoolDomain = "userPoolDomain",
// the properties below are optional
AuthenticationRequestExtraParams = new Dictionary<string, string> {
{ "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
},
OnUnauthenticatedRequest = "onUnauthenticatedRequest",
Scope = "scope",
SessionCookieName = "sessionCookieName",
SessionTimeout = 123
};Synopsis
Constructors
| Authenticate |
Properties
| Authentication |
The query parameters (up to 10) to include in the redirect request to the authorization endpoint. |
| On |
The behavior if the user is not authenticated. The following are possible values:. |
| Scope | The set of user claims to be requested from the IdP. The default is |
| Session |
The name of the cookie used to maintain session information. |
| Session |
The maximum duration of the authentication session, in seconds. |
| User |
The Amazon Resource Name (ARN) of the Amazon Cognito user pool. |
| User |
The ID of the Amazon Cognito user pool client. |
| User |
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. |
Constructors
AuthenticateCognitoConfigProperty()
public AuthenticateCognitoConfigProperty()Properties
AuthenticationRequestExtraParams
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
public object AuthenticationRequestExtraParams { get; set; }Property Value
System.
Remarks
OnUnauthenticatedRequest
The behavior if the user is not authenticated. The following are possible values:.
public string OnUnauthenticatedRequest { get; set; }Property Value
System.
Remarks
Scope
The set of user claims to be requested from the IdP. The default is openid .
public string Scope { get; set; }Property Value
System.
Remarks
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
SessionCookieName
The name of the cookie used to maintain session information.
public string SessionCookieName { get; set; }Property Value
System.
Remarks
SessionTimeout
The maximum duration of the authentication session, in seconds.
public Nullable<double> SessionTimeout { get; set; }Property Value
System.
Remarks
UserPoolArn
The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
public string UserPoolArn { get; set; }Property Value
System.
Remarks
UserPoolClientId
The ID of the Amazon Cognito user pool client.
public string UserPoolClientId { get; set; }Property Value
System.
Remarks
UserPoolDomain
The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
public string UserPoolDomain { get; set; }Property Value
System.