class WebSocketAuthorizer (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.WebSocketAuthorizer
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#WebSocketAuthorizer
Java	software.amazon.awscdk.services.apigatewayv2.WebSocketAuthorizer
Python	aws_cdk.aws_apigatewayv2.WebSocketAuthorizer
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » WebSocketAuthorizer

Implements IConstruct, IDependable, IResource, IWebSocketAuthorizer, IAuthorizer

An authorizer for WebSocket Apis.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const webSocketApi: apigatewayv2.WebSocketApi;
const webSocketAuthorizer = new apigatewayv2.WebSocketAuthorizer(this, 'MyWebSocketAuthorizer', {
  identitySource: ['identitySource'],
  type: apigatewayv2.WebSocketAuthorizerType.LAMBDA,
  webSocketApi: webSocketApi,

  // the properties below are optional
  authorizerName: 'authorizerName',
  authorizerUri: 'authorizerUri',
});

Initializer

new WebSocketAuthorizer(scope: Construct, id: string, props: WebSocketAuthorizerProps)

Parameters

• scope Construct
• id string
• props WebSocketAuthorizerProps

Construct Props

Name	Type	Description
identitySource	string[]	The identity source for which authorization is requested.
type	WebSocketAuthorizerType	The type of authorizer.
webSocketApi	IWebSocketApi	WebSocket Api to attach the authorizer to.
authorizerName?	string	Name of the authorizer.
authorizerUri?	string	The authorizer's Uniform Resource Identifier (URI).

---

identitySource

Type: string[]

The identity source for which authorization is requested.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

---

type

Type: WebSocketAuthorizerType

The type of authorizer.

---

webSocketApi

Type: IWebSocketApi

WebSocket Api to attach the authorizer to.

---

authorizerName?

Type: string (optional, default: id of the WebSocketAuthorizer construct.)

Name of the authorizer.

---

authorizerUri?

Type: string (optional, default: required for Request authorizer types)

The authorizer's Uniform Resource Identifier (URI).

For REQUEST authorizers, this must be a well-formed Lambda function URI.

Properties

Name	Type	Description
authorizerId	string	Id of the Authorizer.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

authorizerId

Type: string

Id of the Authorizer.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromWebSocketAuthorizerAttributes(scope, id, attrs)	Import an existing WebSocket Authorizer into this CDK app.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromWebSocketAuthorizerAttributes(scope, id, attrs)

public static fromWebSocketAuthorizerAttributes(scope: Construct, id: string, attrs: WebSocketAuthorizerAttributes): IWebSocketRouteAuthorizer

Parameters

• scope Construct
• id string
• attrs WebSocketAuthorizerAttributes

Returns

• IWebSocketRouteAuthorizer

Import an existing WebSocket Authorizer into this CDK app.