WebSocketRoute

class aws_cdk.aws_apigatewayv2.WebSocketRoute(scope, id, *, route_key, web_socket_api, integration, authorizer=None)

Bases: aws_cdk.core.Resource

(experimental) Route class that creates the Route for API Gateway WebSocket API.

Stability

experimental

Resource

AWS::ApiGatewayV2::Route

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# web_socket_api is of type WebSocketApi
# web_socket_route_authorizer is of type IWebSocketRouteAuthorizer
# web_socket_route_integration is of type 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
    authorizer=web_socket_route_authorizer
)
Parameters
  • scope (Construct) –

  • id (str) –

  • route_key (str) – (experimental) The key to this route.

  • web_socket_api (IWebSocketApi) – (experimental) The API the route is associated with.

  • integration (WebSocketRouteIntegration) – (experimental) The integration to be configured on this route.

  • authorizer (Optional[IWebSocketRouteAuthorizer]) – (experimental) The authorize to this route. You can only set authorizer to a $connect route. Default: - No Authorizer

Stability

experimental

Methods

apply_removal_policy(policy)

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

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

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.

Return type

ResourceEnvironment

integration_response_id

(experimental) Integration response ID.

Stability

experimental

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

route_id

(experimental) Id of the Route.

Stability

experimental

Return type

str

route_key

(experimental) The key to this route.

Stability

experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

web_socket_api

(experimental) The WebSocket API associated with this route.

Stability

experimental

Return type

IWebSocketApi

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool