aws-cdk-lib.aws_apigatewayv2.HttpRouteAuthorizerConfig

HttpRouteAuthorizerConfig Struct

Results of binding an authorizer to an http route.

Source

aws-apigatewayv2/lib/http/authorizer.ts

Type last changed

v2.112.0 · 1 Dec 2023

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 httpRouteAuthorizerConfig: apigatewayv2.HttpRouteAuthorizerConfig = {
  authorizationType: 'authorizationType',

  // the properties below are optional
  authorizationScopes: ['authorizationScopes'],
  authorizerId: 'authorizerId',
};

Properties

authorizationScopesstring[]authorization_scopestyping.List[str]authorizationScopesList<String>AuthorizationScopesstring[]AuthorizationScopes*[]*string= no authorization scopes#

The list of OIDC scopes to include in the authorization.

authorizationTypestringauthorization_typestrauthorizationTypeStringAuthorizationTypestringAuthorizationType*stringrequired#

The type of authorization.

Possible values are:

• AWS_IAM - IAM Authorizer
• JWT - JSON Web Token Authorizer
• CUSTOM - Lambda Authorizer
• NONE - No Authorization

authorizerIdstringauthorizer_idstrauthorizerIdStringAuthorizerIdstringAuthorizerId*string= No authorizer id (useful for AWS…#

The authorizer id.

default

Default: No authorizer id (useful for AWS_IAM route authorizer)