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 |
**************************************************************************** Factory ***************************************************************************.
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 |
|---|---|---|
| user | IUser | The Cognito User Pool to use for authentication. |
| allowed | string[] | The allowed audiences for JWT validation. |
| allowed | IUser[] | The allowed User Pool clients. |
| allowed | string[] | The allowed scopes for JWT validation. |
| custom | Gateway[] | Custom claims for additional JWT token validation. |
userPool
Type:
IUser
The Cognito User Pool to use for authentication.
allowedAudiences?
Type:
string[]
(optional, default: No audience validation)
The allowed audiences for JWT validation.
allowedClients?
Type:
IUser[]
(optional, default: All clients are allowed)
The allowed User Pool clients.
allowedScopes?
Type:
string[]
(optional, default: No scope validation)
The allowed scopes for JWT validation.
customClaims?
Type:
Gateway[]
(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.

.NET
Go
Java
Python
TypeScript (