Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketApiKeySelectionExpression

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.WebSocketApiKeySelectionExpression

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:39:57.623Z")
@Stability(Stable)
public class WebSocketApiKeySelectionExpression
extends software.amazon.jsii.JsiiObject

Represents the currently available API Key Selection Expressions.

Example:

 WebSocketApi webSocketApi = WebSocketApi.Builder.create(this, "mywsapi")
         .apiKeySelectionExpression(WebSocketApiKeySelectionExpression.HEADER_X_API_KEY)
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static final WebSocketApiKeySelectionExpression	AUTHORIZER_USAGE_IDENTIFIER_KEY	The API will extract the key value from the usageIdentifierKey attribute in the context map, returned by the Lambda Authorizer.
static final WebSocketApiKeySelectionExpression	HEADER_X_API_KEY	The API will extract the key value from the x-api-key header in the user request.

Constructor Summary

Constructors

Modifier	Constructor	Description
	WebSocketApiKeySelectionExpression(String customApiKeySelector)
protected	WebSocketApiKeySelectionExpression(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketApiKeySelectionExpression(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
String	getCustomApiKeySelector()	The expression used by API Gateway.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

AUTHORIZER_USAGE_IDENTIFIER_KEY

@Stability(Stable)
public static final WebSocketApiKeySelectionExpression AUTHORIZER_USAGE_IDENTIFIER_KEY

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

HEADER_X_API_KEY

@Stability(Stable)
public static final WebSocketApiKeySelectionExpression HEADER_X_API_KEY

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

Constructor Details

WebSocketApiKeySelectionExpression

protected WebSocketApiKeySelectionExpression(software.amazon.jsii.JsiiObjectRef objRef)

WebSocketApiKeySelectionExpression

protected WebSocketApiKeySelectionExpression(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

WebSocketApiKeySelectionExpression

@Stability(Stable)
public WebSocketApiKeySelectionExpression(@NotNull
 String customApiKeySelector)

Parameters:

customApiKeySelector - The expression used by API Gateway. This parameter is required.

Method Details

getCustomApiKeySelector

@Stability(Stable)
@NotNull
public String getCustomApiKeySelector()

The expression used by API Gateway.