interface IWebSocketApi

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IApiRef, IApi, IWebSocketApiRef

Implemented by WebSocketApi

Obtainable from WebSocketApi.fromWebSocketApiAttributes()

Represents a WebSocket API.

Properties

Name	Type	Description
apiEndpoint	`string`	The default endpoint for an API.
apiId	`string`	The identifier of this API Gateway API.
apiRef🔹	`ApiReference`	A reference to a Api resource.
env	`ResourceEnvironment`	The environment this resource belongs to.
isWebsocketApi	`boolean`	Indicates that this is a WebSocket API.
node	`Node`	The tree node.
stack	`Stack`	The stack in which this resource is defined.

apiEndpoint

Type: string

The default endpoint for an API.

apiId

Type: string

The identifier of this API Gateway API.

apiRef🔹

Type: ApiReference

A reference to a Api resource.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

isWebsocketApi

Type: boolean

Indicates that this is a WebSocket API.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

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.
metric(metricName, props?)	Return the given named metric for this Api Gateway.

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).

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric