aws-cdk-lib 2.153.0__py3-none-any.whl → 2.154.0__py3-none-any.whl

aws_cdk/custom_resources/__init__.py

@@ -831,6 +831,111 @@ cr.AwsCustomResource(self, "CrossAccount",
     })])
 )
 ```
+
+#### Custom Resource Config
+
+**This feature is currently experimental**
+
+You can configure every CDK-vended custom resource in a given scope with `CustomResourceConfig`.
+
+Note that `CustomResourceConfig` uses Aspects to modify your constructs. There is no guarantee in the order in which Aspects modify the construct tree, which means that adding the same Aspect more than once to a given scope produces undefined behavior. This example guarantees that every affected resource will have a log retention of ten years or one day, but you cannot know which:
+CustomResourceConfig.of(App).addLogRetentionLifetime(logs.RetentionDays.TEN_YEARS);
+CustomResourceConfig.of(App).addLogRetentionLifetime(logs.RetentionDays.ONE_DAY);
+
+The following example configures every custom resource in this CDK app to retain its logs for ten years:
+
+```python
+import aws_cdk as cdk
+from aws_cdk.custom_resources import CustomResourceConfig
+import aws_cdk.aws_s3_deployment as s3deploy
+
+
+app = cdk.App()
+CustomResourceConfig.of(app).add_log_retention_lifetime(logs.RetentionDays.TEN_YEARS)
+stack = cdk.Stack(app, "Stack")
+
+website_bucket = s3.Bucket(stack, "WebsiteBucket")
+s3deploy.BucketDeployment(stack, "s3deploy",
+    sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
+    destination_bucket=website_bucket
+)
+```
+
+The following example configures every custom resource in two top-level stacks to retain its log for ten years:
+
+```python
+import aws_cdk as cdk
+from aws_cdk.custom_resources import CustomResourceConfig
+import aws_cdk.aws_s3_deployment as s3deploy
+
+
+app = cdk.App()
+CustomResourceConfig.of(app).add_log_retention_lifetime(logs.RetentionDays.TEN_YEARS)
+
+stack_a = cdk.Stack(app, "stackA")
+website_bucket_a = s3.Bucket(stack_a, "WebsiteBucketA")
+s3deploy.BucketDeployment(stack_a, "s3deployA",
+    sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
+    destination_bucket=website_bucket_a,
+    log_retention=logs.RetentionDays.ONE_DAY
+)
+
+stack_b = cdk.Stack(app, "stackB")
+website_bucket_b = s3.Bucket(stack_b, "WebsiteBucketB")
+s3deploy.BucketDeployment(stack_b, "s3deployB",
+    sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
+    destination_bucket=website_bucket_b,
+    log_retention=logs.RetentionDays.ONE_DAY
+)
+```
+
+This also applies to nested stacks:
+
+```python
+import aws_cdk as cdk
+from aws_cdk.custom_resources import CustomResourceConfig
+import aws_cdk.aws_s3_deployment as s3deploy
+
+
+app = cdk.App()
+stack = cdk.Stack(app, "Stack")
+CustomResourceConfig.of(app).add_log_retention_lifetime(logs.RetentionDays.TEN_YEARS)
+
+nested_stack_a = cdk.NestedStack(stack, "NestedStackA")
+website_bucket_a = s3.Bucket(nested_stack_a, "WebsiteBucketA")
+s3deploy.BucketDeployment(nested_stack_a, "s3deployA",
+    sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
+    destination_bucket=website_bucket_a,
+    log_retention=logs.RetentionDays.ONE_DAY
+)
+
+nested_stack_b = cdk.NestedStack(stack, "NestedStackB")
+website_bucket_b = s3.Bucket(nested_stack_b, "WebsiteBucketB")
+s3deploy.BucketDeployment(nested_stack_b, "s3deployB",
+    sources=[s3deploy.Source.json_data("file.json", {"a": "b"})],
+    destination_bucket=website_bucket_b,
+    log_retention=logs.RetentionDays.ONE_DAY
+)
+```
+
+The `addLogRetentionLifetime` method of `CustomResourceConfig` will associate a log group with a AWS-vended custom resource lambda.
+The `addRemovalPolicy` method will configure the custom resource lambda log group removal policy to `DESTROY`.
+
+```python
+import aws_cdk as cdk
+import aws_cdk.aws_ses as ses
+from aws_cdk.custom_resources import CustomResourceConfig
+
+
+app = cdk.App()
+stack = cdk.Stack(app, "Stack")
+CustomResourceConfig.of(app).add_log_retention_lifetime(logs.RetentionDays.TEN_YEARS)
+CustomResourceConfig.of(app).add_removal_policy(cdk.RemovalPolicy.DESTROY)
+
+ses.ReceiptRuleSet(app, "RuleSet",
+    drop_spam=True
+)
+```
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
@@ -852,6 +957,7 @@ from .._jsii import *
 import constructs as _constructs_77d1e7e8
 from .. import (
     Duration as _Duration_4839e8c3,
+    IAspect as _IAspect_118c810a,
     IResolvable as _IResolvable_da3f097b,
     IResolveContext as _IResolveContext_b2df1921,
     Reference as _Reference_6ab8bd04,
@@ -1687,6 +1793,138 @@ class AwsSdkCall:
         )
 
 
+class CustomResourceConfig(
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.custom_resources.CustomResourceConfig",
+):
+    '''Manages AWS-vended Custom Resources This feature is currently experimental.
+
+    :exampleMetadata: fixture=_generated
+
+    Example::
+
+        # The code below shows an example of how to instantiate this type.
+        # The values are placeholders you should change.
+        from aws_cdk import custom_resources
+        
+        custom_resource_config = custom_resources.CustomResourceConfig.of(self)
+    '''
+
+    @jsii.member(jsii_name="of")
+    @builtins.classmethod
+    def of(cls, scope: _constructs_77d1e7e8.IConstruct) -> "CustomResourceConfig":
+        '''Returns the CustomResourceConfig for this scope.
+
+        :param scope: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__71c1178bbfb24d2c3974ce93648bb5eea2ec04e86060e04ce5e125d8284b38db)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+        return typing.cast("CustomResourceConfig", jsii.sinvoke(cls, "of", [scope]))
+
+    @jsii.member(jsii_name="addLogRetentionLifetime")
+    def add_log_retention_lifetime(self, rentention: _RetentionDays_070f99f0) -> None:
+        '''Set the log retention of AWS-vended custom resource lambdas.
+
+        :param rentention: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__b24e4182dd0a87c24dfd3d5c1bc10b91914571416d15e209d3fbd01cdcca86c3)
+            check_type(argname="argument rentention", value=rentention, expected_type=type_hints["rentention"])
+        return typing.cast(None, jsii.invoke(self, "addLogRetentionLifetime", [rentention]))
+
+    @jsii.member(jsii_name="addRemovalPolicy")
+    def add_removal_policy(self, removal_policy: _RemovalPolicy_9f93c814) -> None:
+        '''Set the removal policy of AWS-vended custom resource logGroup.
+
+        :param removal_policy: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__40b6d12e0fa498dd2bcee3634487a6647d3a4e2c1241e542a57e63d03bc0ce11)
+            check_type(argname="argument removal_policy", value=removal_policy, expected_type=type_hints["removal_policy"])
+        return typing.cast(None, jsii.invoke(self, "addRemovalPolicy", [removal_policy]))
+
+
+@jsii.implements(_IAspect_118c810a)
+class CustomResourceLogRetention(
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.custom_resources.CustomResourceLogRetention",
+):
+    '''Manages log retention for AWS-vended custom resources.
+
+    :exampleMetadata: fixture=_generated
+
+    Example::
+
+        # The code below shows an example of how to instantiate this type.
+        # The values are placeholders you should change.
+        from aws_cdk import aws_logs as logs
+        from aws_cdk import custom_resources
+        
+        custom_resource_log_retention = custom_resources.CustomResourceLogRetention(logs.RetentionDays.ONE_DAY)
+    '''
+
+    def __init__(self, set_log_retention: _RetentionDays_070f99f0) -> None:
+        '''
+        :param set_log_retention: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__d9817c2e505de7a66bfdd5dae2d9307acfd8d0c9c65dd6bd79ef0eb799e16ac3)
+            check_type(argname="argument set_log_retention", value=set_log_retention, expected_type=type_hints["set_log_retention"])
+        jsii.create(self.__class__, self, [set_log_retention])
+
+    @jsii.member(jsii_name="visit")
+    def visit(self, node: _constructs_77d1e7e8.IConstruct) -> None:
+        '''All aspects can visit an IConstruct.
+
+        :param node: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__6d349c2bda31cd5521973775eaf8b22424069faf01c9de9d2f03e06fcd2a0da4)
+            check_type(argname="argument node", value=node, expected_type=type_hints["node"])
+        return typing.cast(None, jsii.invoke(self, "visit", [node]))
+
+
+@jsii.implements(_IAspect_118c810a)
+class CustomResourceRemovalPolicy(
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.custom_resources.CustomResourceRemovalPolicy",
+):
+    '''Manages removal policy for AWS-vended custom resources.
+
+    :exampleMetadata: fixture=_generated
+
+    Example::
+
+        # The code below shows an example of how to instantiate this type.
+        # The values are placeholders you should change.
+        import aws_cdk as cdk
+        from aws_cdk import custom_resources
+        
+        custom_resource_removal_policy = custom_resources.CustomResourceRemovalPolicy(cdk.RemovalPolicy.DESTROY)
+    '''
+
+    def __init__(self, removal_policy: _RemovalPolicy_9f93c814) -> None:
+        '''
+        :param removal_policy: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__eafa318fd018f6de7fbf4e835b5b4b8dd33509979ae54cebbe4417fa8b87e17b)
+            check_type(argname="argument removal_policy", value=removal_policy, expected_type=type_hints["removal_policy"])
+        jsii.create(self.__class__, self, [removal_policy])
+
+    @jsii.member(jsii_name="visit")
+    def visit(self, node: _constructs_77d1e7e8.IConstruct) -> None:
+        '''All aspects can visit an IConstruct.
+
+        :param node: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__b25638ab024a9c20a9f0e648bced71eb09bda8705a26cd9e81b3c76115521efb)
+            check_type(argname="argument node", value=node, expected_type=type_hints["node"])
+        return typing.cast(None, jsii.invoke(self, "visit", [node]))
+
+
 @jsii.data_type(
     jsii_type="aws-cdk-lib.custom_resources.LogOptions",
     jsii_struct_bases=[],
@@ -2804,6 +3042,9 @@ __all__ = [
     "AwsCustomResourcePolicy",
     "AwsCustomResourceProps",
     "AwsSdkCall",
+    "CustomResourceConfig",
+    "CustomResourceLogRetention",
+    "CustomResourceRemovalPolicy",
     "LogOptions",
     "Logging",
     "LoggingProps",
@@ -2896,6 +3137,48 @@ def _typecheckingstub__af7bb124668b93c6ce7d641df2daeabfe424e271742385a76e7e56ec9
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__71c1178bbfb24d2c3974ce93648bb5eea2ec04e86060e04ce5e125d8284b38db(
+    scope: _constructs_77d1e7e8.IConstruct,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__b24e4182dd0a87c24dfd3d5c1bc10b91914571416d15e209d3fbd01cdcca86c3(
+    rentention: _RetentionDays_070f99f0,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__40b6d12e0fa498dd2bcee3634487a6647d3a4e2c1241e542a57e63d03bc0ce11(
+    removal_policy: _RemovalPolicy_9f93c814,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__d9817c2e505de7a66bfdd5dae2d9307acfd8d0c9c65dd6bd79ef0eb799e16ac3(
+    set_log_retention: _RetentionDays_070f99f0,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__6d349c2bda31cd5521973775eaf8b22424069faf01c9de9d2f03e06fcd2a0da4(
+    node: _constructs_77d1e7e8.IConstruct,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__eafa318fd018f6de7fbf4e835b5b4b8dd33509979ae54cebbe4417fa8b87e17b(
+    removal_policy: _RemovalPolicy_9f93c814,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__b25638ab024a9c20a9f0e648bced71eb09bda8705a26cd9e81b3c76115521efb(
+    node: _constructs_77d1e7e8.IConstruct,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__2622296f61199d2b10825c21d976c0578e9488ad1b2b7635565f604c598734b7(
     *,
     destination: typing.Optional[_ILogGroup_3c4fa718] = None,

aws_cdk/cx_api/__init__.py

@@ -588,7 +588,7 @@ class CloudArtifact(
             display_name="displayName",
             environment="environment",
             metadata={
-                "metadata_key": [cloud_assembly_schema.MetadataEntry(
+                "metadata_key": [MetadataEntry(
                     type="type",
         
                     # the properties below are optional
@@ -596,7 +596,7 @@ class CloudArtifact(
                     trace=["trace"]
                 )]
             },
-            properties=cloud_assembly_schema.AwsCloudFormationStackProperties(
+            properties=AwsCloudFormationStackProperties(
                 template_file="templateFile",
         
                 # the properties below are optional
@@ -604,7 +604,7 @@ class CloudArtifact(
                 assume_role_external_id="assumeRoleExternalId",
                 bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
                 cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
-                lookup_role=cloud_assembly_schema.BootstrapRole(
+                lookup_role=BootstrapRole(
                     arn="arn",
         
                     # the properties below are optional
@@ -1184,7 +1184,7 @@ class CloudFormationStackArtifact(
             display_name="displayName",
             environment="environment",
             metadata={
-                "metadata_key": [cloud_assembly_schema.MetadataEntry(
+                "metadata_key": [MetadataEntry(
                     type="type",
         
                     # the properties below are optional
@@ -1192,7 +1192,7 @@ class CloudFormationStackArtifact(
                     trace=["trace"]
                 )]
             },
-            properties=cloud_assembly_schema.AwsCloudFormationStackProperties(
+            properties=AwsCloudFormationStackProperties(
                 template_file="templateFile",
         
                 # the properties below are optional
@@ -1200,7 +1200,7 @@ class CloudFormationStackArtifact(
                 assume_role_external_id="assumeRoleExternalId",
                 bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
                 cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
-                lookup_role=cloud_assembly_schema.BootstrapRole(
+                lookup_role=BootstrapRole(
                     arn="arn",
         
                     # the properties below are optional
@@ -2247,7 +2247,7 @@ class NestedCloudAssemblyArtifact(
             display_name="displayName",
             environment="environment",
             metadata={
-                "metadata_key": [cloud_assembly_schema.MetadataEntry(
+                "metadata_key": [MetadataEntry(
                     type="type",
         
                     # the properties below are optional
@@ -2255,7 +2255,7 @@ class NestedCloudAssemblyArtifact(
                     trace=["trace"]
                 )]
             },
-            properties=cloud_assembly_schema.AwsCloudFormationStackProperties(
+            properties=AwsCloudFormationStackProperties(
                 template_file="templateFile",
         
                 # the properties below are optional
@@ -2263,7 +2263,7 @@ class NestedCloudAssemblyArtifact(
                 assume_role_external_id="assumeRoleExternalId",
                 bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
                 cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
-                lookup_role=cloud_assembly_schema.BootstrapRole(
+                lookup_role=BootstrapRole(
                     arn="arn",
         
                     # the properties below are optional
@@ -2560,7 +2560,7 @@ class TreeCloudArtifact(
             display_name="displayName",
             environment="environment",
             metadata={
-                "metadata_key": [cloud_assembly_schema.MetadataEntry(
+                "metadata_key": [MetadataEntry(
                     type="type",
         
                     # the properties below are optional
@@ -2568,7 +2568,7 @@ class TreeCloudArtifact(
                     trace=["trace"]
                 )]
             },
-            properties=cloud_assembly_schema.AwsCloudFormationStackProperties(
+            properties=AwsCloudFormationStackProperties(
                 template_file="templateFile",
         
                 # the properties below are optional
@@ -2576,7 +2576,7 @@ class TreeCloudArtifact(
                 assume_role_external_id="assumeRoleExternalId",
                 bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
                 cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
-                lookup_role=cloud_assembly_schema.BootstrapRole(
+                lookup_role=BootstrapRole(
                     arn="arn",
         
                     # the properties below are optional
@@ -3212,7 +3212,7 @@ class AssetManifestArtifact(
             display_name="displayName",
             environment="environment",
             metadata={
-                "metadata_key": [cloud_assembly_schema.MetadataEntry(
+                "metadata_key": [MetadataEntry(
                     type="type",
         
                     # the properties below are optional
@@ -3220,7 +3220,7 @@ class AssetManifestArtifact(
                     trace=["trace"]
                 )]
             },
-            properties=cloud_assembly_schema.AwsCloudFormationStackProperties(
+            properties=AwsCloudFormationStackProperties(
                 template_file="templateFile",
         
                 # the properties below are optional
@@ -3228,7 +3228,7 @@ class AssetManifestArtifact(
                 assume_role_external_id="assumeRoleExternalId",
                 bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
                 cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
-                lookup_role=cloud_assembly_schema.BootstrapRole(
+                lookup_role=BootstrapRole(
                     arn="arn",
         
                     # the properties below are optional