Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketAuthorizer.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketAuthorizer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketAuthorizer>

Enclosing class:

WebSocketAuthorizer

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

A fluent builder for WebSocketAuthorizer.

Method Summary

Modifier and Type	Method	Description
WebSocketAuthorizer.Builder	authorizerName(String authorizerName)	Name of the authorizer.
WebSocketAuthorizer.Builder	authorizerUri(String authorizerUri)	The authorizer's Uniform Resource Identifier (URI).
WebSocketAuthorizer	build()
static WebSocketAuthorizer.Builder	create(software.constructs.Construct scope, String id)
WebSocketAuthorizer.Builder	identitySource(List<String> identitySource)	The identity source for which authorization is requested.
WebSocketAuthorizer.Builder	type(WebSocketAuthorizerType type)	The type of authorizer.
WebSocketAuthorizer.Builder	webSocketApi(IWebSocketApi webSocketApi)	WebSocket Api to attach the authorizer to.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static WebSocketAuthorizer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WebSocketAuthorizer.Builder.

identitySource

@Stability(Stable)
public WebSocketAuthorizer.Builder identitySource(List<String> identitySource)

The identity source for which authorization is requested.

Parameters:

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

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

type

@Stability(Stable)
public WebSocketAuthorizer.Builder type(WebSocketAuthorizerType type)

The type of authorizer.

Parameters:

type - The type of authorizer. This parameter is required.

Returns:

this

webSocketApi

@Stability(Stable)
public WebSocketAuthorizer.Builder webSocketApi(IWebSocketApi webSocketApi)

WebSocket Api to attach the authorizer to.

Parameters:

webSocketApi - WebSocket Api to attach the authorizer to. This parameter is required.

Returns:

this

authorizerName

@Stability(Stable)
public WebSocketAuthorizer.Builder authorizerName(String authorizerName)

Name of the authorizer.

Default: - id of the WebSocketAuthorizer construct.

Parameters:

authorizerName - Name of the authorizer. This parameter is required.

Returns:

this

authorizerUri

@Stability(Stable)
public WebSocketAuthorizer.Builder authorizerUri(String authorizerUri)

The authorizer's Uniform Resource Identifier (URI).

For REQUEST authorizers, this must be a well-formed Lambda function URI.

Default: - required for Request authorizer types

Parameters:

authorizerUri - The authorizer's Uniform Resource Identifier (URI). This parameter is required.

Returns:

this

build

@Stability(Stable)
public WebSocketAuthorizer build()

Specified by:

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

Returns:

a newly built instance of WebSocketAuthorizer.