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:
aws_cdk.core.Resource
(experimental) Create a new API Gateway WebSocket API endpoint.
- Stability
experimental
- ExampleMetadata
infused
- Resource
AWS::ApiGatewayV2::Api
Example:
from aws_cdk.aws_apigatewayv2_integrations import WebSocketLambdaIntegration # message_handler: lambda.Function web_socket_api = apigwv2.WebSocketApi(self, "mywsapi") web_socket_api.add_route("sendmessage", integration=WebSocketLambdaIntegration("SendMessageIntegration", message_handler) )
- Parameters
scope (
Construct
) –id (
str
) –api_key_selection_expression (
Optional
[WebSocketApiKeySelectionExpression
]) – (experimental) 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 APIsapi_name (
Optional
[str
]) – (experimental) Name for the WebSocket API resource. Default: - id of the WebSocketApi construct.connect_route_options (
Union
[WebSocketRouteOptions
,Dict
[str
,Any
],None
]) – (experimental) Options to configure a ‘$connect’ route. Default: - no ‘$connect’ route configureddefault_route_options (
Union
[WebSocketRouteOptions
,Dict
[str
,Any
],None
]) – (experimental) Options to configure a ‘$default’ route. Default: - no ‘$default’ route configureddescription (
Optional
[str
]) – (experimental) The description of the API. Default: - nonedisconnect_route_options (
Union
[WebSocketRouteOptions
,Dict
[str
,Any
],None
]) – (experimental) Options to configure a ‘$disconnect’ route. Default: - no ‘$disconnect’ route configuredroute_selection_expression (
Optional
[str
]) – (experimental) The route selection expression for the API. Default: ‘$request.body.action’
- Stability
experimental
Methods
-
add_route
(route_key, *, integration, authorizer=None)¶ (experimental) Add a new route.
- Parameters
route_key (
str
) –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
- Return type
-
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
-
grant_manage_connections
(identity)¶ (experimental) Grant access to the API Gateway management API for this WebSocket API to an IAM principal (Role/Group/User).
- Parameters
identity (
IGrantable
) – The principal.- Stability
experimental
- Return type
-
metric
(metric_name, *, account=None, color=None, dimensions=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None)¶ (experimental) 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. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions (
Optional
[Mapping
[str
,Any
]]) – (deprecated) Dimensions of the metric. Default: - No dimensions.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 labelperiod (
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. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Averageunit (
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
- Stability
experimental
- Return type
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
api_endpoint
¶ (experimental) The default endpoint for an API.
- Stability
experimental
- Return type
str
-
api_id
¶ (experimental) The identifier of this API Gateway API.
- Stability
experimental
- Return type
str
-
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
-
node
¶ The construct tree node associated with this construct.
- Return type
-
web_socket_api_name
¶ (experimental) A human friendly name for this WebSocket API.
Note that this is different from
webSocketApiId
.- Stability
experimental
- Return type
Optional
[str
]
Static Methods
-
classmethod
from_web_socket_api_attributes
(scope, id, *, web_socket_id, api_endpoint=None)¶ (experimental) Import an existing WebSocket API into this CDK app.
- Parameters
scope (
Construct
) –id (
str
) –web_socket_id (
str
) – (experimental) The identifier of the WebSocketApi.api_endpoint (
Optional
[str
]) – (experimental) The endpoint URL of the WebSocketApi. Default: - throw san error if apiEndpoint is accessed.
- Stability
experimental
- Return type
-
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