aws-cdk-lib 2.178.2__py3-none-any.whl → 2.179.0__py3-none-any.whl

aws_cdk/aws_apigatewayv2_integrations/__init__.py

@@ -8,6 +8,7 @@ r'''
   * [Lambda Integration](#lambda)
   * [HTTP Proxy Integration](#http-proxy)
   * [StepFunctions Integration](#stepfunctions-integration)
+  * [SQS Integration](#sqs-integration)
   * [Private Integration](#private-integration)
   * [Request Parameters](#request-parameters)
 * [WebSocket APIs](#websocket-apis)
@@ -128,6 +129,91 @@ http_api.add_routes(
 * The `executionArn` parameter is required for the `STOP_EXECUTION` subtype. It is necessary to specify the `executionArn` in the `parameterMapping` property of the `HttpStepFunctionsIntegration` object.
 * `START_SYNC_EXECUTION` subtype is only supported for EXPRESS type state machine.
 
+### SQS Integration
+
+SQS integrations enable integrating an HTTP API route with AWS SQS.
+This allows the HTTP API to send, receive and delete messages from an SQS queue.
+
+The following code configures a SQS integrations:
+
+```python
+import aws_cdk.aws_sqs as sqs
+from aws_cdk.aws_apigatewayv2_integrations import HttpSqsIntegration
+
+# queue: sqs.IQueue
+# http_api: apigwv2.HttpApi
+
+
+# default integration (send message)
+http_api.add_routes(
+    path="/default",
+    methods=[apigwv2.HttpMethod.POST],
+    integration=HttpSqsIntegration("defaultIntegration",
+        queue=queue
+    )
+)
+# send message integration
+http_api.add_routes(
+    path="/send-message",
+    methods=[apigwv2.HttpMethod.POST],
+    integration=HttpSqsIntegration("sendMessageIntegration",
+        queue=queue,
+        subtype=apigwv2.HttpIntegrationSubtype.SQS_SEND_MESSAGE
+    )
+)
+# receive message integration
+http_api.add_routes(
+    path="/receive-message",
+    methods=[apigwv2.HttpMethod.POST],
+    integration=HttpSqsIntegration("receiveMessageIntegration",
+        queue=queue,
+        subtype=apigwv2.HttpIntegrationSubtype.SQS_RECEIVE_MESSAGE
+    )
+)
+# delete message integration
+http_api.add_routes(
+    path="/delete-message",
+    methods=[apigwv2.HttpMethod.POST],
+    integration=HttpSqsIntegration("deleteMessageIntegration",
+        queue=queue,
+        subtype=apigwv2.HttpIntegrationSubtype.SQS_DELETE_MESSAGE
+    )
+)
+# purge queue integration
+http_api.add_routes(
+    path="/purge-queue",
+    methods=[apigwv2.HttpMethod.POST],
+    integration=HttpSqsIntegration("purgeQueueIntegration",
+        queue=queue,
+        subtype=apigwv2.HttpIntegrationSubtype.SQS_PURGE_QUEUE
+    )
+)
+```
+
+#### SQS integration parameter mappings
+
+You can configure the custom parameter mappings of the SQS integration using the `parameterMapping` property of the `HttpSqsIntegration` object.
+
+The default parameter mapping settings for each subtype are as follows:
+
+```python
+import aws_cdk.aws_sqs as sqs
+# queue: sqs.IQueue
+
+
+# SQS_SEND_MESSAGE
+apigwv2.ParameterMapping().custom("QueueUrl", queue.queue_url).custom("MessageBody", "$request.body.MessageBody")
+
+# SQS_RECEIVE_MESSAGE
+apigwv2.ParameterMapping().custom("QueueUrl", queue.queue_url)
+
+# SQS_DELETE_MESSAGE
+apigwv2.ParameterMapping().custom("QueueUrl", queue.queue_url).custom("ReceiptHandle", "$request.body.ReceiptHandle")
+
+# SQS_PURGE_QUEUE
+apigwv2.ParameterMapping().custom("QueueUrl", queue.queue_url)
+```
+
 ### Private Integration
 
 Private integrations enable integrating an HTTP API route with private resources in a VPC, such as Application Load Balancers or
@@ -430,6 +516,7 @@ from ..aws_elasticloadbalancingv2 import (
 from ..aws_iam import IRole as _IRole_235f5d8e
 from ..aws_lambda import IFunction as _IFunction_6adb0ab8
 from ..aws_servicediscovery import IService as _IService_46860ae1
+from ..aws_sqs import IQueue as _IQueue_7ed6f679
 from ..aws_stepfunctions import StateMachine as _StateMachine_a256d24f
 
 
@@ -1271,6 +1358,246 @@ class HttpServiceDiscoveryIntegrationProps(HttpPrivateIntegrationOptions):
         )
 
 
+class HttpSqsIntegration(
+    _HttpRouteIntegration_d3ee7c34,
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.aws_apigatewayv2_integrations.HttpSqsIntegration",
+):
+    '''The Sqs integration resource for HTTP API.
+
+    :exampleMetadata: infused
+
+    Example::
+
+        import aws_cdk.aws_sqs as sqs
+        from aws_cdk.aws_apigatewayv2_integrations import HttpSqsIntegration
+        
+        # queue: sqs.IQueue
+        # http_api: apigwv2.HttpApi
+        
+        
+        # default integration (send message)
+        http_api.add_routes(
+            path="/default",
+            methods=[apigwv2.HttpMethod.POST],
+            integration=HttpSqsIntegration("defaultIntegration",
+                queue=queue
+            )
+        )
+        # send message integration
+        http_api.add_routes(
+            path="/send-message",
+            methods=[apigwv2.HttpMethod.POST],
+            integration=HttpSqsIntegration("sendMessageIntegration",
+                queue=queue,
+                subtype=apigwv2.HttpIntegrationSubtype.SQS_SEND_MESSAGE
+            )
+        )
+        # receive message integration
+        http_api.add_routes(
+            path="/receive-message",
+            methods=[apigwv2.HttpMethod.POST],
+            integration=HttpSqsIntegration("receiveMessageIntegration",
+                queue=queue,
+                subtype=apigwv2.HttpIntegrationSubtype.SQS_RECEIVE_MESSAGE
+            )
+        )
+        # delete message integration
+        http_api.add_routes(
+            path="/delete-message",
+            methods=[apigwv2.HttpMethod.POST],
+            integration=HttpSqsIntegration("deleteMessageIntegration",
+                queue=queue,
+                subtype=apigwv2.HttpIntegrationSubtype.SQS_DELETE_MESSAGE
+            )
+        )
+        # purge queue integration
+        http_api.add_routes(
+            path="/purge-queue",
+            methods=[apigwv2.HttpMethod.POST],
+            integration=HttpSqsIntegration("purgeQueueIntegration",
+                queue=queue,
+                subtype=apigwv2.HttpIntegrationSubtype.SQS_PURGE_QUEUE
+            )
+        )
+    '''
+
+    def __init__(
+        self,
+        id: builtins.str,
+        *,
+        queue: _IQueue_7ed6f679,
+        parameter_mapping: typing.Optional[_ParameterMapping_c11a48e0] = None,
+        subtype: typing.Optional[_HttpIntegrationSubtype_beb63b59] = None,
+    ) -> None:
+        '''
+        :param id: id of the underlying integration construct.
+        :param queue: SQS queue that Integrates with API Gateway.
+        :param parameter_mapping: Specifies how to transform HTTP requests before sending them to the backend. Default: - specify ``QueueUrl``. Additionally, set ``MessageBody`` to ``$request.body.MessageBody`` for ``SQS_SEND_MESSAGE`` subtype and set ``ReceiptHandle`` to ``$request.body.ReceiptHandle`` for ``SQS_DELETE_MESSAGE`` subtype.
+        :param subtype: The subtype of the HTTP integration. Only subtypes starting with SQS_ can be specified. Default: HttpIntegrationSubtype.SQS_SEND_MESSAGE
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__26e844829cda3c6c377e33299ff9302e7502c75bb44dad66e9545facd663d244)
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+        props = HttpSqsIntegrationProps(
+            queue=queue, parameter_mapping=parameter_mapping, subtype=subtype
+        )
+
+        jsii.create(self.__class__, self, [id, props])
+
+    @jsii.member(jsii_name="bind")
+    def bind(
+        self,
+        *,
+        route: _IHttpRoute_2fbc6171,
+        scope: _constructs_77d1e7e8.Construct,
+    ) -> _HttpRouteIntegrationConfig_aafc4b76:
+        '''Bind this integration to the route.
+
+        :param route: The route to which this is being bound.
+        :param scope: The current scope in which the bind is occurring. If the ``HttpRouteIntegration`` being bound creates additional constructs, this will be used as their parent scope.
+        '''
+        options = _HttpRouteIntegrationBindOptions_f870a39e(route=route, scope=scope)
+
+        return typing.cast(_HttpRouteIntegrationConfig_aafc4b76, jsii.invoke(self, "bind", [options]))
+
+
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_apigatewayv2_integrations.HttpSqsIntegrationProps",
+    jsii_struct_bases=[],
+    name_mapping={
+        "queue": "queue",
+        "parameter_mapping": "parameterMapping",
+        "subtype": "subtype",
+    },
+)
+class HttpSqsIntegrationProps:
+    def __init__(
+        self,
+        *,
+        queue: _IQueue_7ed6f679,
+        parameter_mapping: typing.Optional[_ParameterMapping_c11a48e0] = None,
+        subtype: typing.Optional[_HttpIntegrationSubtype_beb63b59] = None,
+    ) -> None:
+        '''Properties to initialize ``HttpSqsIntegration``.
+
+        :param queue: SQS queue that Integrates with API Gateway.
+        :param parameter_mapping: Specifies how to transform HTTP requests before sending them to the backend. Default: - specify ``QueueUrl``. Additionally, set ``MessageBody`` to ``$request.body.MessageBody`` for ``SQS_SEND_MESSAGE`` subtype and set ``ReceiptHandle`` to ``$request.body.ReceiptHandle`` for ``SQS_DELETE_MESSAGE`` subtype.
+        :param subtype: The subtype of the HTTP integration. Only subtypes starting with SQS_ can be specified. Default: HttpIntegrationSubtype.SQS_SEND_MESSAGE
+
+        :exampleMetadata: infused
+
+        Example::
+
+            import aws_cdk.aws_sqs as sqs
+            from aws_cdk.aws_apigatewayv2_integrations import HttpSqsIntegration
+            
+            # queue: sqs.IQueue
+            # http_api: apigwv2.HttpApi
+            
+            
+            # default integration (send message)
+            http_api.add_routes(
+                path="/default",
+                methods=[apigwv2.HttpMethod.POST],
+                integration=HttpSqsIntegration("defaultIntegration",
+                    queue=queue
+                )
+            )
+            # send message integration
+            http_api.add_routes(
+                path="/send-message",
+                methods=[apigwv2.HttpMethod.POST],
+                integration=HttpSqsIntegration("sendMessageIntegration",
+                    queue=queue,
+                    subtype=apigwv2.HttpIntegrationSubtype.SQS_SEND_MESSAGE
+                )
+            )
+            # receive message integration
+            http_api.add_routes(
+                path="/receive-message",
+                methods=[apigwv2.HttpMethod.POST],
+                integration=HttpSqsIntegration("receiveMessageIntegration",
+                    queue=queue,
+                    subtype=apigwv2.HttpIntegrationSubtype.SQS_RECEIVE_MESSAGE
+                )
+            )
+            # delete message integration
+            http_api.add_routes(
+                path="/delete-message",
+                methods=[apigwv2.HttpMethod.POST],
+                integration=HttpSqsIntegration("deleteMessageIntegration",
+                    queue=queue,
+                    subtype=apigwv2.HttpIntegrationSubtype.SQS_DELETE_MESSAGE
+                )
+            )
+            # purge queue integration
+            http_api.add_routes(
+                path="/purge-queue",
+                methods=[apigwv2.HttpMethod.POST],
+                integration=HttpSqsIntegration("purgeQueueIntegration",
+                    queue=queue,
+                    subtype=apigwv2.HttpIntegrationSubtype.SQS_PURGE_QUEUE
+                )
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__8a7e21b776e0221926527e68875c71cef4289537168431b8f7179bdb31603f63)
+            check_type(argname="argument queue", value=queue, expected_type=type_hints["queue"])
+            check_type(argname="argument parameter_mapping", value=parameter_mapping, expected_type=type_hints["parameter_mapping"])
+            check_type(argname="argument subtype", value=subtype, expected_type=type_hints["subtype"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {
+            "queue": queue,
+        }
+        if parameter_mapping is not None:
+            self._values["parameter_mapping"] = parameter_mapping
+        if subtype is not None:
+            self._values["subtype"] = subtype
+
+    @builtins.property
+    def queue(self) -> _IQueue_7ed6f679:
+        '''SQS queue that Integrates with API Gateway.'''
+        result = self._values.get("queue")
+        assert result is not None, "Required property 'queue' is missing"
+        return typing.cast(_IQueue_7ed6f679, result)
+
+    @builtins.property
+    def parameter_mapping(self) -> typing.Optional[_ParameterMapping_c11a48e0]:
+        '''Specifies how to transform HTTP requests before sending them to the backend.
+
+        :default:
+
+        - specify ``QueueUrl``. Additionally, set ``MessageBody`` to ``$request.body.MessageBody`` for ``SQS_SEND_MESSAGE`` subtype
+        and set ``ReceiptHandle`` to ``$request.body.ReceiptHandle`` for ``SQS_DELETE_MESSAGE`` subtype.
+
+        :see: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html
+        '''
+        result = self._values.get("parameter_mapping")
+        return typing.cast(typing.Optional[_ParameterMapping_c11a48e0], result)
+
+    @builtins.property
+    def subtype(self) -> typing.Optional[_HttpIntegrationSubtype_beb63b59]:
+        '''The subtype of the HTTP integration.
+
+        Only subtypes starting with SQS_ can be specified.
+
+        :default: HttpIntegrationSubtype.SQS_SEND_MESSAGE
+        '''
+        result = self._values.get("subtype")
+        return typing.cast(typing.Optional[_HttpIntegrationSubtype_beb63b59], 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 "HttpSqsIntegrationProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
 class HttpStepFunctionsIntegration(
     _HttpRouteIntegration_d3ee7c34,
     metaclass=jsii.JSIIMeta,
@@ -2554,6 +2881,8 @@ __all__ = [
     "HttpPrivateIntegrationOptions",
     "HttpServiceDiscoveryIntegration",
     "HttpServiceDiscoveryIntegrationProps",
+    "HttpSqsIntegration",
+    "HttpSqsIntegrationProps",
     "HttpStepFunctionsIntegration",
     "HttpStepFunctionsIntegrationProps",
     "HttpUrlIntegration",
@@ -2721,6 +3050,25 @@ def _typecheckingstub__8bbb857ee24522818d504a3830c65b95bbc66b9ef70c67fa5b85fbdca
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__26e844829cda3c6c377e33299ff9302e7502c75bb44dad66e9545facd663d244(
+    id: builtins.str,
+    *,
+    queue: _IQueue_7ed6f679,
+    parameter_mapping: typing.Optional[_ParameterMapping_c11a48e0] = None,
+    subtype: typing.Optional[_HttpIntegrationSubtype_beb63b59] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__8a7e21b776e0221926527e68875c71cef4289537168431b8f7179bdb31603f63(
+    *,
+    queue: _IQueue_7ed6f679,
+    parameter_mapping: typing.Optional[_ParameterMapping_c11a48e0] = None,
+    subtype: typing.Optional[_HttpIntegrationSubtype_beb63b59] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__76518171338936bd0fbff4054b2b72b876355e21b6eef931d4dd4f111fc7889f(
     id: builtins.str,
     *,

aws_cdk/aws_applicationautoscaling/__init__.py

@@ -1496,9 +1496,9 @@ class CfnScalableTarget(
             *,
             schedule: builtins.str,
             scheduled_action_name: builtins.str,
-            end_time: typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]] = None,
+            end_time: typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]] = None,
             scalable_target_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnScalableTarget.ScalableTargetActionProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
-            start_time: typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]] = None,
+            start_time: typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]] = None,
             timezone: typing.Optional[builtins.str] = None,
         ) -> None:
             '''``ScheduledAction`` is a property of the `AWS::ApplicationAutoScaling::ScalableTarget <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalabletarget.html>`_ resource that specifies a scheduled action for a scalable target.
