Show / Hide Table of Contents

Class WebSocketRouteAuthorizerConfig

(experimental) Results of binding an authorizer to an WebSocket route.

Inheritance
System.Object
WebSocketRouteAuthorizerConfig
Implements
IWebSocketRouteAuthorizerConfig
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class WebSocketRouteAuthorizerConfig : Object, IWebSocketRouteAuthorizerConfig
Syntax (vb)
Public Class WebSocketRouteAuthorizerConfig
    Inherits Object
    Implements IWebSocketRouteAuthorizerConfig
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;

var webSocketRouteAuthorizerConfig = new WebSocketRouteAuthorizerConfig {
    AuthorizationType = "authorizationType",

    // the properties below are optional
    AuthorizerId = "authorizerId"
};

Synopsis

Constructors

WebSocketRouteAuthorizerConfig()

Properties

AuthorizationType

(experimental) The type of authorization.

AuthorizerId

(experimental) The authorizer id.

Constructors

WebSocketRouteAuthorizerConfig()

public WebSocketRouteAuthorizerConfig()

Properties

AuthorizationType

(experimental) The type of authorization.

public string AuthorizationType { get; set; }
Property Value

System.String

Remarks

Possible values are:

    Stability: Experimental

    AuthorizerId

    (experimental) The authorizer id.

    public string AuthorizerId { get; set; }
    Property Value

    System.String

    Remarks

    Default: - No authorizer id (useful for AWS_IAM route authorizer)

    Stability: Experimental

    Implements

    IWebSocketRouteAuthorizerConfig
    Back to top Generated by DocFX