Class WebSocketApiKeySelectionExpression
Represents the currently available API Key Selection Expressions.
Inheritance
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WebSocketApiKeySelectionExpression : DeputyBase
Syntax (vb)
Public Class WebSocketApiKeySelectionExpression
Inherits DeputyBase
Remarks
ExampleMetadata: infused
Examples
var webSocketApi = new WebSocketApi(this, "mywsapi", new WebSocketApiProps {
ApiKeySelectionExpression = WebSocketApiKeySelectionExpression.HEADER_X_API_KEY
});
Synopsis
Constructors
WebSocketApiKeySelectionExpression(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
WebSocketApiKeySelectionExpression(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
WebSocketApiKeySelectionExpression(String) |
Properties
AUTHORIZER_USAGE_IDENTIFIER_KEY | The API will extract the key value from the |
CustomApiKeySelector | The expression used by API Gateway. |
HEADER_X_API_KEY | The API will extract the key value from the |
Constructors
WebSocketApiKeySelectionExpression(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected WebSocketApiKeySelectionExpression(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
WebSocketApiKeySelectionExpression(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected WebSocketApiKeySelectionExpression(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
WebSocketApiKeySelectionExpression(String)
public WebSocketApiKeySelectionExpression(string customApiKeySelector)
Parameters
- customApiKeySelector System.String
The expression used by API Gateway.
Properties
AUTHORIZER_USAGE_IDENTIFIER_KEY
The API will extract the key value from the usageIdentifierKey
attribute in the context
map, returned by the Lambda Authorizer.
public static WebSocketApiKeySelectionExpression AUTHORIZER_USAGE_IDENTIFIER_KEY { get; }
Property Value
WebSocketApiKeySelectionExpression
Remarks
CustomApiKeySelector
The expression used by API Gateway.
public virtual string CustomApiKeySelector { get; }
Property Value
System.String
HEADER_X_API_KEY
The API will extract the key value from the x-api-key
header in the user request.
public static WebSocketApiKeySelectionExpression HEADER_X_API_KEY { get; }
Property Value
WebSocketApiKeySelectionExpression