Class WebSocketAuthorizer

An authorizer for WebSocket Apis.

Inheritance
System.Object
Resource
WebSocketAuthorizer
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WebSocketAuthorizer : Resource, IWebSocketAuthorizer, IAuthorizer, IResource
Syntax (vb)
Public Class WebSocketAuthorizer
    Inherits Resource
    Implements IWebSocketAuthorizer, IAuthorizer, IResource
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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
WebSocketAuthorizer(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
WebSocketAuthorizer(Construct, String, IWebSocketAuthorizerProps)

Properties

AuthorizerId

Id of the Authorizer.

Methods

FromWebSocketAuthorizerAttributes(Construct, String, IWebSocketAuthorizerAttributes)

Import an existing WebSocket Authorizer into this CDK app.

Constructors

WebSocketAuthorizer(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected WebSocketAuthorizer(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

WebSocketAuthorizer(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected WebSocketAuthorizer(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

WebSocketAuthorizer(Construct, String, IWebSocketAuthorizerProps)

public WebSocketAuthorizer(Construct scope, string id, IWebSocketAuthorizerProps props)
Parameters
scope Constructs.Construct
id System.String
props IWebSocketAuthorizerProps

Properties

AuthorizerId

Id of the Authorizer.

public virtual string AuthorizerId { get; }
Property Value

System.String

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 Constructs.Construct
id System.String
attrs IWebSocketAuthorizerAttributes
Returns

IWebSocketRouteAuthorizer

Implements

Constructs.IConstruct
Constructs.IDependable