Class WebSocketAuthorizer

An authorizer for WebSocket Apis.

Inheritance
object
Resource
WebSocketAuthorizer
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WebSocketAuthorizer : Resource, IWebSocketAuthorizer, IAuthorizer, IResource, IAuthorizerRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class WebSocketAuthorizer Inherits Resource Implements IWebSocketAuthorizer, IAuthorizer, IResource, IAuthorizerRef, IConstruct, IDependable, IEnvironmentAware
Remarks

Resource: AWS::ApiGatewayV2::Authorizer

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;

             WebSocketApi webSocketApi;

             var webSocketAuthorizer = new WebSocketAuthorizer(this, "MyWebSocketAuthorizer", new WebSocketAuthorizerProps {
                 IdentitySource = new [] { "identitySource" },
                 Type = WebSocketAuthorizerType.LAMBDA,
                 WebSocketApi = webSocketApi,

                 // the properties below are optional
                 AuthorizerName = "authorizerName",
                 AuthorizerUri = "authorizerUri"
             });

Synopsis

Constructors

WebSocketAuthorizer(Construct, string, IWebSocketAuthorizerProps)

An authorizer for WebSocket Apis.

Properties

AuthorizerId

Id of the Authorizer.
AuthorizerRef

A reference to a Authorizer resource.
PROPERTY_INJECTION_ID

Uniquely identifies this class.

Methods

FromWebSocketAuthorizerAttributes(Construct, string, IWebSocketAuthorizerAttributes)

Import an existing WebSocket Authorizer into this CDK app.

Constructors

WebSocketAuthorizer(Construct, string, IWebSocketAuthorizerProps)

An authorizer for WebSocket Apis.

public WebSocketAuthorizer(Construct scope, string id, IWebSocketAuthorizerProps props)
Parameters
scope Construct
id string
props IWebSocketAuthorizerProps
Remarks

Resource: AWS::ApiGatewayV2::Authorizer

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;

             WebSocketApi webSocketApi;

             var webSocketAuthorizer = new WebSocketAuthorizer(this, "MyWebSocketAuthorizer", new WebSocketAuthorizerProps {
                 IdentitySource = new [] { "identitySource" },
                 Type = WebSocketAuthorizerType.LAMBDA,
                 WebSocketApi = webSocketApi,

                 // the properties below are optional
                 AuthorizerName = "authorizerName",
                 AuthorizerUri = "authorizerUri"
             });

Properties

AuthorizerId

Id of the Authorizer.

public virtual string AuthorizerId { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

AuthorizerRef

A reference to a Authorizer resource.

public virtual IAuthorizerReference AuthorizerRef { get; }
Property Value

IAuthorizerReference

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

Methods

FromWebSocketAuthorizerAttributes(Construct, string, IWebSocketAuthorizerAttributes)

Import an existing WebSocket Authorizer into this CDK app.

public static IWebSocketRouteAuthorizer FromWebSocketAuthorizerAttributes(Construct scope, string id, IWebSocketAuthorizerAttributes attrs)
Parameters
scope Construct
id string
attrs IWebSocketAuthorizerAttributes
Returns

IWebSocketRouteAuthorizer

Remarks

Resource: AWS::ApiGatewayV2::Authorizer

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable