@aws-cdk_aws-apigatewayv2-alpha.WebSocketApiKeySelectionExpression

class WebSocketApiKeySelectionExpression ๐Ÿ”น

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

Represents the currently available API Key Selection Expressions.

Example

const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi',{
  apiKeySelectionExpression: apigwv2.WebSocketApiKeySelectionExpression.HEADER_X_API_KEY,
});

Initializer

new WebSocketApiKeySelectionExpression(customApiKeySelector: string)

Parameters

  • customApiKeySelector string โ€” The expression used by API Gateway.

Properties

NameTypeDescription
customApiKeySelector๐Ÿ”นstringThe expression used by API Gateway.
static AUTHORIZER_USAGE_IDENTIFIER_KEY๐Ÿ”นWebSocketApiKeySelectionExpressionThe API will extract the key value from the usageIdentifierKey attribute in the context map, returned by the Lambda Authorizer.
static HEADER_X_API_KEY๐Ÿ”นWebSocketApiKeySelectionExpressionThe API will extract the key value from the x-api-key header in the user request.

customApiKeySelector๐Ÿ”น

Type: string

The expression used by API Gateway.


static AUTHORIZER_USAGE_IDENTIFIER_KEY๐Ÿ”น

Type: WebSocketApiKeySelectionExpression

The API will extract the key value from the usageIdentifierKey attribute in the context map, returned by the Lambda Authorizer.

See https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html


static HEADER_X_API_KEY๐Ÿ”น

Type: WebSocketApiKeySelectionExpression

The API will extract the key value from the x-api-key header in the user request.