interface IWebSocketApi
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGatewayv2.IWebSocketApi |
 Java | software.amazon.awscdk.services.apigatewayv2.IWebSocketApi |
 Python | aws_cdk.aws_apigatewayv2.IWebSocketApi |
 TypeScript (source) | @aws-cdk/aws-apigatewayv2 » IWebSocketApi |
Implemented by
Web
Obtainable from
Web.fromWebSocketApiAttributes()
Represents a WebSocket API.
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The default endpoint for an API. |
| api | string | The identifier of this API Gateway API. |
| env | Resource | The environment this resource belongs to. |
| node | Construct | The construct tree node for this construct. |
| 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.
env
Type:
Resource
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:
Construct
The construct tree node for this construct.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
| Name | Description |
|---|---|
| apply | 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
Parameters
- metricName
string - props
MetricOptions
Returns
Return the given named metric for this Api Gateway.