@aws-cdk_aws-apigatewayv2-alpha.HttpRouteAuthorizerConfig

interface HttpRouteAuthorizerConfig ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.HttpRouteAuthorizerConfig
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpRouteAuthorizerConfig
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.HttpRouteAuthorizerConfig
Pythonaws_cdk.aws_apigatewayv2_alpha.HttpRouteAuthorizerConfig
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป HttpRouteAuthorizerConfig

Obtainable from HttpNoneAuthorizer.bind(), HttpIamAuthorizer.bind(), HttpJwtAuthorizer.bind(), HttpLambdaAuthorizer.bind(), HttpUserPoolAuthorizer.bind()

Results of binding an authorizer to an http route.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';
const httpRouteAuthorizerConfig: apigatewayv2_alpha.HttpRouteAuthorizerConfig = {
  authorizationType: 'authorizationType',

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

Properties

NameTypeDescription
authorizationType๐Ÿ”นstringThe type of authorization.
authorizationScopes?๐Ÿ”นstring[]The list of OIDC scopes to include in the authorization.
authorizerId?๐Ÿ”นstringThe authorizer id.

authorizationType๐Ÿ”น

Type: string

The type of authorization.

Possible values are:

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

authorizationScopes?๐Ÿ”น

Type: string[] (optional, default: no authorization scopes)

The list of OIDC scopes to include in the authorization.


authorizerId?๐Ÿ”น

Type: string (optional, default: No authorizer id (useful for AWS_IAM route authorizer))

The authorizer id.