interface WebSocketRouteAuthorizerConfig
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.WebSocketRouteAuthorizerConfig |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#WebSocketRouteAuthorizerConfig |
![]() | software.amazon.awscdk.services.apigatewayv2.WebSocketRouteAuthorizerConfig |
![]() | aws_cdk.aws_apigatewayv2.WebSocketRouteAuthorizerConfig |
![]() | aws-cdk-lib » aws_apigatewayv2 » WebSocketRouteAuthorizerConfig |
Obtainable from
Web
.bind()
, Web
.bind()
, Web
.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 { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const webSocketRouteAuthorizerConfig: apigatewayv2.WebSocketRouteAuthorizerConfig = {
authorizationType: 'authorizationType',
// the properties below are optional
authorizerId: 'authorizerId',
};
Properties
Name | Type | Description |
---|---|---|
authorization | string | The type of authorization. |
authorizer | string | The 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.