@aws-cdk_aws-apigatewayv2-alpha.WebSocketAuthorizerProps

interface WebSocketAuthorizerProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.WebSocketAuthorizerProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#WebSocketAuthorizerProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.WebSocketAuthorizerProps
Pythonaws_cdk.aws_apigatewayv2_alpha.WebSocketAuthorizerProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป 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 * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';

declare const webSocketApi: apigatewayv2_alpha.WebSocketApi;
const webSocketAuthorizerProps: apigatewayv2_alpha.WebSocketAuthorizerProps = {
  identitySource: ['identitySource'],
  type: apigatewayv2_alpha.WebSocketAuthorizerType.LAMBDA,
  webSocketApi: webSocketApi,

  // the properties below are optional
  authorizerName: 'authorizerName',
  authorizerUri: 'authorizerUri',
};

Properties

NameTypeDescription
identitySource๐Ÿ”นstring[]The identity source for which authorization is requested.
type๐Ÿ”นWebSocketAuthorizerTypeThe type of authorizer.
webSocketApi๐Ÿ”นIWebSocketApiWebSocket Api to attach the authorizer to.
authorizerName?๐Ÿ”นstringName of the authorizer.
authorizerUri?๐Ÿ”นstringThe authorizer's Uniform Resource Identifier (URI).

identitySource๐Ÿ”น

Type: string[]

The identity source for which authorization is requested.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource


type๐Ÿ”น

Type: WebSocketAuthorizerType

The type of authorizer.


webSocketApi๐Ÿ”น

Type: IWebSocketApi

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.