aws-cdk-lib 2.191.0__py3-none-any.whl → 2.193.0__py3-none-any.whl

aws_cdk/__init__.py

@@ -22143,29 +22143,26 @@ class StackProps:
 
         Example::
 
-            stack1 = Stack(app, "Stack1",
-                env=Environment(
-                    region="us-east-1"
-                ),
-                cross_region_references=True
-            )
-            cert = acm.Certificate(stack1, "Cert",
-                domain_name="*.example.com",
-                validation=acm.CertificateValidation.from_dns(route53.PublicHostedZone.from_hosted_zone_id(stack1, "Zone", "Z0329774B51CGXTDQV3X"))
-            )
+            import aws_cdk as cdk
+            import aws_cdk.aws_cloudwatch as cloudwatch
             
-            stack2 = Stack(app, "Stack2",
-                env=Environment(
-                    region="us-east-2"
-                ),
-                cross_region_references=True
+            
+            app = cdk.App()
+            stack = cdk.Stack(app, "Stack", env=cdk.Environment(region="us-west-2"))
+            
+            global_table = dynamodb.TableV2(stack, "GlobalTable",
+                partition_key=dynamodb.Attribute(name="pk", type=dynamodb.AttributeType.STRING),
+                replicas=[dynamodb.ReplicaTableProps(region="us-east-1"), dynamodb.ReplicaTableProps(region="us-east-2")
+                ]
             )
-            cloudfront.Distribution(stack2, "Distribution",
-                default_behavior=cloudfront.BehaviorOptions(
-                    origin=origins.HttpOrigin("example.com")
-                ),
-                domain_names=["dev.example.com"],
-                certificate=cert
+            
+            # metric is only for the table in us-west-2
+            metric = global_table.metric_consumed_read_capacity_units()
+            
+            cloudwatch.Alarm(self, "Alarm",
+                metric=metric,
+                evaluation_periods=1,
+                threshold=1
             )
         '''
         if isinstance(env, dict):

aws_cdk/_jsii/__init__.py

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

aws_cdk/aws_apigateway/__init__.py

@@ -35,6 +35,11 @@ running on AWS Lambda, or any web application.
   * [Mutual TLS (mTLS)](#mutual-tls-mtls)
   * [Deployments](#deployments)
 
+    * [Deploying to an existing stage](#deploying-to-an-existing-stage)
+
+      * [Using RestApi](#using-restapi)
+      * [Using SpecRestApi](#using-specrestapi)
+    * [Controlled triggering of deployments](#controlled-triggering-of-deployments)
     * [Deep dive: Invalidation of deployments](#deep-dive-invalidation-of-deployments)
   * [Custom Domains](#custom-domains)
 
@@ -1806,6 +1811,26 @@ for more details.
 properties that can be configured directly in the OpenAPI specification file. This is to prevent people duplication
 of these properties and potential confusion.
 
+However, you can control how API Gateway handles resource updates using the `mode` property. Valid values are:
+
+* `overwrite` - The new API definition replaces the existing one. The existing API identifier remains unchanged.
+* `merge` - The new API definition is merged with the existing API.
+
+If you don't specify this property, a default value is chosen:
+
+* For REST APIs created before March 29, 2021, the default is `overwrite`
+* For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
+
+Use the default mode to define top-level RestApi properties in addition to using OpenAPI.
+Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
+
+```python
+api = apigateway.SpecRestApi(self, "books-api",
+    api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json"),
+    mode=apigateway.RestApiMode.MERGE
+)
+```
+
 ### Endpoint configuration
 
 By default, `SpecRestApi` will create an edge optimized endpoint.
@@ -24641,7 +24666,7 @@ class RestApiBaseProps:
     ) -> typing.Optional[_RemovalPolicy_9f93c814]:
         '''The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
 
-        Requires ``cloudWatchRole`` to be enabled.
+        Requires ``cloudWatchRole`` to be enabled.
 
         :default: - RemovalPolicy.RETAIN
         '''
@@ -24811,6 +24836,26 @@ class RestApiBaseProps:
         )
 
 
+@jsii.enum(jsii_type="aws-cdk-lib.aws_apigateway.RestApiMode")
+class RestApiMode(enum.Enum):
+    '''The Mode that determines how API Gateway handles resource updates when importing an OpenAPI definition.
+
+    :exampleMetadata: infused
+
+    Example::
+
+        api = apigateway.SpecRestApi(self, "books-api",
+            api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json"),
+            mode=apigateway.RestApiMode.MERGE
+        )
+    '''
+
+    OVERWRITE = "OVERWRITE"
+    '''The new API definition replaces the existing one.'''
+    MERGE = "MERGE"
+    '''The new API definition is merged with the existing API.'''
+
+
 @jsii.data_type(
     jsii_type="aws-cdk-lib.aws_apigateway.RestApiProps",
     jsii_struct_bases=[ResourceOptions, RestApiBaseProps],
@@ -25035,7 +25080,7 @@ class RestApiProps(ResourceOptions, RestApiBaseProps):
     ) -> typing.Optional[_RemovalPolicy_9f93c814]:
         '''The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
 
-        Requires ``cloudWatchRole`` to be enabled.
+        Requires ``cloudWatchRole`` to be enabled.
 
         :default: - RemovalPolicy.RETAIN
         '''
@@ -25654,15 +25699,10 @@ class SpecRestApi(
 
     Example::
 
-        # integration: apigateway.Integration
-        
-        
         api = apigateway.SpecRestApi(self, "books-api",
-            api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json")
+            api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json"),
+            mode=apigateway.RestApiMode.MERGE
         )
-        
-        books_resource = api.root.add_resource("books")
-        books_resource.add_method("GET", integration)
     '''
 
     def __init__(
@@ -25672,6 +25712,7 @@ class SpecRestApi(
         *,
         api_definition: ApiDefinition,
         min_compression_size: typing.Optional[_Size_7b441c34] = None,
+        mode: typing.Optional[RestApiMode] = None,
         cloud_watch_role: typing.Optional[builtins.bool] = None,
         cloud_watch_role_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
         deploy: typing.Optional[builtins.bool] = None,
@@ -25693,6 +25734,7 @@ class SpecRestApi(
         :param id: -
         :param api_definition: An OpenAPI definition compatible with API Gateway.
         :param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. Default: - Compression is disabled.
+        :param mode: The Mode that determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen: - For REST APIs created before March 29, 2021, the default is ``overwrite`` - For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. Default: - ``merge`` for REST APIs created after March 29, 2021, otherwise ``overwrite``
         :param cloud_watch_role: Automatically configure an AWS CloudWatch role for API Gateway. Default: - false if ``@aws-cdk/aws-apigateway:disableCloudWatchRole`` is enabled, true otherwise
         :param cloud_watch_role_removal_policy: The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires ``cloudWatchRole`` to be enabled. Default: - RemovalPolicy.RETAIN
         :param deploy: Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created. If this is set, ``latestDeployment`` will refer to the ``Deployment`` object and ``deploymentStage`` will refer to a ``Stage`` that points to this deployment. To customize the stage options, use the ``deployOptions`` property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. Default: true
@@ -25716,6 +25758,7 @@ class SpecRestApi(
         props = SpecRestApiProps(
             api_definition=api_definition,
             min_compression_size=min_compression_size,
+            mode=mode,
             cloud_watch_role=cloud_watch_role,
             cloud_watch_role_removal_policy=cloud_watch_role_removal_policy,
             deploy=deploy,
@@ -25799,6 +25842,7 @@ class SpecRestApi(
         "retain_deployments": "retainDeployments",
         "api_definition": "apiDefinition",
         "min_compression_size": "minCompressionSize",
+        "mode": "mode",
     },
 )
 class SpecRestApiProps(RestApiBaseProps):
@@ -25822,6 +25866,7 @@ class SpecRestApiProps(RestApiBaseProps):
         retain_deployments: typing.Optional[builtins.bool] = None,
         api_definition: ApiDefinition,
         min_compression_size: typing.Optional[_Size_7b441c34] = None,
+        mode: typing.Optional[RestApiMode] = None,
     ) -> None:
         '''Props to instantiate a new SpecRestApi.
 
@@ -25842,20 +25887,16 @@ class SpecRestApiProps(RestApiBaseProps):
         :param retain_deployments: Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console. Default: false
         :param api_definition: An OpenAPI definition compatible with API Gateway.
         :param min_compression_size: A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. Default: - Compression is disabled.
+        :param mode: The Mode that determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen: - For REST APIs created before March 29, 2021, the default is ``overwrite`` - For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. Default: - ``merge`` for REST APIs created after March 29, 2021, otherwise ``overwrite``
 
         :exampleMetadata: infused
 
         Example::
 
-            # integration: apigateway.Integration
-            
-            
             api = apigateway.SpecRestApi(self, "books-api",
-                api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json")
+                api_definition=apigateway.ApiDefinition.from_asset("path-to-file.json"),
+                mode=apigateway.RestApiMode.MERGE
             )
-            
-            books_resource = api.root.add_resource("books")
-            books_resource.add_method("GET", integration)
         '''
         if isinstance(deploy_options, dict):
             deploy_options = StageOptions(**deploy_options)
@@ -25882,6 +25923,7 @@ class SpecRestApiProps(RestApiBaseProps):
             check_type(argname="argument retain_deployments", value=retain_deployments, expected_type=type_hints["retain_deployments"])
             check_type(argname="argument api_definition", value=api_definition, expected_type=type_hints["api_definition"])
             check_type(argname="argument min_compression_size", value=min_compression_size, expected_type=type_hints["min_compression_size"])
+            check_type(argname="argument mode", value=mode, expected_type=type_hints["mode"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "api_definition": api_definition,
         }
@@ -25917,6 +25959,8 @@ class SpecRestApiProps(RestApiBaseProps):
             self._values["retain_deployments"] = retain_deployments
         if min_compression_size is not None:
             self._values["min_compression_size"] = min_compression_size
+        if mode is not None:
+            self._values["mode"] = mode
 
     @builtins.property
     def cloud_watch_role(self) -> typing.Optional[builtins.bool]:
@@ -25933,7 +25977,7 @@ class SpecRestApiProps(RestApiBaseProps):
     ) -> typing.Optional[_RemovalPolicy_9f93c814]:
         '''The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
 
-        Requires ``cloudWatchRole`` to be enabled.
+        Requires ``cloudWatchRole`` to be enabled.
 
         :default: - RemovalPolicy.RETAIN
         '''
@@ -26115,6 +26159,30 @@ class SpecRestApiProps(RestApiBaseProps):
         result = self._values.get("min_compression_size")
         return typing.cast(typing.Optional[_Size_7b441c34], result)
 
+    @builtins.property
+    def mode(self) -> typing.Optional[RestApiMode]:
+        '''The Mode that determines how API Gateway handles resource updates.
+
+        Valid values are ``overwrite`` or ``merge``.
+
+        For ``overwrite``, the new API definition replaces the existing one.
+        The existing API identifier remains unchanged.
+
+        For ``merge``, the new API definition is merged with the existing API.
+
+        If you don't specify this property, a default value is chosen:
+
+        - For REST APIs created before March 29, 2021, the default is ``overwrite``
+        - For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
+
+        Use the default mode to define top-level RestApi properties in addition to using OpenAPI.
+        Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
+
+        :default: - ``merge`` for REST APIs created after March 29, 2021, otherwise ``overwrite``
+        '''
+        result = self._values.get("mode")
+        return typing.cast(typing.Optional[RestApiMode], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -28277,7 +28345,7 @@ class StepFunctionsRestApiProps(RestApiProps):
     ) -> typing.Optional[_RemovalPolicy_9f93c814]:
         '''The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
 
-        Requires ``cloudWatchRole`` to be enabled.
+        Requires ``cloudWatchRole`` to be enabled.
 
         :default: - RemovalPolicy.RETAIN
         '''
@@ -30993,7 +31061,7 @@ class LambdaRestApiProps(RestApiProps):
     ) -> typing.Optional[_RemovalPolicy_9f93c814]:
         '''The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.
 
-        Requires ``cloudWatchRole`` to be enabled.
+        Requires ``cloudWatchRole`` to be enabled.
 
         :default: - RemovalPolicy.RETAIN
         '''
@@ -33256,6 +33324,7 @@ __all__ = [
     "RestApiAttributes",
     "RestApiBase",
     "RestApiBaseProps",
+    "RestApiMode",
     "RestApiProps",
     "S3ApiDefinition",
     "SagemakerIntegration",
@@ -36422,6 +36491,7 @@ def _typecheckingstub__4722b635be09e87466169ef31b6610061f0fa16d1cff99382f0584fde
     *,
     api_definition: ApiDefinition,
     min_compression_size: typing.Optional[_Size_7b441c34] = None,
+    mode: typing.Optional[RestApiMode] = None,
     cloud_watch_role: typing.Optional[builtins.bool] = None,
     cloud_watch_role_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
     deploy: typing.Optional[builtins.bool] = None,
@@ -36466,6 +36536,7 @@ def _typecheckingstub__4506705cb637aa3098ad358d76fa29dd7a218f7542020d2e9dbfe8182
     retain_deployments: typing.Optional[builtins.bool] = None,
     api_definition: ApiDefinition,
     min_compression_size: typing.Optional[_Size_7b441c34] = None,
+    mode: typing.Optional[RestApiMode] = None,
 ) -> None:
     """Type checking stubs"""
     pass