Class CfnListenerRule.AuthenticateCognitoConfigProperty

Specifies information required when integrating with Amazon Cognito to authenticate users.

Inheritance

object

CfnListenerRule.AuthenticateCognitoConfigProperty

Implements

CfnListenerRule.IAuthenticateCognitoConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnListenerRule.AuthenticateCognitoConfigProperty : CfnListenerRule.IAuthenticateCognitoConfigProperty

Syntax (vb)

Public Class CfnListenerRule.AuthenticateCognitoConfigProperty Implements CfnListenerRule.IAuthenticateCognitoConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html

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

AuthenticateCognitoConfigProperty()

Specifies information required when integrating with Amazon Cognito to authenticate users.

Properties

AuthenticationRequestExtraParams	The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
OnUnauthenticatedRequest	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 `openid` .
SessionCookieName	The name of the cookie used to maintain session information.
SessionTimeout	The maximum duration of the authentication session, in seconds.
UserPoolArn	The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
UserPoolClientId	The ID of the Amazon Cognito user pool client.
UserPoolDomain	The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

Constructors

AuthenticateCognitoConfigProperty()

Specifies information required when integrating with Amazon Cognito to authenticate users.

public AuthenticateCognitoConfigProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html

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
             };

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

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticatecognitoconfig-authenticationrequestextraparams

OnUnauthenticatedRequest

The behavior if the user is not authenticated. The following are possible values:.

public string? OnUnauthenticatedRequest { get; set; }

Property Value

string

Remarks

Scope

The set of user claims to be requested from the IdP. The default is openid .

public string? Scope { get; set; }

Property Value

string

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

string

Remarks

The default is AWSELBAuthSessionCookie.

SessionTimeout

The maximum duration of the authentication session, in seconds.

public double? SessionTimeout { get; set; }

Property Value

double?

Remarks

The default is 604800 seconds (7 days).

UserPoolArn

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

public string UserPoolArn { get; set; }

Property Value

string

Remarks

UserPoolClientId

The ID of the Amazon Cognito user pool client.

public string UserPoolClientId { get; set; }

Property Value

string

Remarks

UserPoolDomain

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

public string UserPoolDomain { get; set; }