@aws-cdk_aws-apigatewayv2-alpha.WebSocketRouteAuthorizerConfig

interface WebSocketRouteAuthorizerConfig ๐Ÿ”น

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

Obtainable from WebSocketNoneAuthorizer.bind(), WebSocketIamAuthorizer.bind(), WebSocketLambdaAuthorizer.bind()

Results of binding an authorizer to an WebSocket 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 webSocketRouteAuthorizerConfig: apigatewayv2_alpha.WebSocketRouteAuthorizerConfig = {
  authorizationType: 'authorizationType',

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

Properties

NameTypeDescription
authorizationType๐Ÿ”นstringThe type of authorization.
authorizerId?๐Ÿ”นstringThe authorizer id.

authorizationType๐Ÿ”น

Type: string

The type of authorization.

Possible values are:

  • CUSTOM - Lambda Authorizer
  • NONE - No Authorization

authorizerId?๐Ÿ”น

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

The authorizer id.