interface IWebSocketApiRef
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Apigatewayv2.IWebSocketApiRef |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#IWebSocketApiRef |
 Java | software.amazon.awscdk.services.apigatewayv2.IWebSocketApiRef |
 Python | aws_cdk.aws_apigatewayv2.IWebSocketApiRef |
 TypeScript (source) | aws-cdk-lib » aws_apigatewayv2 » IWebSocketApiRef |
Implements
IDependable, IConstruct, IEnvironment, IApi
Implemented by
Web
Represents a reference to an HTTP API.
Properties
| Name | Type | Description |
|---|---|---|
| api | Api | A reference to a Api resource. |
| env | Resource | The environment this resource belongs to. |
| is | boolean | Indicates that this is a WebSocket API. |
| node | Node | The tree node. |
apiRef
Type:
Api
A reference to a Api resource.
env
Type:
Resource
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.