aws-cdk-lib 2.173.3__py3-none-any.whl → 2.174.0__py3-none-any.whl

aws_cdk/_jsii/__init__.py

@@ -35,7 +35,7 @@ import aws_cdk.cloud_assembly_schema._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "aws-cdk-lib", "2.173.3", __name__[0:-6], "aws-cdk-lib@2.173.3.jsii.tgz"
+    "aws-cdk-lib", "2.174.0", __name__[0:-6], "aws-cdk-lib@2.174.0.jsii.tgz"
 )
 
 __all__ = [

aws_cdk/aws_apigateway/__init__.py

@@ -13,10 +13,10 @@ running on AWS Lambda, or any web application.
 
   * [Table of Contents](#table-of-contents)
   * [Defining APIs](#defining-apis)
-  * [AWS Lambda-backed APIs](#aws-lambda-backed-apis)
-  * [AWS StepFunctions backed APIs](#aws-stepfunctions-backed-apis)
 
     * [Breaking up Methods and Resources across Stacks](#breaking-up-methods-and-resources-across-stacks)
+  * [AWS Lambda-backed APIs](#aws-lambda-backed-apis)
+  * [AWS StepFunctions backed APIs](#aws-stepfunctions-backed-apis)
   * [Integration Targets](#integration-targets)
   * [Usage Plan & API Keys](#usage-plan--api-keys)
 
@@ -84,6 +84,131 @@ method = api.root.add_resource("books").add_method("GET")
 method.grant_execute(user)
 ```
 
+### Breaking up Methods and Resources across Stacks
+
+It is fairly common for REST APIs with a large number of Resources and Methods to hit the [CloudFormation
+limit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) of 500 resources per
+stack.
+
+To help with this, Resources and Methods for the same REST API can be re-organized across multiple stacks. A common
+way to do this is to have a stack per Resource or groups of Resources, but this is not the only possible way.
+The following example uses sets up two Resources '/pets' and '/books' in separate stacks using nested stacks:
+
+```python
+from aws_cdk.aws_apigateway import IntegrationResponse, MethodResponse, IntegrationResponse, MethodResponse
+from constructs import Construct
+from aws_cdk import App, CfnOutput, NestedStack, NestedStackProps, Stack
+from aws_cdk.aws_apigateway import Deployment, Method, MockIntegration, PassthroughBehavior, RestApi, Stage
+
+#
+# This file showcases how to split up a RestApi's Resources and Methods across nested stacks.
+#
+# The root stack 'RootStack' first defines a RestApi.
+# Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.
+# They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.
+#
+# To verify this worked, go to the APIGateway
+#
+
+class RootStack(Stack):
+    def __init__(self, scope):
+        super().__init__(scope, "integ-restapi-import-RootStack")
+
+        rest_api = RestApi(self, "RestApi",
+            cloud_watch_role=True,
+            deploy=False
+        )
+        rest_api.root.add_method("ANY")
+
+        pets_stack = PetsStack(self,
+            rest_api_id=rest_api.rest_api_id,
+            root_resource_id=rest_api.rest_api_root_resource_id
+        )
+        books_stack = BooksStack(self,
+            rest_api_id=rest_api.rest_api_id,
+            root_resource_id=rest_api.rest_api_root_resource_id
+        )
+        DeployStack(self,
+            rest_api_id=rest_api.rest_api_id,
+            methods=pets_stack.methods.concat(books_stack.methods)
+        )
+
+        CfnOutput(self, "PetsURL",
+            value=f"https://{restApi.restApiId}.execute-api.{this.region}.amazonaws.com/prod/pets"
+        )
+
+        CfnOutput(self, "BooksURL",
+            value=f"https://{restApi.restApiId}.execute-api.{this.region}.amazonaws.com/prod/books"
+        )
+
+class PetsStack(NestedStack):
+
+    def __init__(self, scope, *, restApiId, rootResourceId, parameters=None, timeout=None, notificationArns=None, removalPolicy=None, description=None):
+        super().__init__(scope, "integ-restapi-import-PetsStack", restApiId=restApiId, rootResourceId=rootResourceId, parameters=parameters, timeout=timeout, notificationArns=notificationArns, removalPolicy=removalPolicy, description=description)
+
+        api = RestApi.from_rest_api_attributes(self, "RestApi",
+            rest_api_id=rest_api_id,
+            root_resource_id=root_resource_id
+        )
+
+        method = api.root.add_resource("pets").add_method("GET", MockIntegration(
+            integration_responses=[IntegrationResponse(
+                status_code="200"
+            )],
+            passthrough_behavior=PassthroughBehavior.NEVER,
+            request_templates={
+                "application/json": "{ \"statusCode\": 200 }"
+            }
+        ),
+            method_responses=[MethodResponse(status_code="200")]
+        )
+
+        self.methods.push(method)
+
+class BooksStack(NestedStack):
+
+    def __init__(self, scope, *, restApiId, rootResourceId, parameters=None, timeout=None, notificationArns=None, removalPolicy=None, description=None):
+        super().__init__(scope, "integ-restapi-import-BooksStack", restApiId=restApiId, rootResourceId=rootResourceId, parameters=parameters, timeout=timeout, notificationArns=notificationArns, removalPolicy=removalPolicy, description=description)
+
+        api = RestApi.from_rest_api_attributes(self, "RestApi",
+            rest_api_id=rest_api_id,
+            root_resource_id=root_resource_id
+        )
+
+        method = api.root.add_resource("books").add_method("GET", MockIntegration(
+            integration_responses=[IntegrationResponse(
+                status_code="200"
+            )],
+            passthrough_behavior=PassthroughBehavior.NEVER,
+            request_templates={
+                "application/json": "{ \"statusCode\": 200 }"
+            }
+        ),
+            method_responses=[MethodResponse(status_code="200")]
+        )
+
+        self.methods.push(method)
+
+class DeployStack(NestedStack):
+    def __init__(self, scope, *, restApiId, methods=None, parameters=None, timeout=None, notificationArns=None, removalPolicy=None, description=None):
+        super().__init__(scope, "integ-restapi-import-DeployStack", restApiId=restApiId, methods=methods, parameters=parameters, timeout=timeout, notificationArns=notificationArns, removalPolicy=removalPolicy, description=description)
+
+        deployment = Deployment(self, "Deployment",
+            api=RestApi.from_rest_api_id(self, "RestApi", rest_api_id)
+        )
+        if methods:
+            for method in methods:
+                deployment.node.add_dependency(method)
+        Stage(self, "Stage", deployment=deployment)
+
+RootStack(App())
+```
+
+> **Warning:** In the code above, an API Gateway deployment is created during the initial CDK deployment.
+> However, if there are changes to the resources in subsequent CDK deployments, a new API Gateway deployment is not
+> automatically created. As a result, the latest state of the resources is not reflected. To ensure the latest state
+> of the resources is reflected, a manual deployment of the API Gateway is required after the CDK deployment. See [Controlled triggering of deployments](#controlled-triggering-of-deployments) for more info.
+
 ## AWS Lambda-backed APIs
 
 A very common practice is to use Amazon API Gateway with AWS Lambda as the
@@ -267,131 +392,6 @@ AWS Step Functions will receive the following execution input:
 }
 ```
 
-### Breaking up Methods and Resources across Stacks
-
-It is fairly common for REST APIs with a large number of Resources and Methods to hit the [CloudFormation
-limit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) of 500 resources per
-stack.
-
-To help with this, Resources and Methods for the same REST API can be re-organized across multiple stacks. A common
-way to do this is to have a stack per Resource or groups of Resources, but this is not the only possible way.
-The following example uses sets up two Resources '/pets' and '/books' in separate stacks using nested stacks:
-
-```python
-from aws_cdk.aws_apigateway import IntegrationResponse, MethodResponse, IntegrationResponse, MethodResponse
-from constructs import Construct
-from aws_cdk import App, CfnOutput, NestedStack, NestedStackProps, Stack
-from aws_cdk.aws_apigateway import Deployment, Method, MockIntegration, PassthroughBehavior, RestApi, Stage
-
-#
-# This file showcases how to split up a RestApi's Resources and Methods across nested stacks.
-#
-# The root stack 'RootStack' first defines a RestApi.
-# Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.
-# They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.
-#
-# To verify this worked, go to the APIGateway
-#
-
-class RootStack(Stack):
-    def __init__(self, scope):
-        super().__init__(scope, "integ-restapi-import-RootStack")
-
-        rest_api = RestApi(self, "RestApi",
-            cloud_watch_role=True,
-            deploy=False
-        )
-        rest_api.root.add_method("ANY")
-
-        pets_stack = PetsStack(self,
-            rest_api_id=rest_api.rest_api_id,
-            root_resource_id=rest_api.rest_api_root_resource_id
-        )
-        books_stack = BooksStack(self,
-            rest_api_id=rest_api.rest_api_id,
-            root_resource_id=rest_api.rest_api_root_resource_id
-        )
-        DeployStack(self,
-            rest_api_id=rest_api.rest_api_id,
-            methods=pets_stack.methods.concat(books_stack.methods)
-        )
-
-        CfnOutput(self, "PetsURL",
-            value=f"https://{restApi.restApiId}.execute-api.{this.region}.amazonaws.com/prod/pets"
-        )
-
-        CfnOutput(self, "BooksURL",
-            value=f"https://{restApi.restApiId}.execute-api.{this.region}.amazonaws.com/prod/books"
-        )
-
-class PetsStack(NestedStack):
-
-    def __init__(self, scope, *, restApiId, rootResourceId, parameters=None, timeout=None, notificationArns=None, removalPolicy=None, description=None):
-        super().__init__(scope, "integ-restapi-import-PetsStack", restApiId=restApiId, rootResourceId=rootResourceId, parameters=parameters, timeout=timeout, notificationArns=notificationArns, removalPolicy=removalPolicy, description=description)
-
-        api = RestApi.from_rest_api_attributes(self, "RestApi",
-            rest_api_id=rest_api_id,
-            root_resource_id=root_resource_id
-        )
-
-        method = api.root.add_resource("pets").add_method("GET", MockIntegration(
-            integration_responses=[IntegrationResponse(
-                status_code="200"
-            )],
-            passthrough_behavior=PassthroughBehavior.NEVER,
-            request_templates={
-                "application/json": "{ \"statusCode\": 200 }"
-            }
-        ),
-            method_responses=[MethodResponse(status_code="200")]
-        )
-
-        self.methods.push(method)
-
-class BooksStack(NestedStack):
-
-    def __init__(self, scope, *, restApiId, rootResourceId, parameters=None, timeout=None, notificationArns=None, removalPolicy=None, description=None):
-        super().__init__(scope, "integ-restapi-import-BooksStack", restApiId=restApiId, rootResourceId=rootResourceId, parameters=parameters, timeout=timeout, notificationArns=notificationArns, removalPolicy=removalPolicy, description=description)
-
-        api = RestApi.from_rest_api_attributes(self, "RestApi",
-            rest_api_id=rest_api_id,
-            root_resource_id=root_resource_id
-        )
-
-        method = api.root.add_resource("books").add_method("GET", MockIntegration(
-            integration_responses=[IntegrationResponse(
-                status_code="200"
-            )],
-            passthrough_behavior=PassthroughBehavior.NEVER,
-            request_templates={
-                "application/json": "{ \"statusCode\": 200 }"
-            }
-        ),
-            method_responses=[MethodResponse(status_code="200")]
-        )
-
-        self.methods.push(method)
-
-class DeployStack(NestedStack):
-    def __init__(self, scope, *, restApiId, methods=None, parameters=None, timeout=None, notificationArns=None, removalPolicy=None, description=None):
-        super().__init__(scope, "integ-restapi-import-DeployStack", restApiId=restApiId, methods=methods, parameters=parameters, timeout=timeout, notificationArns=notificationArns, removalPolicy=removalPolicy, description=description)
-
-        deployment = Deployment(self, "Deployment",
-            api=RestApi.from_rest_api_id(self, "RestApi", rest_api_id)
-        )
-        if methods:
-            for method in methods:
-                deployment.node.add_dependency(method)
-        Stage(self, "Stage", deployment=deployment)
-
-RootStack(App())
-```
-
-> **Warning:** In the code above, an API Gateway deployment is created during the initial CDK deployment.
-> However, if there are changes to the resources in subsequent CDK deployments, a new API Gateway deployment is not
-> automatically created. As a result, the latest state of the resources is not reflected. To ensure the latest state
-> of the resources is reflected, a manual deployment of the API Gateway is required after the CDK deployment. See [Controlled triggering of deployments](#controlled-triggering-of-deployments) for more info.
-
 ## Integration Targets
 
 Methods are associated with backend integrations, which are invoked when this
@@ -8588,7 +8588,6 @@ class CfnDomainNameV2(
         # The values are placeholders you should change.
         from aws_cdk import aws_apigateway as apigateway
         
-        # management_policy: Any
         # policy: Any
         
         cfn_domain_name_v2 = apigateway.CfnDomainNameV2(self, "MyCfnDomainNameV2",
@@ -8597,7 +8596,6 @@ class CfnDomainNameV2(
             endpoint_configuration=apigateway.CfnDomainNameV2.EndpointConfigurationProperty(
                 types=["types"]
             ),
-            management_policy=management_policy,
             policy=policy,
             security_policy="securityPolicy",
             tags=[CfnTag(
@@ -8615,7 +8613,6 @@ class CfnDomainNameV2(
         certificate_arn: typing.Optional[builtins.str] = None,
         domain_name: typing.Optional[builtins.str] = None,
         endpoint_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDomainNameV2.EndpointConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
-        management_policy: typing.Any = None,
         policy: typing.Any = None,
         security_policy: typing.Optional[builtins.str] = None,
         tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -8626,7 +8623,6 @@ class CfnDomainNameV2(
         :param certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
         :param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
         :param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
-        :param management_policy: 
         :param policy: A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration. You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
         :param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
         :param tags: The collection of tags. Each tag element is associated with a given resource.
@@ -8639,7 +8635,6 @@ class CfnDomainNameV2(
             certificate_arn=certificate_arn,
             domain_name=domain_name,
             endpoint_configuration=endpoint_configuration,
-            management_policy=management_policy,
             policy=policy,
             security_policy=security_policy,
             tags=tags,
@@ -8750,18 +8745,6 @@ class CfnDomainNameV2(
             check_type(argname="argument value", value=value, expected_type=type_hints["value"])
         jsii.set(self, "endpointConfiguration", value) # pyright: ignore[reportArgumentType]
 
-    @builtins.property
-    @jsii.member(jsii_name="managementPolicy")
-    def management_policy(self) -> typing.Any:
-        return typing.cast(typing.Any, jsii.get(self, "managementPolicy"))
-
-    @management_policy.setter
-    def management_policy(self, value: typing.Any) -> None:
-        if __debug__:
-            type_hints = typing.get_type_hints(_typecheckingstub__8b6d7f1f638d8720556c9e4d7598ad47d45db07dc328a664195267638644608c)
-            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
-        jsii.set(self, "managementPolicy", value) # pyright: ignore[reportArgumentType]
-
     @builtins.property
     @jsii.member(jsii_name="policy")
     def policy(self) -> typing.Any:
@@ -8866,7 +8849,6 @@ class CfnDomainNameV2(
         "certificate_arn": "certificateArn",
         "domain_name": "domainName",
         "endpoint_configuration": "endpointConfiguration",
-        "management_policy": "managementPolicy",
         "policy": "policy",
         "security_policy": "securityPolicy",
         "tags": "tags",
@@ -8879,7 +8861,6 @@ class CfnDomainNameV2Props:
         certificate_arn: typing.Optional[builtins.str] = None,
         domain_name: typing.Optional[builtins.str] = None,
         endpoint_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDomainNameV2.EndpointConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
-        management_policy: typing.Any = None,
         policy: typing.Any = None,
         security_policy: typing.Optional[builtins.str] = None,
         tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -8889,7 +8870,6 @@ class CfnDomainNameV2Props:
         :param certificate_arn: The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. AWS Certificate Manager is the only supported source.
         :param domain_name: Represents a custom domain name as a user-friendly host name of an API (RestApi).
         :param endpoint_configuration: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
-        :param management_policy: 
         :param policy: A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration. You can use ``Fn::ToJsonString`` to enter your ``policy`` . For more information, see `Fn::ToJsonString <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ToJsonString.html>`_ .
         :param security_policy: The Transport Layer Security (TLS) version + cipher suite for this DomainName. Only ``TLS_1_2`` is supported.
         :param tags: The collection of tags. Each tag element is associated with a given resource.
@@ -8903,7 +8883,6 @@ class CfnDomainNameV2Props:
             # The values are placeholders you should change.
             from aws_cdk import aws_apigateway as apigateway
             
-            # management_policy: Any
             # policy: Any
             
             cfn_domain_name_v2_props = apigateway.CfnDomainNameV2Props(
@@ -8912,7 +8891,6 @@ class CfnDomainNameV2Props:
                 endpoint_configuration=apigateway.CfnDomainNameV2.EndpointConfigurationProperty(
                     types=["types"]
                 ),
-                management_policy=management_policy,
                 policy=policy,
                 security_policy="securityPolicy",
                 tags=[CfnTag(
@@ -8926,7 +8904,6 @@ class CfnDomainNameV2Props:
             check_type(argname="argument certificate_arn", value=certificate_arn, expected_type=type_hints["certificate_arn"])
             check_type(argname="argument domain_name", value=domain_name, expected_type=type_hints["domain_name"])
             check_type(argname="argument endpoint_configuration", value=endpoint_configuration, expected_type=type_hints["endpoint_configuration"])
-            check_type(argname="argument management_policy", value=management_policy, expected_type=type_hints["management_policy"])
             check_type(argname="argument policy", value=policy, expected_type=type_hints["policy"])
             check_type(argname="argument security_policy", value=security_policy, expected_type=type_hints["security_policy"])
             check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
@@ -8937,8 +8914,6 @@ class CfnDomainNameV2Props:
             self._values["domain_name"] = domain_name
         if endpoint_configuration is not None:
             self._values["endpoint_configuration"] = endpoint_configuration
-        if management_policy is not None:
-            self._values["management_policy"] = management_policy
         if policy is not None:
             self._values["policy"] = policy
         if security_policy is not None:
@@ -8977,14 +8952,6 @@ class CfnDomainNameV2Props:
         result = self._values.get("endpoint_configuration")
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDomainNameV2.EndpointConfigurationProperty]], result)
 
-    @builtins.property
-    def management_policy(self) -> typing.Any:
-        '''
-        :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnamev2.html#cfn-apigateway-domainnamev2-managementpolicy
-        '''
-        result = self._values.get("management_policy")
-        return typing.cast(typing.Any, result)
-
     @builtins.property
     def policy(self) -> typing.Any:
         '''A stringified JSON policy document that applies to the ``execute-api`` service for this DomainName regardless of the caller and Method configuration.
@@ -33963,7 +33930,6 @@ def _typecheckingstub__a4f501d10d57d39a48913872efdcb7d389a076fed9b5aabb21034b8e6
     certificate_arn: typing.Optional[builtins.str] = None,
     domain_name: typing.Optional[builtins.str] = None,
     endpoint_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDomainNameV2.EndpointConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
-    management_policy: typing.Any = None,
     policy: typing.Any = None,
     security_policy: typing.Optional[builtins.str] = None,
     tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -34001,12 +33967,6 @@ def _typecheckingstub__a1f648b520c9d40bb72a9028880e48540125da8ba68522e25c483400d
     """Type checking stubs"""
     pass
 
-def _typecheckingstub__8b6d7f1f638d8720556c9e4d7598ad47d45db07dc328a664195267638644608c(
-    value: typing.Any,
-) -> None:
-    """Type checking stubs"""
-    pass
-
 def _typecheckingstub__a0c6989179a94e32b700994895064456ee57af9eb39330638ade9b7801085b38(
     value: typing.Any,
 ) -> None:
@@ -34037,7 +33997,6 @@ def _typecheckingstub__dfb97b3f8aa373f21ebe15318ceaaf08a4d4b4b31e9ba1ed8fb04ef59
     certificate_arn: typing.Optional[builtins.str] = None,
     domain_name: typing.Optional[builtins.str] = None,
     endpoint_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDomainNameV2.EndpointConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
-    management_policy: typing.Any = None,
     policy: typing.Any = None,
     security_policy: typing.Optional[builtins.str] = None,
     tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,