Class WebSocketAuthorizerProps
Properties to initialize an instance of WebSocketAuthorizer
.
Inheritance
System.Object
WebSocketAuthorizerProps
Implements
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WebSocketAuthorizerProps : Object, IWebSocketAuthorizerProps
Syntax (vb)
Public Class WebSocketAuthorizerProps
Inherits Object
Implements IWebSocketAuthorizerProps
Remarks
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 webSocketAuthorizerProps = new WebSocketAuthorizerProps {
IdentitySource = new [] { "identitySource" },
Type = WebSocketAuthorizerType.LAMBDA,
WebSocketApi = webSocketApi,
// the properties below are optional
AuthorizerName = "authorizerName",
AuthorizerUri = "authorizerUri"
};
Synopsis
Constructors
WebSocketAuthorizerProps() |
Properties
AuthorizerName | Name of the authorizer. |
AuthorizerUri | The authorizer's Uniform Resource Identifier (URI). |
IdentitySource | The identity source for which authorization is requested. |
Type | The type of authorizer. |
WebSocketApi | WebSocket Api to attach the authorizer to. |
Constructors
WebSocketAuthorizerProps()
public WebSocketAuthorizerProps()
Properties
AuthorizerName
Name of the authorizer.
public string AuthorizerName { get; set; }
Property Value
System.String
Remarks
Default: - id of the WebSocketAuthorizer construct.
AuthorizerUri
The authorizer's Uniform Resource Identifier (URI).
public string AuthorizerUri { get; set; }
Property Value
System.String
Remarks
For REQUEST authorizers, this must be a well-formed Lambda function URI.
Default: - required for Request authorizer types
IdentitySource
The identity source for which authorization is requested.
public string[] IdentitySource { get; set; }
Property Value
System.String[]
Remarks
Type
The type of authorizer.
public WebSocketAuthorizerType Type { get; set; }
Property Value
WebSocketApi
WebSocket Api to attach the authorizer to.
public IWebSocketApi WebSocketApi { get; set; }
Property Value