WebSocketStage
Represents a stage where an instance of the API is deployed.
Import
import { WebSocketStage } from 'aws-cdk-lib/aws-apigatewayv2';Or use the module namespace:
import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.WebSocketStageProperties
Configuration passed to the constructor as WebSocketStageProps.
stageNameRequiredstringThe name of the stage.
webSocketApiRequiredIWebSocketApiThe WebSocket API to which this stage is associated.
7 properties inherited from StageOptions
accessLogSettingsOptionalinherited from StageOptionsIAccessLogSettingsSettings for access logging.
Default: - No access logging
autoDeployOptionalinherited from StageOptionsbooleanWhether updates to an API automatically trigger a new deployment.
Default: false
descriptionOptionalinherited from StageOptionsstringThe description for the API stage.
Default: - no description
detailedMetricsEnabledOptionalinherited from StageOptionsbooleanSpecifies whether detailed metrics are enabled.
Default: false
domainMappingOptionalinherited from StageOptionsDomainMappingOptionsThe options for custom domain and api mapping.
Default: - no custom domain and api mapping configuration
stageVariablesOptionalinherited from StageOptions{ [key: string]: string }Stage variables for the stage. These are key-value pairs that you can define and use in your API routes. The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables
Default: - No stage variables
throttleOptionalinherited from StageOptionsThrottleSettingsThrottle settings for the routes of this stage.
Default: - no throttling configuration
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-apigatewayv2