interface WebSocketAuthorizerProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.WebSocketAuthorizerProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#WebSocketAuthorizerProps |
![]() | software.amazon.awscdk.services.apigatewayv2.WebSocketAuthorizerProps |
![]() | aws_cdk.aws_apigatewayv2.WebSocketAuthorizerProps |
![]() | aws-cdk-lib » aws_apigatewayv2 » WebSocketAuthorizerProps |
Properties to initialize an instance of WebSocketAuthorizer
.
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';
declare const webSocketApi: apigatewayv2.WebSocketApi;
const webSocketAuthorizerProps: apigatewayv2.WebSocketAuthorizerProps = {
identitySource: ['identitySource'],
type: apigatewayv2.WebSocketAuthorizerType.LAMBDA,
webSocketApi: webSocketApi,
// the properties below are optional
authorizerName: 'authorizerName',
authorizerUri: 'authorizerUri',
};
Properties
Name | Type | Description |
---|---|---|
identity | string[] | The identity source for which authorization is requested. |
type | Web | The type of authorizer. |
web | IWeb | WebSocket Api to attach the authorizer to. |
authorizer | string | Name of the authorizer. |
authorizer | string | The authorizer's Uniform Resource Identifier (URI). |
identitySource
Type:
string[]
The identity source for which authorization is requested.
type
Type:
Web
The type of authorizer.
webSocketApi
Type:
IWeb
WebSocket Api to attach the authorizer to.
authorizerName?
Type:
string
(optional, default: id of the WebSocketAuthorizer construct.)
Name of the authorizer.
authorizerUri?
Type:
string
(optional, default: required for Request authorizer types)
The authorizer's Uniform Resource Identifier (URI).
For REQUEST authorizers, this must be a well-formed Lambda function URI.