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

Class WebSocketLambdaAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.authorizers.WebSocketLambdaAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketLambdaAuthorizer>

Enclosing class:

WebSocketLambdaAuthorizer

@Stability(Experimental)
public static final class WebSocketLambdaAuthorizer.Builder
extends Object
implements software.amazon.jsii.Builder<WebSocketLambdaAuthorizer>

(experimental) A fluent builder for WebSocketLambdaAuthorizer.

Method Summary

Modifier and Type	Method	Description
WebSocketLambdaAuthorizer.Builder	authorizerName(String authorizerName)	(experimental) The name of the authorizer.
WebSocketLambdaAuthorizer	build()
static WebSocketLambdaAuthorizer.Builder	create(String id, IFunction handler)
WebSocketLambdaAuthorizer.Builder	identitySource(List<String> identitySource)	(experimental) The identity source for which authorization is requested.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static WebSocketLambdaAuthorizer.Builder create(String id,
 IFunction handler)

Parameters:

id - This parameter is required.

handler - This parameter is required.

Returns:

a new instance of WebSocketLambdaAuthorizer.Builder.

authorizerName

@Stability(Experimental)
public WebSocketLambdaAuthorizer.Builder authorizerName(String authorizerName)

(experimental) The name of the authorizer.

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

Parameters:

authorizerName - The name of the authorizer. This parameter is required.

Returns:

this

identitySource

@Stability(Experimental)
public WebSocketLambdaAuthorizer.Builder identitySource(List<String> identitySource)

(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']

Parameters:

identitySource - The identity source for which authorization is requested. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public WebSocketLambdaAuthorizer build()

Specified by:

build in interface software.amazon.jsii.Builder<WebSocketLambdaAuthorizer>

Returns:

a newly built instance of WebSocketLambdaAuthorizer.