Package software.amazon.awscdk.services.apigatewayv2.authorizers

Interface WebSocketLambdaAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketLambdaAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:46.910Z")
@Stability(Experimental)
public interface WebSocketLambdaAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties to initialize WebSocketTokenAuthorizer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.authorizers.*;
 WebSocketLambdaAuthorizerProps webSocketLambdaAuthorizerProps = WebSocketLambdaAuthorizerProps.builder()
         .authorizerName("authorizerName")
         .identitySource(List.of("identitySource"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WebSocketLambdaAuthorizerProps.Builder	A builder for WebSocketLambdaAuthorizerProps
static final class	WebSocketLambdaAuthorizerProps.Jsii$Proxy	An implementation for WebSocketLambdaAuthorizerProps

Method Summary

Modifier and Type	Method	Description
static WebSocketLambdaAuthorizerProps.Builder	builder()
default String	getAuthorizerName()	(experimental) The name of the authorizer.
default List<String>	getIdentitySource()	(experimental) The identity source for which authorization is requested.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizerName

@Stability(Experimental)
@Nullable
default String getAuthorizerName()

(experimental) The name of the authorizer.

Default: - same value as `id` passed in the constructor.

getIdentitySource

@Stability(Experimental)
@Nullable
default List<String> getIdentitySource()

(experimental) The identity source for which authorization is requested.

Request parameter match 'route.request.querystring|header.[a-zA-z0-9._-]+'. Staged variable match 'stageVariables.[a-zA-Z0-9._-]+'. Context parameter match 'context.[a-zA-Z0-9._-]+'.

Default: ['route.request.header.Authorization']

builder

@Stability(Experimental)
static WebSocketLambdaAuthorizerProps.Builder builder()

Returns:

a WebSocketLambdaAuthorizerProps.Builder of WebSocketLambdaAuthorizerProps