aws-cdk-lib.aws_apigatewayv2.CfnAuthorizer.JWTConfigurationProperty

interface JWTConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnAuthorizer.JWTConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnAuthorizer_JWTConfigurationProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnAuthorizer.JWTConfigurationProperty
Pythonaws_cdk.aws_apigatewayv2.CfnAuthorizer.JWTConfigurationProperty
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnAuthorizer » JWTConfigurationProperty

The JWTConfiguration property specifies the configuration of a JWT authorizer.

Required for the JWT authorizer type. Supported only for HTTP APIs.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const jWTConfigurationProperty: apigatewayv2.CfnAuthorizer.JWTConfigurationProperty = {
  audience: ['audience'],
  issuer: 'issuer',
};

Properties

NameTypeDescription
audience?string[]A list of the intended recipients of the JWT.
issuer?stringThe base domain of the identity provider that issues JSON Web Tokens.

audience?

Type: string[] (optional)

A list of the intended recipients of the JWT.

A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519 . Required for the JWT authorizer type. Supported only for HTTP APIs.


issuer?

Type: string (optional)

The base domain of the identity provider that issues JSON Web Tokens.

For example, an Amazon Cognito user pool has the following format: https://cognito-idp. {region} .amazonaws.com/ {userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.