aws-cdk-lib 2.133.0__py3-none-any.whl → 2.134.0__py3-none-any.whl

aws_cdk/aws_apigatewayv2_integrations/__init__.py

@@ -313,6 +313,9 @@ web_socket_api.add_route("$connect",
     )
 )
 ```
+
+You can also set additional properties to change the behavior of your integration, such as `contentHandling`.
+See [Working with binary media types for WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-develop-binary-media-types.html).
 '''
 import abc
 import builtins
@@ -329,7 +332,9 @@ from typeguard import check_type
 from .._jsii import *
 
 import constructs as _constructs_77d1e7e8
+from .. import Duration as _Duration_4839e8c3
 from ..aws_apigatewayv2 import (
+    ContentHandling as _ContentHandling_1512a7da,
     HttpConnectionType as _HttpConnectionType_02a8b6fb,
     HttpIntegrationSubtype as _HttpIntegrationSubtype_beb63b59,
     HttpIntegrationType as _HttpIntegrationType_aee0d440,
@@ -1536,21 +1541,25 @@ class WebSocketAwsIntegration(
         *,
         integration_method: builtins.str,
         integration_uri: builtins.str,
+        content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
         credentials_role: typing.Optional[_IRole_235f5d8e] = None,
         passthrough_behavior: typing.Optional[_PassthroughBehavior_379b8a9e] = None,
         request_parameters: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         request_templates: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         template_selection_expression: typing.Optional[builtins.str] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> None:
         '''
         :param id: id of the underlying integration construct.
         :param integration_method: Specifies the integration's HTTP method type.
         :param integration_uri: Integration URI.
+        :param content_handling: Specifies how to handle response payload content type conversions. Default: - The response payload will be passed through from the integration response to the route response or method response without modification.
         :param credentials_role: Specifies the credentials role required for the integration. Default: - No credential role provided.
         :param passthrough_behavior: Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Default: - No passthrough behavior required.
         :param request_parameters: The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value. Default: - No request parameter provided to the integration.
         :param request_templates: A map of Apache Velocity templates that are applied on the request payload. Example:: { "application/json": "{ \\"statusCode\\": 200 }" } Default: - No request template provided to the integration.
         :param template_selection_expression: The template selection expression for the integration. Default: - No template selection expression provided.
+        :param timeout: The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds. Default: Duration.seconds(29)
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__9bba00d2a284a155db9e940bdf51118b0715f0312e8109e916f7848b20023815)
@@ -1558,11 +1567,13 @@ class WebSocketAwsIntegration(
         props = WebSocketAwsIntegrationProps(
             integration_method=integration_method,
             integration_uri=integration_uri,
+            content_handling=content_handling,
             credentials_role=credentials_role,
             passthrough_behavior=passthrough_behavior,
             request_parameters=request_parameters,
             request_templates=request_templates,
             template_selection_expression=template_selection_expression,
+            timeout=timeout,
         )
 
         jsii.create(self.__class__, self, [id, props])
@@ -1592,11 +1603,13 @@ class WebSocketAwsIntegration(
     name_mapping={
         "integration_method": "integrationMethod",
         "integration_uri": "integrationUri",
+        "content_handling": "contentHandling",
         "credentials_role": "credentialsRole",
         "passthrough_behavior": "passthroughBehavior",
         "request_parameters": "requestParameters",
         "request_templates": "requestTemplates",
         "template_selection_expression": "templateSelectionExpression",
+        "timeout": "timeout",
     },
 )
 class WebSocketAwsIntegrationProps:
@@ -1605,21 +1618,25 @@ class WebSocketAwsIntegrationProps:
         *,
         integration_method: builtins.str,
         integration_uri: builtins.str,
+        content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
         credentials_role: typing.Optional[_IRole_235f5d8e] = None,
         passthrough_behavior: typing.Optional[_PassthroughBehavior_379b8a9e] = None,
         request_parameters: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         request_templates: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         template_selection_expression: typing.Optional[builtins.str] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
     ) -> None:
-        '''Props for AWS type integration for an HTTP Api.
+        '''Props for AWS type integration for a WebSocket Api.
 
         :param integration_method: Specifies the integration's HTTP method type.
         :param integration_uri: Integration URI.
+        :param content_handling: Specifies how to handle response payload content type conversions. Default: - The response payload will be passed through from the integration response to the route response or method response without modification.
         :param credentials_role: Specifies the credentials role required for the integration. Default: - No credential role provided.
         :param passthrough_behavior: Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Default: - No passthrough behavior required.
         :param request_parameters: The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value. Default: - No request parameter provided to the integration.
         :param request_templates: A map of Apache Velocity templates that are applied on the request payload. Example:: { "application/json": "{ \\"statusCode\\": 200 }" } Default: - No request template provided to the integration.
         :param template_selection_expression: The template selection expression for the integration. Default: - No template selection expression provided.
+        :param timeout: The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds. Default: Duration.seconds(29)
 
         :exampleMetadata: infused
 
@@ -1661,15 +1678,19 @@ class WebSocketAwsIntegrationProps:
             type_hints = typing.get_type_hints(_typecheckingstub__aa585be6945644a75e60414b518cacf76637190e70170ea912e9826651e3e5ea)
             check_type(argname="argument integration_method", value=integration_method, expected_type=type_hints["integration_method"])
             check_type(argname="argument integration_uri", value=integration_uri, expected_type=type_hints["integration_uri"])
+            check_type(argname="argument content_handling", value=content_handling, expected_type=type_hints["content_handling"])
             check_type(argname="argument credentials_role", value=credentials_role, expected_type=type_hints["credentials_role"])
             check_type(argname="argument passthrough_behavior", value=passthrough_behavior, expected_type=type_hints["passthrough_behavior"])
             check_type(argname="argument request_parameters", value=request_parameters, expected_type=type_hints["request_parameters"])
             check_type(argname="argument request_templates", value=request_templates, expected_type=type_hints["request_templates"])
             check_type(argname="argument template_selection_expression", value=template_selection_expression, expected_type=type_hints["template_selection_expression"])
+            check_type(argname="argument timeout", value=timeout, expected_type=type_hints["timeout"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "integration_method": integration_method,
             "integration_uri": integration_uri,
         }
+        if content_handling is not None:
+            self._values["content_handling"] = content_handling
         if credentials_role is not None:
             self._values["credentials_role"] = credentials_role
         if passthrough_behavior is not None:
@@ -1680,6 +1701,8 @@ class WebSocketAwsIntegrationProps:
             self._values["request_templates"] = request_templates
         if template_selection_expression is not None:
             self._values["template_selection_expression"] = template_selection_expression
+        if timeout is not None:
+            self._values["timeout"] = timeout
 
     @builtins.property
     def integration_method(self) -> builtins.str:
@@ -1695,6 +1718,18 @@ class WebSocketAwsIntegrationProps:
         assert result is not None, "Required property 'integration_uri' is missing"
         return typing.cast(builtins.str, result)
 
+    @builtins.property
+    def content_handling(self) -> typing.Optional[_ContentHandling_1512a7da]:
+        '''Specifies how to handle response payload content type conversions.
+
+        :default:
+
+        - The response payload will be passed through from the integration response to
+        the route response or method response without modification.
+        '''
+        result = self._values.get("content_handling")
+        return typing.cast(typing.Optional[_ContentHandling_1512a7da], result)
+
     @builtins.property
     def credentials_role(self) -> typing.Optional[_IRole_235f5d8e]:
         '''Specifies the credentials role required for the integration.
@@ -1754,6 +1789,17 @@ class WebSocketAwsIntegrationProps:
         result = self._values.get("template_selection_expression")
         return typing.cast(typing.Optional[builtins.str], result)
 
+    @builtins.property
+    def timeout(self) -> typing.Optional[_Duration_4839e8c3]:
+        '''The maximum amount of time an integration will run before it returns without a response.
+
+        Must be between 50 milliseconds and 29 seconds.
+
+        :default: Duration.seconds(29)
+        '''
+        result = self._values.get("timeout")
+        return typing.cast(typing.Optional[_Duration_4839e8c3], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -1793,16 +1839,29 @@ class WebSocketLambdaIntegration(
         )
     '''
 
-    def __init__(self, id: builtins.str, handler: _IFunction_6adb0ab8) -> None:
+    def __init__(
+        self,
+        id: builtins.str,
+        handler: _IFunction_6adb0ab8,
+        *,
+        content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
+    ) -> None:
         '''
         :param id: id of the underlying integration construct.
         :param handler: the Lambda function handler.
+        :param content_handling: Specifies how to handle response payload content type conversions. Default: - The response payload will be passed through from the integration response to the route response or method response without modification.
+        :param timeout: The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds. Default: Duration.seconds(29)
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__990acb5e6eea396fa4e1595408a45c01b4b03ad6d7085d83c680a56888ae6a6a)
             check_type(argname="argument id", value=id, expected_type=type_hints["id"])
             check_type(argname="argument handler", value=handler, expected_type=type_hints["handler"])
-        jsii.create(self.__class__, self, [id, handler])
+        props = WebSocketLambdaIntegrationProps(
+            content_handling=content_handling, timeout=timeout
+        )
+
+        jsii.create(self.__class__, self, [id, handler, props])
 
     @jsii.member(jsii_name="bind")
     def bind(
@@ -1823,6 +1882,83 @@ class WebSocketLambdaIntegration(
         return typing.cast(_WebSocketRouteIntegrationConfig_7402c18a, jsii.invoke(self, "bind", [options]))
 
 
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_apigatewayv2_integrations.WebSocketLambdaIntegrationProps",
+    jsii_struct_bases=[],
+    name_mapping={"content_handling": "contentHandling", "timeout": "timeout"},
+)
+class WebSocketLambdaIntegrationProps:
+    def __init__(
+        self,
+        *,
+        content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
+        timeout: typing.Optional[_Duration_4839e8c3] = None,
+    ) -> None:
+        '''Props for Lambda type integration for a WebSocket Api.
+
+        :param content_handling: Specifies how to handle response payload content type conversions. Default: - The response payload will be passed through from the integration response to the route response or method response without modification.
+        :param timeout: The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds. Default: Duration.seconds(29)
+
+        :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 as cdk
+            from aws_cdk import aws_apigatewayv2 as apigatewayv2
+            from aws_cdk import aws_apigatewayv2_integrations as apigatewayv2_integrations
+            
+            web_socket_lambda_integration_props = apigatewayv2_integrations.WebSocketLambdaIntegrationProps(
+                content_handling=apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
+                timeout=cdk.Duration.minutes(30)
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__b3043b7d6bcd4be959d4924c0dbbe6ad490dc788f95ab7a014933e7e1b2fefff)
+            check_type(argname="argument content_handling", value=content_handling, expected_type=type_hints["content_handling"])
+            check_type(argname="argument timeout", value=timeout, expected_type=type_hints["timeout"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {}
+        if content_handling is not None:
+            self._values["content_handling"] = content_handling
+        if timeout is not None:
+            self._values["timeout"] = timeout
+
+    @builtins.property
+    def content_handling(self) -> typing.Optional[_ContentHandling_1512a7da]:
+        '''Specifies how to handle response payload content type conversions.
+
+        :default:
+
+        - The response payload will be passed through from the integration response to
+        the route response or method response without modification.
+        '''
+        result = self._values.get("content_handling")
+        return typing.cast(typing.Optional[_ContentHandling_1512a7da], result)
+
+    @builtins.property
+    def timeout(self) -> typing.Optional[_Duration_4839e8c3]:
+        '''The maximum amount of time an integration will run before it returns without a response.
+
+        Must be between 50 milliseconds and 29 seconds.
+
+        :default: Duration.seconds(29)
+        '''
+        result = self._values.get("timeout")
+        return typing.cast(typing.Optional[_Duration_4839e8c3], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "WebSocketLambdaIntegrationProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
 class WebSocketMockIntegration(
     _WebSocketRouteIntegration_bb950e43,
     metaclass=jsii.JSIIMeta,
@@ -2112,6 +2248,7 @@ __all__ = [
     "WebSocketAwsIntegration",
     "WebSocketAwsIntegrationProps",
     "WebSocketLambdaIntegration",
+    "WebSocketLambdaIntegrationProps",
     "WebSocketMockIntegration",
 ]
 
@@ -2305,11 +2442,13 @@ def _typecheckingstub__9bba00d2a284a155db9e940bdf51118b0715f0312e8109e916f7848b2
     *,
     integration_method: builtins.str,
     integration_uri: builtins.str,
+    content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
     credentials_role: typing.Optional[_IRole_235f5d8e] = None,
     passthrough_behavior: typing.Optional[_PassthroughBehavior_379b8a9e] = None,
     request_parameters: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     request_templates: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     template_selection_expression: typing.Optional[builtins.str] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -2318,11 +2457,13 @@ def _typecheckingstub__aa585be6945644a75e60414b518cacf76637190e70170ea912e982665
     *,
     integration_method: builtins.str,
     integration_uri: builtins.str,
+    content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
     credentials_role: typing.Optional[_IRole_235f5d8e] = None,
     passthrough_behavior: typing.Optional[_PassthroughBehavior_379b8a9e] = None,
     request_parameters: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     request_templates: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     template_selection_expression: typing.Optional[builtins.str] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -2330,6 +2471,17 @@ def _typecheckingstub__aa585be6945644a75e60414b518cacf76637190e70170ea912e982665
 def _typecheckingstub__990acb5e6eea396fa4e1595408a45c01b4b03ad6d7085d83c680a56888ae6a6a(
     id: builtins.str,
     handler: _IFunction_6adb0ab8,
+    *,
+    content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__b3043b7d6bcd4be959d4924c0dbbe6ad490dc788f95ab7a014933e7e1b2fefff(
+    *,
+    content_handling: typing.Optional[_ContentHandling_1512a7da] = None,
+    timeout: typing.Optional[_Duration_4839e8c3] = None,
 ) -> None:
     """Type checking stubs"""
     pass