interface IWebSocketStage

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

Implemented by WebSocketStage

Obtainable from WebSocketStage.fromWebSocketStageAttributes()

Represents the WebSocketStage.

Properties

Name	Type	Description
api	IWebSocketApi	The API this stage is associated to.
callbackUrl	string	The callback URL to this stage.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.
stageName	string	The name of the stage;
url	string	The URL to this stage.

---

api

Type: IWebSocketApi

The API this stage is associated to.

---

callbackUrl

Type: string

The callback URL to this stage.

You can use the callback URL to send messages to the client from the backend system. https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html

---

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.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

---

stageName

Type: string

The name of the stage;

its primary identifier.

---

url

Type: string

The URL to this stage.

Methods

Name	Description
addStageVariable(name, value)	Adds a stage variable to this stage.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
metric(metricName, props?)	Return the given named metric for this HTTP Api Gateway Stage.

---

addStageVariable(name, value)

public addStageVariable(name: string, value: string): void

Parameters

• name string — The name of the stage variable.
• value string — The value of the stage variable.

Adds a stage variable to this stage.

---

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

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this HTTP Api Gateway Stage.