interface CognitoAuthorizerProps ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.CognitoAuthorizerProps
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#CognitoAuthorizerProps
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.CognitoAuthorizerProps
Python	aws_cdk.aws_bedrock_agentcore_alpha.CognitoAuthorizerProps
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » CognitoAuthorizerProps

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Properties for configuring a Cognito authorizer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const gatewayCustomClaim: bedrock_agentcore_alpha.GatewayCustomClaim;
declare const userPool: cognito.UserPool;
declare const userPoolClient: cognito.UserPoolClient;
const cognitoAuthorizerProps: bedrock_agentcore_alpha.CognitoAuthorizerProps = {
  userPool: userPool,

  // the properties below are optional
  allowedAudiences: ['allowedAudiences'],
  allowedClients: [userPoolClient],
  allowedScopes: ['allowedScopes'],
  customClaims: [gatewayCustomClaim],
};

Properties

Name	Type	Description
userPool⚠️	IUserPool	The Cognito User Pool to use for authentication.
allowedAudiences?⚠️	string[]	The allowed audiences for JWT validation.
allowedClients?⚠️	IUserPoolClient[]	The allowed User Pool clients.
allowedScopes?⚠️	string[]	The allowed scopes for JWT validation.
customClaims?⚠️	GatewayCustomClaim[]	Custom claims for additional JWT token validation.

---

userPool⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: IUserPool

The Cognito User Pool to use for authentication.

---

allowedAudiences?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string[] (optional, default: No audience validation)

The allowed audiences for JWT validation.

---

allowedClients?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: IUserPoolClient[] (optional, default: All clients are allowed)

The allowed User Pool clients.

---

allowedScopes?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string[] (optional, default: No scope validation)

The allowed scopes for JWT validation.

---

customClaims?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: GatewayCustomClaim[] (optional, default: No custom claim validation)

Custom claims for additional JWT token validation.

Allows you to validate additional fields in JWT tokens beyond the standard audience, client, and scope validations.