@@ -1593,13 +1593,13 @@ class CfnScalableTarget(
         @builtins.property
         def end_time(
             self,
-        ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]]:
+        ) -> typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]]:
             '''The date and time that the action is scheduled to end, in UTC.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-endtime
             '''
             result = self._values.get("end_time")
-            return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]], result)
+            return typing.cast(typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]], result)
 
         @builtins.property
         def scalable_target_action(
@@ -1617,13 +1617,13 @@ class CfnScalableTarget(
         @builtins.property
         def start_time(
             self,
-        ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]]:
+        ) -> typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]]:
             '''The date and time that the action is scheduled to begin, in UTC.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationautoscaling-scalabletarget-scheduledaction.html#cfn-applicationautoscaling-scalabletarget-scheduledaction-starttime
             '''
             result = self._values.get("start_time")
-            return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]], result)
+            return typing.cast(typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]], result)
 
         @builtins.property
         def timezone(self) -> typing.Optional[builtins.str]:
@@ -7849,9 +7849,9 @@ def _typecheckingstub__602ff955f286e3df520d04ef3c033f033ea91710efbf10e64903936bd
     *,
     schedule: builtins.str,
     scheduled_action_name: builtins.str,
-    end_time: typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]] = None,
+    end_time: typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]] = None,
     scalable_target_action: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnScalableTarget.ScalableTargetActionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
