Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketAuthorizerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketAuthorizerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:10.796Z")
@Stability(Stable)
public interface WebSocketAuthorizerProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize an instance of WebSocketAuthorizer.

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.*;
 WebSocketApi webSocketApi;
 WebSocketAuthorizerProps webSocketAuthorizerProps = WebSocketAuthorizerProps.builder()
         .identitySource(List.of("identitySource"))
         .type(WebSocketAuthorizerType.LAMBDA)
         .webSocketApi(webSocketApi)
         // the properties below are optional
         .authorizerName("authorizerName")
         .authorizerUri("authorizerUri")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WebSocketAuthorizerProps.Builder	builder()
default String	getAuthorizerName()	Name of the authorizer.
default String	getAuthorizerUri()	The authorizer's Uniform Resource Identifier (URI).
List<String>	getIdentitySource()	The identity source for which authorization is requested.
WebSocketAuthorizerType	getType()	The type of authorizer.
IWebSocketApi	getWebSocketApi()	WebSocket Api to attach the authorizer to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentitySource

@Stability(Stable)
@NotNull
List<String> getIdentitySource()

The identity source for which authorization is requested.

See Also:

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

getType

@Stability(Stable)
@NotNull
WebSocketAuthorizerType getType()

The type of authorizer.

getWebSocketApi

@Stability(Stable)
@NotNull
IWebSocketApi getWebSocketApi()

WebSocket Api to attach the authorizer to.

getAuthorizerName

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

Name of the authorizer.

Default: - id of the WebSocketAuthorizer construct.

getAuthorizerUri

@Stability(Stable)
@Nullable
default String getAuthorizerUri()

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

builder

@Stability(Stable)
static WebSocketAuthorizerProps.Builder builder()

Returns:

a WebSocketAuthorizerProps.Builder of WebSocketAuthorizerProps