aws-cdk-lib 2.175.1__py3-none-any.whl → 2.177.0__py3-none-any.whl

aws_cdk/aws_synthetics/__init__.py

@@ -159,8 +159,7 @@ To learn more about these underlying resources, see
 [Synthetics Canaries Deletion](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html).
 
 In the CDK, you can configure your canary to delete the underlying lambda function when the canary is deleted.
-This can be provisioned by setting `cleanup: Cleanup.LAMBDA`. Note that this
-will create a custom resource under the hood that takes care of the lambda deletion for you.
+This can be provisioned by setting `provisionedResourceCleanup` to `true`.
 
 ```python
 canary = synthetics.Canary(self, "Canary",
@@ -168,7 +167,7 @@ canary = synthetics.Canary(self, "Canary",
         handler="index.handler",
         code=synthetics.Code.from_inline("/* Synthetics handler code")
     ),
-    cleanup=synthetics.Cleanup.LAMBDA,
+    provisioned_resource_cleanup=True,
     runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2
 )
 ```
@@ -176,6 +175,8 @@ canary = synthetics.Canary(self, "Canary",
 > Note: To properly clean up your canary on deletion, you still have to manually delete other resources
 > like S3 buckets and CloudWatch logs.
 
+> Note: The deletion of Lambda resources can also be performed by setting the `cleanup` argument to `Cleanup.LAMBDA`. However, this is an outdated argument that uses custom resources and is currently deprecated.
+
 ### Configuring the Canary Script
 
 To configure the script the canary executes, use the `test` property. The `test` property accepts a `Test` instance that can be initialized by the `Test` class static methods. Currently, the only implemented method is `Test.custom()`, which allows you to bring your own code. In the future, other methods will be added. `Test.custom()` accepts `code` and `handler` properties -- both are required by Synthetics to create a lambda function on your behalf.
@@ -183,8 +184,8 @@ To configure the script the canary executes, use the `test` property. The `test`
 The `synthetics.Code` class exposes static methods to bundle your code artifacts:
 
 * `code.fromInline(code)` - specify an inline script.
-* `code.fromAsset(path)` - specify a .zip file or a directory in the local filesystem which will be zipped and uploaded to S3 on deployment. See the above Note for directory structure.
-* `code.fromBucket(bucket, key[, objectVersion])` - specify an S3 object that contains the .zip file of your runtime code. See the above Note for directory structure.
+* `code.fromAsset(path)` - specify a .zip file or a directory in the local filesystem which will be zipped and uploaded to S3 on deployment. See the below Note for directory structure.
+* `code.fromBucket(bucket, key[, objectVersion])` - specify an S3 object that contains the .zip file of your runtime code. See the below Note for directory structure.
 
 Using the `Code` class static initializers:
 
@@ -218,7 +219,8 @@ synthetics.Canary(self, "Bucket Canary",
 )
 ```
 
-> **Note:** Synthetics have a specified folder structure for canaries. For Node scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:
+> **Note:** Synthetics have a specified folder structure for canaries.
+> For Node with puppeteer scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:
 >
 > ```plaintext
 > canary/
@@ -227,6 +229,19 @@ synthetics.Canary(self, "Bucket Canary",
 >         ├── <filename>.js
 > ```
 >
+> For Node with playwright scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:
+>
+> ```plaintext
+> canary/
+> ├── <filename>.js,.mjs,.cjs
+> ├─some/dir/path
+>              ├── <filename>.js,.mjs,.cjs
+> ```
+>
+> If `<filename>.js` is placed in the canary directory, the handler should be specified as `filename.handler`.
+> However, if it is placed in the `some/dir/path` directory, the handler should be specified as `some/dir/path/filename.handler`.
+> For more information, see Synthetics [docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Synthetics_WritingCanary_Nodejs_Playwright.html).
+>
 > For Python scripts supplied via `code.fromAsset()` or `code.fromBucket()`, the canary resource requires the following folder structure:
 >
 > ```plaintext
@@ -561,6 +576,7 @@ class Canary(
         environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
         memory: typing.Optional[_Size_7b441c34] = None,
+        provisioned_resource_cleanup: typing.Optional[builtins.bool] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
         schedule: typing.Optional["Schedule"] = None,
         security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
@@ -582,10 +598,11 @@ class Canary(
         :param artifacts_bucket_lifecycle_rules: Lifecycle rules for the generated canary artifact bucket. Has no effect if a bucket is passed to ``artifactsBucketLocation``. If you pass a bucket to ``artifactsBucketLocation``, you can add lifecycle rules to the bucket itself. Default: - no rules applied to the generated bucket.
         :param artifacts_bucket_location: The s3 location that stores the data of the canary runs. Default: - A new s3 bucket will be created without a prefix.
         :param canary_name: The name of the canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet. Default: - A unique name will be generated from the construct ID
-        :param cleanup: Specify the underlying resources to be cleaned up when the canary is deleted. Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this. Default: Cleanup.NOTHING
+        :param cleanup: (deprecated) Specify the underlying resources to be cleaned up when the canary is deleted. Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this. Default: Cleanup.NOTHING
         :param environment_variables: Key-value pairs that the Synthetics caches and makes available for your canary scripts. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code. Default: - No environment variables.
         :param failure_retention_period: How many days should failed runs be retained. Default: Duration.days(31)
         :param memory: The maximum amount of memory that the canary can use while running. This value must be a multiple of 64 Mib. The range is 960 MiB to 3008 MiB. Default: Size.mebibytes(1024)
+        :param provisioned_resource_cleanup: Whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. Default: undefined - the default behavior is to not delete the Lambda functions and layers
         :param role: Canary execution role. This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal. If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions. Default: - A unique role will be generated for this canary. You can add permissions to roles by calling 'addToRolePolicy'.
         :param schedule: Specify the schedule for how often the canary runs. For example, if you set ``schedule`` to ``rate(10 minutes)``, then the canary will run every 10 minutes. You can set the schedule with ``Schedule.rate(Duration)`` (recommended) or you can specify an expression using ``Schedule.expression()``. Default: 'rate(5 minutes)'
         :param security_groups: The list of security groups to associate with the canary's network interfaces. You must provide ``vpc`` when using this prop. Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
@@ -613,6 +630,7 @@ class Canary(
             environment_variables=environment_variables,
             failure_retention_period=failure_retention_period,
             memory=memory,
+            provisioned_resource_cleanup=provisioned_resource_cleanup,
             role=role,
             schedule=schedule,
             security_groups=security_groups,
@@ -828,6 +846,7 @@ class Canary(
         "environment_variables": "environmentVariables",
         "failure_retention_period": "failureRetentionPeriod",
         "memory": "memory",
+        "provisioned_resource_cleanup": "provisionedResourceCleanup",
         "role": "role",
         "schedule": "schedule",
         "security_groups": "securityGroups",
@@ -855,6 +874,7 @@ class CanaryProps:
         environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
         failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
         memory: typing.Optional[_Size_7b441c34] = None,
+        provisioned_resource_cleanup: typing.Optional[builtins.bool] = None,
         role: typing.Optional[_IRole_235f5d8e] = None,
         schedule: typing.Optional["Schedule"] = None,
         security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
@@ -875,10 +895,11 @@ class CanaryProps:
         :param artifacts_bucket_lifecycle_rules: Lifecycle rules for the generated canary artifact bucket. Has no effect if a bucket is passed to ``artifactsBucketLocation``. If you pass a bucket to ``artifactsBucketLocation``, you can add lifecycle rules to the bucket itself. Default: - no rules applied to the generated bucket.
         :param artifacts_bucket_location: The s3 location that stores the data of the canary runs. Default: - A new s3 bucket will be created without a prefix.
         :param canary_name: The name of the canary. Be sure to give it a descriptive name that distinguishes it from other canaries in your account. Do not include secrets or proprietary information in your canary name. The canary name makes up part of the canary ARN, which is included in outbound calls over the internet. Default: - A unique name will be generated from the construct ID
-        :param cleanup: Specify the underlying resources to be cleaned up when the canary is deleted. Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this. Default: Cleanup.NOTHING
+        :param cleanup: (deprecated) Specify the underlying resources to be cleaned up when the canary is deleted. Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this. Default: Cleanup.NOTHING
         :param environment_variables: Key-value pairs that the Synthetics caches and makes available for your canary scripts. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Canary script source code. Default: - No environment variables.
         :param failure_retention_period: How many days should failed runs be retained. Default: Duration.days(31)
         :param memory: The maximum amount of memory that the canary can use while running. This value must be a multiple of 64 Mib. The range is 960 MiB to 3008 MiB. Default: Size.mebibytes(1024)
+        :param provisioned_resource_cleanup: Whether to also delete the Lambda functions and layers used by this canary when the canary is deleted. Default: undefined - the default behavior is to not delete the Lambda functions and layers
         :param role: Canary execution role. This is the role that will be assumed by the canary upon execution. It controls the permissions that the canary will have. The role must be assumable by the AWS Lambda service principal. If not supplied, a role will be created with all the required permissions. If you provide a Role, you must add the required permissions. Default: - A unique role will be generated for this canary. You can add permissions to roles by calling 'addToRolePolicy'.
         :param schedule: Specify the schedule for how often the canary runs. For example, if you set ``schedule`` to ``rate(10 minutes)``, then the canary will run every 10 minutes. You can set the schedule with ``Schedule.rate(Duration)`` (recommended) or you can specify an expression using ``Schedule.expression()``. Default: 'rate(5 minutes)'
         :param security_groups: The list of security groups to associate with the canary's network interfaces. You must provide ``vpc`` when using this prop. Default: - If the canary is placed within a VPC and a security group is not specified a dedicated security group will be created for this canary.
@@ -924,6 +945,7 @@ class CanaryProps:
             check_type(argname="argument environment_variables", value=environment_variables, expected_type=type_hints["environment_variables"])
             check_type(argname="argument failure_retention_period", value=failure_retention_period, expected_type=type_hints["failure_retention_period"])
             check_type(argname="argument memory", value=memory, expected_type=type_hints["memory"])
+            check_type(argname="argument provisioned_resource_cleanup", value=provisioned_resource_cleanup, expected_type=type_hints["provisioned_resource_cleanup"])
             check_type(argname="argument role", value=role, expected_type=type_hints["role"])
             check_type(argname="argument schedule", value=schedule, expected_type=type_hints["schedule"])
             check_type(argname="argument security_groups", value=security_groups, expected_type=type_hints["security_groups"])
@@ -957,6 +979,8 @@ class CanaryProps:
             self._values["failure_retention_period"] = failure_retention_period
         if memory is not None:
             self._values["memory"] = memory
+        if provisioned_resource_cleanup is not None:
+            self._values["provisioned_resource_cleanup"] = provisioned_resource_cleanup
         if role is not None:
             self._values["role"] = role
         if schedule is not None:
@@ -1079,11 +1103,15 @@ class CanaryProps:
 
     @builtins.property
     def cleanup(self) -> typing.Optional["Cleanup"]:
-        '''Specify the underlying resources to be cleaned up when the canary is deleted.
+        '''(deprecated) Specify the underlying resources to be cleaned up when the canary is deleted.
 
         Using ``Cleanup.LAMBDA`` will create a Custom Resource to achieve this.
 
         :default: Cleanup.NOTHING
+
+        :deprecated: use provisionedResourceCleanup
+
+        :stability: deprecated
         '''
         result = self._values.get("cleanup")
         return typing.cast(typing.Optional["Cleanup"], result)
@@ -1124,6 +1152,15 @@ class CanaryProps:
         result = self._values.get("memory")
         return typing.cast(typing.Optional[_Size_7b441c34], result)
 
+    @builtins.property
+    def provisioned_resource_cleanup(self) -> typing.Optional[builtins.bool]:
+        '''Whether to also delete the Lambda functions and layers used by this canary when the canary is deleted.
+
+        :default: undefined - the default behavior is to not delete the Lambda functions and layers
+        '''
+        result = self._values.get("provisioned_resource_cleanup")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     @builtins.property
     def role(self) -> typing.Optional[_IRole_235f5d8e]:
         '''Canary execution role.
@@ -3208,21 +3245,7 @@ class CfnGroupProps:
 
 @jsii.enum(jsii_type="aws-cdk-lib.aws_synthetics.Cleanup")
 class Cleanup(enum.Enum):
-    '''Different ways to clean up underlying Canary resources when the Canary is deleted.
-
-    :exampleMetadata: infused
-
-    Example::
-
-        canary = synthetics.Canary(self, "Canary",
-            test=synthetics.Test.custom(
-                handler="index.handler",
-                code=synthetics.Code.from_inline("/* Synthetics handler code")
-            ),
-            cleanup=synthetics.Cleanup.LAMBDA,
-            runtime=synthetics.Runtime.SYNTHETICS_NODEJS_PUPPETEER_6_2
-        )
-    '''
+    '''Different ways to clean up underlying Canary resources when the Canary is deleted.'''
 
     NOTHING = "NOTHING"
     '''Clean up nothing.
@@ -3367,12 +3390,14 @@ class Code(
         scope: _constructs_77d1e7e8.Construct,
         handler: builtins.str,
         family: "RuntimeFamily",
+        runtime_name: typing.Optional[builtins.str] = None,
     ) -> "CodeConfig":
         '''Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
 
         :param scope: The binding scope. Don't be smart about trying to down-cast or assume it's initialized. You may just use it as a construct scope.
         :param handler: -
         :param family: -
+        :param runtime_name: -
 
         :return: a bound ``CodeConfig``.
         '''
@@ -3386,12 +3411,14 @@ class _CodeProxy(Code):
         scope: _constructs_77d1e7e8.Construct,
         handler: builtins.str,
         family: "RuntimeFamily",
+        runtime_name: typing.Optional[builtins.str] = None,
     ) -> "CodeConfig":
         '''Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
 
         :param scope: The binding scope. Don't be smart about trying to down-cast or assume it's initialized. You may just use it as a construct scope.
         :param handler: -
         :param family: -
+        :param runtime_name: -
 
         :return: a bound ``CodeConfig``.
         '''
@@ -3400,7 +3427,8 @@ class _CodeProxy(Code):
             check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
             check_type(argname="argument handler", value=handler, expected_type=type_hints["handler"])
             check_type(argname="argument family", value=family, expected_type=type_hints["family"])
-        return typing.cast("CodeConfig", jsii.invoke(self, "bind", [scope, handler, family]))
+            check_type(argname="argument runtime_name", value=runtime_name, expected_type=type_hints["runtime_name"])
+        return typing.cast("CodeConfig", jsii.invoke(self, "bind", [scope, handler, family, runtime_name]))
 
 # Adding a "__jsii_proxy_class__(): typing.Type" function to the abstract class
 typing.cast(typing.Any, Code).__jsii_proxy_class__ = lambda : _CodeProxy
@@ -3698,22 +3726,25 @@ class InlineCode(
     @jsii.member(jsii_name="bind")
     def bind(
         self,
-        _scope: _constructs_77d1e7e8.Construct,
+        scope: _constructs_77d1e7e8.Construct,
         handler: builtins.str,
         _family: "RuntimeFamily",
+        _runtime_name: typing.Optional[builtins.str] = None,
     ) -> CodeConfig:
         '''Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
 
-        :param _scope: -
+        :param scope: -
         :param handler: -
         :param _family: -
+        :param _runtime_name: -
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__9c1dddac73b46d6693b6032065ae6db988e1e76cb520ebf3d4aa58e532f543a9)
-            check_type(argname="argument _scope", value=_scope, expected_type=type_hints["_scope"])
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
             check_type(argname="argument handler", value=handler, expected_type=type_hints["handler"])
             check_type(argname="argument _family", value=_family, expected_type=type_hints["_family"])
-        return typing.cast(CodeConfig, jsii.invoke(self, "bind", [_scope, handler, _family]))
+            check_type(argname="argument _runtime_name", value=_runtime_name, expected_type=type_hints["_runtime_name"])
+        return typing.cast(CodeConfig, jsii.invoke(self, "bind", [scope, handler, _family, _runtime_name]))
 
 
 class Runtime(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Runtime"):
@@ -3748,6 +3779,23 @@ class Runtime(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Run
             check_type(argname="argument family", value=family, expected_type=type_hints["family"])
         jsii.create(self.__class__, self, [name, family])
 
+    @jsii.python.classproperty
+    @jsii.member(jsii_name="SYNTHETICS_NODEJS_PLAYWRIGHT_1_0")
+    def SYNTHETICS_NODEJS_PLAYWRIGHT_1_0(cls) -> "Runtime":
+        '''``syn-nodejs-playwright-1.0`` includes the following: - Lambda runtime Node.js 20.x - Playwright version 1.45 - Chromium version 126.0.6478.126.
+
+        New Features:
+
+        - **PlayWright support** You can write canary scripts by using the Playwright automation framework. You can bring your existing Playwright scripts to run as canaries, and enhance them with AWS monitoring capabilities.
+        - **CloudWatch Logs integration** You can query and filter for logs through the CloudWatch Synthetics console. Each log message contains unique canaryRunId, making it easy to search for logs for a particular canary run.
+        - **Metrics and canary artifacts** You can monitor canary run pass rate through CloudWatch metrics, and configure alarms to alert you when canaries detect issues.
+        - **Screenshots and steps association** You can capture screenshots using native Playwright functionality to visualize the stages of a canary script on each run. Screenshots are automatically associated with canary steps, and are uploaded to Amazon S3 buckets.
+        - **Multiple tabs** You can create canaries that open multiple browser tabs, and access screenshots from each tab. You can create multi-tab and multi-step user workflows in Synthetics.
+
+        :see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_nodejs_playwright.html#Synthetics_runtimeversion-syn-nodejs-playwright-1.0
+        '''
+        return typing.cast("Runtime", jsii.sget(cls, "SYNTHETICS_NODEJS_PLAYWRIGHT_1_0"))
+
     @jsii.python.classproperty
     @jsii.member(jsii_name="SYNTHETICS_NODEJS_PUPPETEER_3_5")
     def SYNTHETICS_NODEJS_PUPPETEER_3_5(cls) -> "Runtime":
@@ -4119,6 +4167,19 @@ class Runtime(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_synthetics.Run
         '''
         return typing.cast("Runtime", jsii.sget(cls, "SYNTHETICS_PYTHON_SELENIUM_4_0"))
 
+    @jsii.python.classproperty
+    @jsii.member(jsii_name="SYNTHETICS_PYTHON_SELENIUM_4_1")
+    def SYNTHETICS_PYTHON_SELENIUM_4_1(cls) -> "Runtime":
+        '''``syn-python-selenium-4.1`` includes the following: - Lambda runtime Python 3.9 - Selenium version 4.15.1 - Chromium version 126.0.6478.126.
+
+        New Features:
+
+        - **Addresses security vulnerability** This runtime has an update to address the CVE-2024-39689 vulnerability.
+
+        :see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_python_selenium.html#CloudWatch_Synthetics_runtimeversion-syn-python-selenium-4.1
+        '''
+        return typing.cast("Runtime", jsii.sget(cls, "SYNTHETICS_PYTHON_SELENIUM_4_1"))
+
     @builtins.property
     @jsii.member(jsii_name="family")
     def family(self) -> "RuntimeFamily":
@@ -4189,19 +4250,22 @@ class S3Code(
         _scope: _constructs_77d1e7e8.Construct,
         _handler: builtins.str,
         _family: RuntimeFamily,
+        _runtime_name: typing.Optional[builtins.str] = None,
     ) -> CodeConfig:
         '''Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
 
         :param _scope: -
         :param _handler: -
         :param _family: -
+        :param _runtime_name: -
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__2e764381c92bbdf3e70a0cf34a6f1afa9abfa207f9eb030a4ac6823b6e04ab07)
             check_type(argname="argument _scope", value=_scope, expected_type=type_hints["_scope"])
             check_type(argname="argument _handler", value=_handler, expected_type=type_hints["_handler"])
             check_type(argname="argument _family", value=_family, expected_type=type_hints["_family"])
-        return typing.cast(CodeConfig, jsii.invoke(self, "bind", [_scope, _handler, _family]))
+            check_type(argname="argument _runtime_name", value=_runtime_name, expected_type=type_hints["_runtime_name"])
+        return typing.cast(CodeConfig, jsii.invoke(self, "bind", [_scope, _handler, _family, _runtime_name]))
 
 
 class Schedule(
@@ -4451,19 +4515,22 @@ class AssetCode(
         scope: _constructs_77d1e7e8.Construct,
         handler: builtins.str,
         family: RuntimeFamily,
+        runtime_name: typing.Optional[builtins.str] = None,
     ) -> CodeConfig:
         '''Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
 
         :param scope: -
         :param handler: -
         :param family: -
+        :param runtime_name: -
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__dcf81e22fccedf5b193b8ec9218200abb14bc77d3601c5cd7edbedda5914c393)
             check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
             check_type(argname="argument handler", value=handler, expected_type=type_hints["handler"])
             check_type(argname="argument family", value=family, expected_type=type_hints["family"])
-        return typing.cast(CodeConfig, jsii.invoke(self, "bind", [scope, handler, family]))
+            check_type(argname="argument runtime_name", value=runtime_name, expected_type=type_hints["runtime_name"])
+        return typing.cast(CodeConfig, jsii.invoke(self, "bind", [scope, handler, family, runtime_name]))
 
 
 __all__ = [
@@ -4515,6 +4582,7 @@ def _typecheckingstub__b3b6d76e5f93e31884e16cc00a9b4fc93e6782ff7db09c74aa1ef9346
     environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
     memory: typing.Optional[_Size_7b441c34] = None,
+    provisioned_resource_cleanup: typing.Optional[builtins.bool] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
     schedule: typing.Optional[Schedule] = None,
     security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
@@ -4542,6 +4610,7 @@ def _typecheckingstub__44ec0b14d52b66927d4daebe6f97bb070f3629bb0eb86e21668ca7862
     environment_variables: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
     failure_retention_period: typing.Optional[_Duration_4839e8c3] = None,
     memory: typing.Optional[_Size_7b441c34] = None,
+    provisioned_resource_cleanup: typing.Optional[builtins.bool] = None,
     role: typing.Optional[_IRole_235f5d8e] = None,
     schedule: typing.Optional[Schedule] = None,
     security_groups: typing.Optional[typing.Sequence[_ISecurityGroup_acf8a799]] = None,
@@ -4872,6 +4941,7 @@ def _typecheckingstub__16072f2291ff792418a957a399b7ca3a9d2e16cb1e67d33d5682dbb0e
     scope: _constructs_77d1e7e8.Construct,
     handler: builtins.str,
     family: RuntimeFamily,
+    runtime_name: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -4910,9 +4980,10 @@ def _typecheckingstub__8e4d6f25be5e212e7eccf81a0bb26d92760fb4f335d2fd7395acbdc37
     pass
 
 def _typecheckingstub__9c1dddac73b46d6693b6032065ae6db988e1e76cb520ebf3d4aa58e532f543a9(
-    _scope: _constructs_77d1e7e8.Construct,
+    scope: _constructs_77d1e7e8.Construct,
     handler: builtins.str,
     _family: RuntimeFamily,
+    _runtime_name: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -4936,6 +5007,7 @@ def _typecheckingstub__2e764381c92bbdf3e70a0cf34a6f1afa9abfa207f9eb030a4ac6823b6
     _scope: _constructs_77d1e7e8.Construct,
     _handler: builtins.str,
     _family: RuntimeFamily,
+    _runtime_name: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -4972,6 +5044,7 @@ def _typecheckingstub__dcf81e22fccedf5b193b8ec9218200abb14bc77d3601c5cd7edbedda5
     scope: _constructs_77d1e7e8.Construct,
     handler: builtins.str,
     family: RuntimeFamily,
+    runtime_name: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass

aws_cdk/cloud_assembly_schema/__init__.py

@@ -5563,6 +5563,64 @@ class HostedZoneContextQuery(ContextLookupRoleOptions):
         )
 
 
+@jsii.interface(jsii_type="aws-cdk-lib.cloud_assembly_schema.ICloudAssembly")
+class ICloudAssembly(typing_extensions.Protocol):
+    '''Interoperable representation of a deployable cloud application.
+
+    The external and interoperable contract for a Cloud Assembly is
+    a directory containing a valid Cloud Assembly.
+
+    Implementations should use the directory to load the Cloud Assembly from disk.
+    It is recommended that implementations validate loaded manifest files using
+    the provided functionality from this package.
+    Within an implementation, it may be prudent to keep (parts of) the Cloud Assembly
+    in memory during execution and use an implementation-specific contract.
+    However when an implementation is providing an external contract,
+    this interface should be used.
+    '''
+
+    @builtins.property
+    @jsii.member(jsii_name="directory")
+    def directory(self) -> builtins.str:
+        '''The directory of the cloud assembly.
+
+        This directory will be used to read the Cloud Assembly from.
+        Its contents (in particular ``manifest.json``) must comply with the schema defined in this package.
+        '''
+        ...
+
+
+class _ICloudAssemblyProxy:
+    '''Interoperable representation of a deployable cloud application.
+
+    The external and interoperable contract for a Cloud Assembly is
+    a directory containing a valid Cloud Assembly.
+
+    Implementations should use the directory to load the Cloud Assembly from disk.
+    It is recommended that implementations validate loaded manifest files using
+    the provided functionality from this package.
+    Within an implementation, it may be prudent to keep (parts of) the Cloud Assembly
+    in memory during execution and use an implementation-specific contract.
+    However when an implementation is providing an external contract,
+    this interface should be used.
+    '''
+
+    __jsii_type__: typing.ClassVar[str] = "aws-cdk-lib.cloud_assembly_schema.ICloudAssembly"
+
+    @builtins.property
+    @jsii.member(jsii_name="directory")
+    def directory(self) -> builtins.str:
+        '''The directory of the cloud assembly.
+
+        This directory will be used to read the Cloud Assembly from.
+        Its contents (in particular ``manifest.json``) must comply with the schema defined in this package.
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "directory"))
+
+# Adding a "__jsii_proxy_class__(): typing.Type" function to the interface
+typing.cast(typing.Any, ICloudAssembly).__jsii_proxy_class__ = lambda : _ICloudAssemblyProxy
+
+
 @jsii.data_type(
     jsii_type="aws-cdk-lib.cloud_assembly_schema.IntegManifest",
     jsii_struct_bases=[],
@@ -6579,7 +6637,7 @@ class MetadataEntry:
         self,
         *,
         type: builtins.str,
-        data: typing.Optional[typing.Union[builtins.str, typing.Union[FileAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Union[ContainerImageAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Sequence[typing.Union["Tag", typing.Dict[builtins.str, typing.Any]]]]] = None,
+        data: typing.Optional[typing.Union[builtins.str, jsii.Number, builtins.bool, typing.Union[FileAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Union[ContainerImageAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Sequence[typing.Union["Tag", typing.Dict[builtins.str, typing.Any]]]]] = None,
         trace: typing.Optional[typing.Sequence[builtins.str]] = None,
     ) -> None:
         '''A metadata entry in a cloud assembly artifact.
@@ -6627,13 +6685,13 @@ class MetadataEntry:
     @builtins.property
     def data(
         self,
-    ) -> typing.Optional[typing.Union[builtins.str, FileAssetMetadataEntry, ContainerImageAssetMetadataEntry, typing.List["Tag"]]]:
+    ) -> typing.Optional[typing.Union[builtins.str, jsii.Number, builtins.bool, FileAssetMetadataEntry, ContainerImageAssetMetadataEntry, typing.List["Tag"]]]:
         '''The data.
 
         :default: - no data.
         '''
         result = self._values.get("data")
-        return typing.cast(typing.Optional[typing.Union[builtins.str, FileAssetMetadataEntry, ContainerImageAssetMetadataEntry, typing.List["Tag"]]], result)
+        return typing.cast(typing.Optional[typing.Union[builtins.str, jsii.Number, builtins.bool, FileAssetMetadataEntry, ContainerImageAssetMetadataEntry, typing.List["Tag"]]], result)
 
     @builtins.property
     def trace(self) -> typing.Optional[typing.List[builtins.str]]:
@@ -8617,6 +8675,7 @@ __all__ = [
     "FileSource",
     "Hooks",
     "HostedZoneContextQuery",
+    "ICloudAssembly",
     "IntegManifest",
     "KeyContextQuery",
     "LoadBalancerContextQuery",
@@ -9149,7 +9208,7 @@ def _typecheckingstub__87be211e9c3bb7ce042946888a960f69db963f2d5811832fbf0681bf9
 def _typecheckingstub__e77201bee0581d95dfd6e3150d491c958851c456cbdd8aaea71cb737197beaee(
     *,
     type: builtins.str,
-    data: typing.Optional[typing.Union[builtins.str, typing.Union[FileAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Union[ContainerImageAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Sequence[typing.Union[Tag, typing.Dict[builtins.str, typing.Any]]]]] = None,
+    data: typing.Optional[typing.Union[builtins.str, jsii.Number, builtins.bool, typing.Union[FileAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Union[ContainerImageAssetMetadataEntry, typing.Dict[builtins.str, typing.Any]], typing.Sequence[typing.Union[Tag, typing.Dict[builtins.str, typing.Any]]]]] = None,
     trace: typing.Optional[typing.Sequence[builtins.str]] = None,
 ) -> None:
     """Type checking stubs"""