-    start_time: typing.Optional[typing.Union[_IResolvable_da3f097b, datetime.datetime]] = None,
+    start_time: typing.Optional[typing.Union[datetime.datetime, _IResolvable_da3f097b]] = None,
     timezone: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""

aws_cdk/aws_appsync/__init__.py

@@ -970,9 +970,9 @@ Each option provides a different method of security:
 
 * API Keys (`AppSyncAuthorizationType.API_KEY`)
 * Amazon Cognito User Pools (`AppSyncAuthorizationType.USER_POOL`)
-* OpenID Connect (`AppSyncAuthorizationType.OPENID_CONNECT`)
-* AWS Identity and Access Management (`AppSyncAuthorizationType.AWS_IAM`)
-* AWS Lambda (`AppSyncAuthorizationType.AWS_LAMBDA`)
+* OpenID Connect (`AppSyncAuthorizationType.OIDC`)
+* AWS Identity and Access Management (`AppSyncAuthorizationType.IAM`)
+* AWS Lambda (`AppSyncAuthorizationType.LAMBDA`)
 
 When you define your API, you configure the authorization mode to connect to your Event API WebSocket.
 You also configure the default authorization modes to use when publishing and subscribing to messages.
@@ -22172,7 +22172,9 @@ class EventApi(
     @builtins.property
     @jsii.member(jsii_name="apiKeys")
     def api_keys(self) -> typing.Mapping[builtins.str, CfnApiKey]:
-        '''the configured API keys, if present.
+        '''The configured API keys, if present.
+
+        The key of this object is an apiKey name (apiKeyConfig.name) if specified, ``Default`` otherwise.
 
         :default: - no api key
 

aws_cdk/aws_cloudfront/__init__.py

@@ -20067,7 +20067,7 @@ class OriginBase(
     @jsii.member(jsii_name="bind")
     def bind(
         self,
-        _scope: _constructs_77d1e7e8.Construct,
+        scope: _constructs_77d1e7e8.Construct,
         *,
         origin_id: builtins.str,
         distribution_id: typing.Optional[builtins.str] = None,
@@ -20076,18 +20076,18 @@ class OriginBase(
 
         Can be used to grant permissions, create dependent resources, etc.
 
-        :param _scope: -
+        :param scope: -
         :param origin_id: The identifier of this Origin, as assigned by the Distribution this Origin has been used added to.
         :param distribution_id: The identifier of the Distribution this Origin is used for. This is used to grant origin access permissions to the distribution for origin access control. Default: - no distribution id
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__8428dfc90e69bdd5363e69afd9c590a4ed2f1363b22242197295117dc5221878)
-            check_type(argname="argument _scope", value=_scope, expected_type=type_hints["_scope"])
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
         options = OriginBindOptions(
             origin_id=origin_id, distribution_id=distribution_id
         )
 
-        return typing.cast("OriginBindConfig", jsii.invoke(self, "bind", [_scope, options]))
+        return typing.cast("OriginBindConfig", jsii.invoke(self, "bind", [scope, options]))
 
     @jsii.member(jsii_name="renderCustomOriginConfig")
     def _render_custom_origin_config(
@@ -28183,7 +28183,7 @@ def _typecheckingstub__5b13f814bf47a5f3949ffc4b53034b4702a02836213167c9ba4c6a8d6
     pass
 
 def _typecheckingstub__8428dfc90e69bdd5363e69afd9c590a4ed2f1363b22242197295117dc5221878(
-    _scope: _constructs_77d1e7e8.Construct,
+    scope: _constructs_77d1e7e8.Construct,
     *,
     origin_id: builtins.str,
     distribution_id: typing.Optional[builtins.str] = None,