@aws-cdk_aws-apigatewayv2-alpha.IWebSocketStage

interface IWebSocketStage ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.IWebSocketStage
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#IWebSocketStage
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.IWebSocketStage
Pythonaws_cdk.aws_apigatewayv2_alpha.IWebSocketStage
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป IWebSocketStage

Implemented by WebSocketStage

Obtainable from WebSocketStage.fromWebSocketStageAttributes()

Represents the WebSocketStage.

Properties

NameTypeDescription
api๐Ÿ”นIWebSocketApiThe API this stage is associated to.
callbackUrl๐Ÿ”นstringThe callback URL to this stage.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
stageName๐Ÿ”นstringThe name of the stage;
url๐Ÿ”นstringThe 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 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.


stageName๐Ÿ”น

Type: string

The name of the stage;

its primary identifier.


url๐Ÿ”น

Type: string

The URL to this stage.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
metric(metricName, props?)๐Ÿ”นReturn the given named metric for this HTTP Api Gateway 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.