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