WebSocketIntegrationProps

class aws_cdk.aws_apigatewayv2.WebSocketIntegrationProps(*, integration_type, integration_uri, web_socket_api)

Bases: object

(experimental) The integration properties.

Parameters
  • integration_type (WebSocketIntegrationType) – (experimental) Integration type.

  • integration_uri (str) – (experimental) Integration URI.

  • web_socket_api (IWebSocketApi) – (experimental) The WebSocket API to which this integration should be bound.

Stability

experimental

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: apigatewayv2.WebSocketApi

web_socket_integration_props = apigatewayv2.WebSocketIntegrationProps(
    integration_type=apigatewayv2.WebSocketIntegrationType.AWS_PROXY,
    integration_uri="integrationUri",
    web_socket_api=web_socket_api
)

Attributes

integration_type

(experimental) Integration type.

Stability

experimental

Return type

WebSocketIntegrationType

integration_uri

(experimental) Integration URI.

Stability

experimental

Return type

str

web_socket_api

(experimental) The WebSocket API to which this integration should be bound.

Stability

experimental

Return type

IWebSocketApi