@aws-cdk_aws-apigatewayv2-alpha.WebSocketStage

class WebSocketStage (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IWebSocketStage, IStage

Represents a stage where an instance of the API is deployed.

Example

import { WebSocketLambdaIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi');
new apigwv2.WebSocketStage(this, 'mystage', {
  webSocketApi,
  stageName: 'dev',
  autoDeploy: true,
});

declare const messageHandler: lambda.Function;
webSocketApi.addRoute('sendmessage', {
  integration: new WebSocketLambdaIntegration('SendMessageIntegration', messageHandler),
});

Initializer

new WebSocketStage(scope: Construct, id: string, props: WebSocketStageProps)

Parameters

  • scope Construct
  • id string
  • props WebSocketStageProps

Construct Props

NameTypeDescription
stageName๐Ÿ”นstringThe name of the stage.
webSocketApi๐Ÿ”นIWebSocketApiThe WebSocket API to which this stage is associated.
autoDeploy?๐Ÿ”นbooleanWhether updates to an API automatically trigger a new deployment.
domainMapping?๐Ÿ”นDomainMappingOptionsThe options for custom domain and api mapping.
throttle?๐Ÿ”นThrottleSettingsThrottle settings for the routes of this stage.

stageName๐Ÿ”น

Type: string

The name of the stage.


webSocketApi๐Ÿ”น

Type: IWebSocketApi

The WebSocket API to which this stage is associated.


autoDeploy?๐Ÿ”น

Type: boolean (optional, default: false)

Whether updates to an API automatically trigger a new deployment.


domainMapping?๐Ÿ”น

Type: DomainMappingOptions (optional, default: no custom domain and api mapping configuration)

The options for custom domain and api mapping.


throttle?๐Ÿ”น

Type: ThrottleSettings (optional, default: no throttling configuration)

Throttle settings for the routes of this stage.

Properties

NameTypeDescription
api๐Ÿ”นIWebSocketApiThe API this stage is associated to.
baseApi๐Ÿ”นIApi
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 websocket URL to this stage.

api๐Ÿ”น

Type: IWebSocketApi

The API this stage is associated to.


baseApi๐Ÿ”น

Type: IApi


callbackUrl๐Ÿ”น

Type: string

The callback URL to this stage.


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 websocket URL to this stage.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
grantManagementApiAccess(identity)๐Ÿ”นGrant access to the API Gateway management API for this WebSocket API Stage to an IAM principal (Role/Group/User).
metric(metricName, props?)๐Ÿ”นReturn the given named metric for this HTTP Api Gateway Stage.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromWebSocketStageAttributes(scope, id, attrs)๐Ÿ”นImport an existing stage into this CDK app.

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


grantManagementApiAccess(identity)๐Ÿ”น

public grantManagementApiAccess(identity: IGrantable): Grant

Parameters

  • identity IGrantable โ€” The principal.

Returns

  • Grant

Grant access to the API Gateway management API for this WebSocket API Stage to an IAM principal (Role/Group/User).


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.


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromWebSocketStageAttributes(scope, id, attrs)๐Ÿ”น

public static fromWebSocketStageAttributes(scope: Construct, id: string, attrs: WebSocketStageAttributes): IWebSocketStage

Parameters

  • scope Construct
  • id string
  • attrs WebSocketStageAttributes

Returns

  • IWebSocketStage

Import an existing stage into this CDK app.