interface AuthenticateCognitoConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.ElasticLoadBalancingV2.CfnListener.AuthenticateCognitoConfigProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2#CfnListener_AuthenticateCognitoConfigProperty
Java	software.amazon.awscdk.services.elasticloadbalancingv2.CfnListener.AuthenticateCognitoConfigProperty
Python	aws_cdk.aws_elasticloadbalancingv2.CfnListener.AuthenticateCognitoConfigProperty
TypeScript	aws-cdk-lib » aws_elasticloadbalancingv2 » CfnListener » AuthenticateCognitoConfigProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
const authenticateCognitoConfigProperty: elbv2.CfnListener.AuthenticateCognitoConfigProperty = {
  userPoolArn: 'userPoolArn',
  userPoolClientId: 'userPoolClientId',
  userPoolDomain: 'userPoolDomain',

  // the properties below are optional
  authenticationRequestExtraParams: {
    authenticationRequestExtraParamsKey: 'authenticationRequestExtraParams',
  },
  onUnauthenticatedRequest: 'onUnauthenticatedRequest',
  scope: 'scope',
  sessionCookieName: 'sessionCookieName',
  sessionTimeout: 'sessionTimeout',
};

Properties

Name	Type	Description
userPoolArn	string	The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
userPoolClientId	string	The ID of the Amazon Cognito user pool client.
userPoolDomain	string	The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
authenticationRequestExtraParams?	{ [string]: string } | IResolvable	The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
onUnauthenticatedRequest?	string	The behavior if the user is not authenticated. The following are possible values:.
scope?	string	The set of user claims to be requested from the IdP. The default is openid .
sessionCookieName?	string	The name of the cookie used to maintain session information.
sessionTimeout?	string	The maximum duration of the authentication session, in seconds.

---

userPoolArn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolarn

---

userPoolClientId

Type: string

The ID of the Amazon Cognito user pool client.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpoolclientid

---

userPoolDomain

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-userpooldomain

---

authenticationRequestExtraParams?

Type: { [string]: string } | IResolvable (optional)

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

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

---

onUnauthenticatedRequest?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-onunauthenticatedrequest

---

scope?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-scope

---

sessionCookieName?

Type: string (optional)

The name of the cookie used to maintain session information.

The default is AWSELBAuthSessionCookie.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessioncookiename

---

sessionTimeout?

Type: string (optional)

The maximum duration of the authentication session, in seconds.

The default is 604800 seconds (7 days).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticatecognitoconfig.html#cfn-elasticloadbalancingv2-listener-authenticatecognitoconfig-sessiontimeout