WebSocketApi

class aws_cdk.aws_apigatewayv2.WebSocketApi(scope, id, *, api_key_selection_expression=None, api_name=None, connect_route_options=None, default_route_options=None, description=None, disconnect_route_options=None, route_selection_expression=None)

Bases: Resource

Create a new API Gateway WebSocket API endpoint.

Resource:

AWS::ApiGatewayV2::Api

ExampleMetadata:

infused

Example:

from aws_cdk.aws_apigatewayv2_integrations import WebSocketLambdaIntegration

# message_handler: lambda.Function


web_socket_api = apigwv2.WebSocketApi(self, "mywsapi")
apigwv2.WebSocketStage(self, "mystage",
    web_socket_api=web_socket_api,
    stage_name="dev",
    auto_deploy=True
)
web_socket_api.add_route("sendMessage",
    integration=WebSocketLambdaIntegration("SendMessageIntegration", message_handler)
)
Parameters:

  • scope (Construct) –

  • id (str) –

  • api_key_selection_expression (Optional[WebSocketApiKeySelectionExpression]) – An API key selection expression. Providing this option will require an API Key be provided to access the API. Default: - Key is not required to access these APIs

  • api_name (Optional[str]) – Name for the WebSocket API resource. Default: - id of the WebSocketApi construct.

  • connect_route_options (Union[WebSocketRouteOptions, Dict[str, Any], None]) – Options to configure a ‘$connect’ route. Default: - no ‘$connect’ route configured

  • default_route_options (Union[WebSocketRouteOptions, Dict[str, Any], None]) – Options to configure a ‘$default’ route. Default: - no ‘$default’ route configured

  • description (Optional[str]) – The description of the API. Default: - none

  • disconnect_route_options (Union[WebSocketRouteOptions, Dict[str, Any], None]) – Options to configure a ‘$disconnect’ route. Default: - no ‘$disconnect’ route configured

  • route_selection_expression (Optional[str]) – The route selection expression for the API. Default: ‘$request.body.action’

Methods

add_route(route_key, *, integration, authorizer=None, return_response=None)

Add a new route.

Parameters:

  • route_key (str) –

  • 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

Return type:

WebSocketRoute

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

arn_for_execute_api(method=None, path=None, stage=None)

Get the “execute-api” ARN.

When ‘ANY’ is passed to the method, an ARN with the method set to ‘*’ is obtained.

Parameters:

  • method (Optional[str]) –

  • path (Optional[str]) –

  • stage (Optional[str]) –

Default:

Return type:

str

  • The default behavior applies when no specific method, path, or stage is provided.

In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if ‘method’ is not specified, it defaults to ‘*’, representing all methods. If ‘path’ is not specified, it defaults to ‘/’, representing all paths. If ‘stage’ is not specified, it also defaults to ‘’, representing all stages.

grant_manage_connections(identity)

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

Parameters:

identity (IGrantable) – The principal.

Return type:

Grant

metric(metric_name, *, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)

Return the given named metric for this Api Gateway.

Parameters:

  • metric_name (str) –

  • account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.

  • color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color

  • dimensions_map (Optional[Mapping[str, str]]) – Dimensions of the metric. Default: - No dimensions.

  • label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No label

  • period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)

  • region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.

  • statistic (Optional[str]) – What function to use for aggregating. Use the aws_cloudwatch.Stats helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Average

  • unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type:

Metric

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

api_endpoint

The default endpoint for an API.

api_id

The identifier of this API Gateway API.

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.

node

The tree node.

stack

The stack in which this resource is defined.

web_socket_api_name

A human friendly name for this WebSocket API.

Note that this is different from webSocketApiId.

Static Methods

classmethod from_web_socket_api_attributes(scope, id, *, web_socket_id, api_endpoint=None)

Import an existing WebSocket API into this CDK app.

Parameters:

  • scope (Construct) –

  • id (str) –

  • web_socket_id (str) – The identifier of the WebSocketApi.

  • api_endpoint (Optional[str]) – The endpoint URL of the WebSocketApi. Default: - throw san error if apiEndpoint is accessed.

Return type:

IWebSocketApi

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