WebSocketRoute

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

Bases: Resource

Route class that creates the Route for API Gateway WebSocket API.

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

Parameters:

scope (Construct) –
id (str) –
route_key (str) – The key to this route.
web_socket_api (IWebSocketApi) – The API the route is associated with.
api_key_required (Optional[bool]) – Whether the route requires an API Key to be provided. Default: false
integration (WebSocketRouteIntegration) – The integration to be configured on this route.
authorizer (Optional[IWebSocketRouteAuthorizer]) – The authorize to this route. You can only set authorizer to a $connect route. Default: - No Authorizer
return_response (Optional[bool]) – Should the route send a response to the client. Default: false

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.

integration_response_id: Integration response ID.

node: The tree node.

route_id: Id of the Route.

route_key: The key to this route.

stack: The stack in which this resource is defined.

web_socket_api: The WebSocket API associated with this route.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

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:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool