WebSocketRoute L2 construct
Route class that creates the Route for API Gateway WebSocket API.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const webSocketApi: apigatewayv2.WebSocketApi;
declare const webSocketRouteAuthorizer: apigatewayv2.IWebSocketRouteAuthorizer;
declare const webSocketRouteIntegration: apigatewayv2.WebSocketRouteIntegration;
const webSocketRoute = new apigatewayv2.WebSocketRoute(this, 'MyWebSocketRoute', {
integration: webSocketRouteIntegration,
routeKey: 'routeKey',
webSocketApi: webSocketApi,
// the properties below are optional
apiKeyRequired: false,
authorizer: webSocketRouteAuthorizer,
returnResponse: false,
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2
# web_socket_api: apigatewayv2.WebSocketApi
# web_socket_route_authorizer: apigatewayv2.IWebSocketRouteAuthorizer
# web_socket_route_integration: apigatewayv2.WebSocketRouteIntegration
web_socket_route = apigatewayv2.WebSocketRoute(self, "MyWebSocketRoute",
integration=web_socket_route_integration,
route_key="routeKey",
web_socket_api=web_socket_api,
# the properties below are optional
api_key_required=False,
authorizer=web_socket_route_authorizer,
return_response=False
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigatewayv2.*;
WebSocketApi webSocketApi;
IWebSocketRouteAuthorizer webSocketRouteAuthorizer;
WebSocketRouteIntegration webSocketRouteIntegration;
WebSocketRoute webSocketRoute = WebSocketRoute.Builder.create(this, "MyWebSocketRoute")
.integration(webSocketRouteIntegration)
.routeKey("routeKey")
.webSocketApi(webSocketApi)
// the properties below are optional
.apiKeyRequired(false)
.authorizer(webSocketRouteAuthorizer)
.returnResponse(false)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
WebSocketApi webSocketApi;
IWebSocketRouteAuthorizer webSocketRouteAuthorizer;
WebSocketRouteIntegration webSocketRouteIntegration;
var webSocketRoute = new WebSocketRoute(this, "MyWebSocketRoute", new WebSocketRouteProps {
Integration = webSocketRouteIntegration,
RouteKey = "routeKey",
WebSocketApi = webSocketApi,
// the properties below are optional
ApiKeyRequired = false,
Authorizer = webSocketRouteAuthorizer,
ReturnResponse = false
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var webSocketApi WebSocketApi
var webSocketRouteAuthorizer IWebSocketRouteAuthorizer
var webSocketRouteIntegration WebSocketRouteIntegration
webSocketRoute := awscdk.Aws_apigatewayv2.NewWebSocketRoute(this, jsii.String("MyWebSocketRoute"), &WebSocketRouteProps{
Integration: webSocketRouteIntegration,
RouteKey: jsii.String("routeKey"),
WebSocketApi: webSocketApi,
// the properties below are optional
ApiKeyRequired: jsii.Boolean(false),
Authorizer: webSocketRouteAuthorizer,
ReturnResponse: jsii.Boolean(false),
})
Initializer
new WebSocketRoute(scope: Construct, id: string, props: WebSocketRouteProps)
WebSocketRoute(scope: Construct, id: str, props: WebSocketRouteProps)
new WebSocketRoute(Construct scope, String id, WebSocketRouteProps props)
new WebSocketRoute(Construct scope, string id, WebSocketRouteProps props)
NewWebSocketRoute(Scope Construct, Id *string, Props WebSocketRouteProps)
Construct Props
apiKeyRequiredbooleanapi_key_requiredboolapiKeyRequiredBooleanApiKeyRequiredboolApiKeyRequired*bool= false#authorizerIWebSocketRouteAuthorizerauthorizerIWebSocketRouteAuthorizerauthorizerIWebSocketRouteAuthorizerAuthorizerIWebSocketRouteAuthorizerAuthorizerIWebSocketRouteAuthorizer= No Authorizer#You can only set authorizer to a $connect route.
integrationWebSocketRouteIntegrationintegrationWebSocketRouteIntegrationintegrationWebSocketRouteIntegrationIntegrationWebSocketRouteIntegrationIntegrationWebSocketRouteIntegrationrequired#returnResponsebooleanreturn_responseboolreturnResponseBooleanReturnResponseboolReturnResponse*bool= false#webSocketApiIWebSocketApiweb_socket_apiIWebSocketApiwebSocketApiIWebSocketApiWebSocketApiIWebSocketApiWebSocketApiIWebSocketApirequired#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
integrationResponseIdstringintegration_response_idstrintegrationResponseIdStringIntegrationResponseIdstringIntegrationResponseId*string#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#routeRefRouteReferenceroute_refRouteReferencerouteRefRouteReferenceRouteRefRouteReferenceRouteRefRouteReferencerequired#webSocketApiIWebSocketApiweb_socket_apiIWebSocketApiwebSocketApiIWebSocketApiWebSocketApiIWebSocketApiWebSocketApiIWebSocketApirequired#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.