Class WebSocketApiProps

Props for WebSocket API.

Inheritance

object

WebSocketApiProps

Implements

IWebSocketApiProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class WebSocketApiProps : IWebSocketApiProps

Syntax (vb)

Public Class WebSocketApiProps Implements IWebSocketApiProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AwsApigatewayv2Authorizers;
            using Amazon.CDK.AwsApigatewayv2Integrations;

            // This function handles your auth logic
            Function authHandler;

            // This function handles your WebSocket requests
            Function handler;


            var authorizer = new WebSocketLambdaAuthorizer("Authorizer", authHandler);

            var integration = new WebSocketLambdaIntegration("Integration", handler);

            new WebSocketApi(this, "WebSocketApi", new WebSocketApiProps {
                ConnectRouteOptions = new WebSocketRouteOptions {
                    Integration = integration,
                    Authorizer = authorizer
                }
            });

Synopsis

Constructors

WebSocketApiProps()

Props for WebSocket API.

Properties

ApiKeySelectionExpression	An API key selection expression.
ApiName	Name for the WebSocket API resource.
ConnectRouteOptions	Options to configure a '$connect' route.
DefaultRouteOptions	Options to configure a '$default' route.
Description	The description of the API.
DisconnectRouteOptions	Options to configure a '$disconnect' route.
IpAddressType	The IP address types that can invoke the API.
RouteSelectionExpression	The route selection expression for the API.

Constructors

WebSocketApiProps()

Props for WebSocket API.

public WebSocketApiProps()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AwsApigatewayv2Authorizers;
            using Amazon.CDK.AwsApigatewayv2Integrations;

            // This function handles your auth logic
            Function authHandler;

            // This function handles your WebSocket requests
            Function handler;


            var authorizer = new WebSocketLambdaAuthorizer("Authorizer", authHandler);

            var integration = new WebSocketLambdaIntegration("Integration", handler);

            new WebSocketApi(this, "WebSocketApi", new WebSocketApiProps {
                ConnectRouteOptions = new WebSocketRouteOptions {
                    Integration = integration,
                    Authorizer = authorizer
                }
            });

Properties

ApiKeySelectionExpression

An API key selection expression.

public WebSocketApiKeySelectionExpression? ApiKeySelectionExpression { get; set; }

Property Value

WebSocketApiKeySelectionExpression

Remarks

Providing this option will require an API Key be provided to access the API.

Default: - Key is not required to access these APIs

ApiName

Name for the WebSocket API resource.

public string? ApiName { get; set; }

Property Value

string

Remarks

Default: - id of the WebSocketApi construct.

ConnectRouteOptions

Options to configure a '$connect' route.

public IWebSocketRouteOptions? ConnectRouteOptions { get; set; }

Property Value

IWebSocketRouteOptions

Remarks

Default: - no '$connect' route configured

DefaultRouteOptions

Options to configure a '$default' route.

public IWebSocketRouteOptions? DefaultRouteOptions { get; set; }

Property Value

IWebSocketRouteOptions

Remarks

Default: - no '$default' route configured

Description

The description of the API.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - none

DisconnectRouteOptions

Options to configure a '$disconnect' route.

public IWebSocketRouteOptions? DisconnectRouteOptions { get; set; }

Property Value

IWebSocketRouteOptions

Remarks

Default: - no '$disconnect' route configured

IpAddressType

The IP address types that can invoke the API.

public IpAddressType? IpAddressType { get; set; }

Property Value

IpAddressType?

Remarks

Default: undefined - AWS default is IPV4

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.html

RouteSelectionExpression

The route selection expression for the API.

public string? RouteSelectionExpression { get; set; }

Property Value

string

Remarks

Default: '$request.body.action'

Implements

IWebSocketApiProps