WebSocketApiKeySelectionExpression

class aws_cdk.aws_apigatewayv2.WebSocketApiKeySelectionExpression(custom_api_key_selector)

Bases: object

(experimental) Represents the currently available API Key Selection Expressions.

Stability

experimental

ExampleMetadata

infused

Example:

web_socket_api = apigwv2.WebSocketApi(self, "mywsapi",
    api_key_selection_expression=apigwv2.WebSocketApiKeySelectionExpression.HEADER_X_API_KEY
)
Parameters

custom_api_key_selector (str) – The expression used by API Gateway.

Stability

experimental

Attributes

AUTHORIZER_USAGE_IDENTIFIER_KEY = <aws_cdk.aws_apigatewayv2.WebSocketApiKeySelectionExpression object>
HEADER_X_API_KEY = <aws_cdk.aws_apigatewayv2.WebSocketApiKeySelectionExpression object>
custom_api_key_selector

(experimental) The expression used by API Gateway.

Stability

experimental

Return type

str