interface WebSocketLambdaAuthorizerProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.APIGatewayv2.Authorizers.WebSocketLambdaAuthorizerProps |
Java | software.amazon.awscdk.services.apigatewayv2.authorizers.WebSocketLambdaAuthorizerProps |
Python | aws_cdk.aws_apigatewayv2_authorizers.WebSocketLambdaAuthorizerProps |
TypeScript (source) | @aws-cdk/aws-apigatewayv2-authorizers » WebSocketLambdaAuthorizerProps |
Properties to initialize WebSocketTokenAuthorizer.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2_authorizers from '@aws-cdk/aws-apigatewayv2-authorizers';
const webSocketLambdaAuthorizerProps: apigatewayv2_authorizers.WebSocketLambdaAuthorizerProps = {
authorizerName: 'authorizerName',
identitySource: ['identitySource'],
};
Properties
Name | Type | Description |
---|---|---|
authorizer | string | The name of the authorizer. |
identity | string[] | The identity source for which authorization is requested. |
authorizerName?
Type:
string
(optional, default: same value as id
passed in the constructor.)
The name of the authorizer.
identitySource?
Type:
string[]
(optional, default: ['route.request.header.Authorization'])
The identity source for which authorization is requested.
Request parameter match 'route.request.querystring|header.[a-zA-z0-9._-]+'
.
Staged variable match 'stageVariables.[a-zA-Z0-9._-]+'
.
Context parameter match 'context.[a-zA-Z0-9._-]+'
.