aws-cdk-lib 2.201.0__py3-none-any.whl → 2.203.0__py3-none-any.whl

aws_cdk/pipelines/__init__.py

@@ -540,6 +540,7 @@ pass in order to promote from the `PreProd` to the `Prod` environment:
 
 preprod = MyApplicationStage(self, "PreProd")
 prod = MyApplicationStage(self, "Prod")
+topic = sns.Topic(self, "ChangeApprovalTopic")
 
 pipeline.add_stage(preprod,
     post=[
@@ -549,7 +550,12 @@ pipeline.add_stage(preprod,
     ]
 )
 pipeline.add_stage(prod,
-    pre=[pipelines.ManualApprovalStep("PromoteToProd")]
+    pre=[pipelines.ManualApprovalStep("PromoteToProd",
+        # All options below are optional
+        comment="Please validate changes",
+        review_url="https://my.webservice.com/",
+        notification_topic=topic
+    )]
 )
 ```
 
@@ -1837,19 +1843,18 @@ class AddStageOpts:
 
             # pipeline: pipelines.CodePipeline
             
-            preprod = MyApplicationStage(self, "PreProd")
-            prod = MyApplicationStage(self, "Prod")
+            topic = sns.Topic(self, "SecurityChangesTopic")
+            topic.add_subscription(subscriptions.EmailSubscription("test@email.com"))
             
-            pipeline.add_stage(preprod,
-                post=[
-                    pipelines.ShellStep("Validate Endpoint",
-                        commands=["curl -Ssf https://my.webservice.com/"]
+            stage = MyApplicationStage(self, "MyApplication")
+            pipeline.add_stage(stage,
+                pre=[
+                    pipelines.ConfirmPermissionsBroadening("Check",
+                        stage=stage,
+                        notification_topic=topic
                     )
                 ]
             )
-            pipeline.add_stage(prod,
-                pre=[pipelines.ManualApprovalStep("PromoteToProd")]
-            )
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__1b9c1bc74292ecb27724ef07a41dc8f1b1ee5d9dc268940f2ec578982b596b0a)
@@ -2388,6 +2393,7 @@ class CodePipelineActionFactoryResult:
         "synth": "synth",
         "artifact_bucket": "artifactBucket",
         "asset_publishing_code_build_defaults": "assetPublishingCodeBuildDefaults",
+        "cdk_assets_cli_version": "cdkAssetsCliVersion",
         "cli_version": "cliVersion",
         "code_build_defaults": "codeBuildDefaults",
         "code_pipeline": "codePipeline",
@@ -2416,6 +2422,7 @@ class CodePipelineProps:
         synth: "IFileSetProducer",
         artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
         asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
+        cdk_assets_cli_version: typing.Optional[builtins.str] = None,
         cli_version: typing.Optional[builtins.str] = None,
         code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         code_pipeline: typing.Optional[_Pipeline_ea38de84] = None,
@@ -2441,7 +2448,8 @@ class CodePipelineProps:
         :param synth: The build step that produces the CDK Cloud Assembly. The primary output of this step needs to be the ``cdk.out`` directory generated by the ``cdk synth`` command. If you use a ``ShellStep`` here and you don't configure an output directory, the output directory will automatically be assumed to be ``cdk.out``.
         :param artifact_bucket: An existing S3 Bucket to use for storing the pipeline's artifact. Default: - A new S3 bucket will be created.
         :param asset_publishing_code_build_defaults: Additional customizations to apply to the asset publishing CodeBuild projects. Default: - Only ``codeBuildDefaults`` are applied
-        :param cli_version: CDK CLI version to use in self-mutation and asset publishing steps. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the ``SelfMutate`` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after ``SelfMutate`` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. Default: - Latest version
+        :param cdk_assets_cli_version: CDK CLI version to use in asset publishing steps. If you want to lock the ``cdk-assets`` version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. Default: - Latest version
+        :param cli_version: CDK CLI version to use in self-mutation step. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the ``SelfMutate`` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after ``SelfMutate`` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. Default: - Latest version
         :param code_build_defaults: Customize the CodeBuild projects created for this pipeline. Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_7_0
         :param code_pipeline: An existing Pipeline to be reused and built upon. [disable-awslint:ref-via-interface] Default: - a new underlying pipeline is created.
         :param cross_account_keys: Create KMS keys for the artifact buckets, allowing cross-account deployments. The artifact buckets have to be encrypted to support deploying CDK apps to another account, so if you want to do that or want to have your artifact buckets encrypted, be sure to set this value to ``true``. Be aware there is a cost associated with maintaining the KMS keys. Default: false
@@ -2491,6 +2499,7 @@ class CodePipelineProps:
             check_type(argname="argument synth", value=synth, expected_type=type_hints["synth"])
             check_type(argname="argument artifact_bucket", value=artifact_bucket, expected_type=type_hints["artifact_bucket"])
             check_type(argname="argument asset_publishing_code_build_defaults", value=asset_publishing_code_build_defaults, expected_type=type_hints["asset_publishing_code_build_defaults"])
+            check_type(argname="argument cdk_assets_cli_version", value=cdk_assets_cli_version, expected_type=type_hints["cdk_assets_cli_version"])
             check_type(argname="argument cli_version", value=cli_version, expected_type=type_hints["cli_version"])
             check_type(argname="argument code_build_defaults", value=code_build_defaults, expected_type=type_hints["code_build_defaults"])
             check_type(argname="argument code_pipeline", value=code_pipeline, expected_type=type_hints["code_pipeline"])
@@ -2517,6 +2526,8 @@ class CodePipelineProps:
             self._values["artifact_bucket"] = artifact_bucket
         if asset_publishing_code_build_defaults is not None:
             self._values["asset_publishing_code_build_defaults"] = asset_publishing_code_build_defaults
+        if cdk_assets_cli_version is not None:
+            self._values["cdk_assets_cli_version"] = cdk_assets_cli_version
         if cli_version is not None:
             self._values["cli_version"] = cli_version
         if code_build_defaults is not None:
@@ -2588,9 +2599,26 @@ class CodePipelineProps:
         result = self._values.get("asset_publishing_code_build_defaults")
         return typing.cast(typing.Optional[CodeBuildOptions], result)
 
+    @builtins.property
+    def cdk_assets_cli_version(self) -> typing.Optional[builtins.str]:
+        '''CDK CLI version to use in asset publishing steps.
+
+        If you want to lock the ``cdk-assets`` version used in the pipeline, by steps
+        that are automatically generated for you, specify the version here.
+
+        We recommend you do not specify this value, as not specifying it always
+        uses the latest CLI version which is backwards compatible with old versions.
+
+        :default: - Latest version
+
+        :see: https://www.npmjs.com/package/cdk-assets
+        '''
+        result = self._values.get("cdk_assets_cli_version")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def cli_version(self) -> typing.Optional[builtins.str]:
-        '''CDK CLI version to use in self-mutation and asset publishing steps.
+        '''CDK CLI version to use in self-mutation step.
 
         If you want to lock the CDK CLI version used in the pipeline, by steps
         that are automatically generated for you, specify the version here.
@@ -3759,32 +3787,64 @@ typing.cast(typing.Any, IFileSetProducer).__jsii_proxy_class__ = lambda : _IFile
 @jsii.data_type(
     jsii_type="aws-cdk-lib.pipelines.ManualApprovalStepProps",
     jsii_struct_bases=[],
-    name_mapping={"comment": "comment"},
+    name_mapping={
+        "comment": "comment",
+        "notification_topic": "notificationTopic",
+        "review_url": "reviewUrl",
+    },
 )
 class ManualApprovalStepProps:
-    def __init__(self, *, comment: typing.Optional[builtins.str] = None) -> None:
+    def __init__(
+        self,
+        *,
+        comment: typing.Optional[builtins.str] = None,
+        notification_topic: typing.Optional[_ITopic_9eca4852] = None,
+        review_url: typing.Optional[builtins.str] = None,
+    ) -> None:
         '''Construction properties for a ``ManualApprovalStep``.
 
         :param comment: The comment to display with this manual approval. Default: - No comment
+        :param notification_topic: Optional SNS topic to send notifications to when an approval is pending. Default: - No notifications
+        :param review_url: The URL for review associated with this manual approval. Default: - No URL
 
-        :exampleMetadata: fixture=_generated
+        :exampleMetadata: infused
 
         Example::
 
-            # The code below shows an example of how to instantiate this type.
-            # The values are placeholders you should change.
-            from aws_cdk import pipelines
+            # pipeline: pipelines.CodePipeline
             
-            manual_approval_step_props = pipelines.ManualApprovalStepProps(
-                comment="comment"
+            preprod = MyApplicationStage(self, "PreProd")
+            prod = MyApplicationStage(self, "Prod")
+            topic = sns.Topic(self, "ChangeApprovalTopic")
+            
+            pipeline.add_stage(preprod,
+                post=[
+                    pipelines.ShellStep("Validate Endpoint",
+                        commands=["curl -Ssf https://my.webservice.com/"]
+                    )
+                ]
+            )
+            pipeline.add_stage(prod,
+                pre=[pipelines.ManualApprovalStep("PromoteToProd",
+                    # All options below are optional
+                    comment="Please validate changes",
+                    review_url="https://my.webservice.com/",
+                    notification_topic=topic
+                )]
             )
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__5a0a42f985a6aa39b8db8606833d899bd8c93567a96ac5acb2c9407bde8793ed)
             check_type(argname="argument comment", value=comment, expected_type=type_hints["comment"])
+            check_type(argname="argument notification_topic", value=notification_topic, expected_type=type_hints["notification_topic"])
+            check_type(argname="argument review_url", value=review_url, expected_type=type_hints["review_url"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
         if comment is not None:
             self._values["comment"] = comment
+        if notification_topic is not None:
+            self._values["notification_topic"] = notification_topic
+        if review_url is not None:
+            self._values["review_url"] = review_url
 
     @builtins.property
     def comment(self) -> typing.Optional[builtins.str]:
@@ -3795,6 +3855,24 @@ class ManualApprovalStepProps:
         result = self._values.get("comment")
         return typing.cast(typing.Optional[builtins.str], result)
 
+    @builtins.property
+    def notification_topic(self) -> typing.Optional[_ITopic_9eca4852]:
+        '''Optional SNS topic to send notifications to when an approval is pending.
+
+        :default: - No notifications
+        '''
+        result = self._values.get("notification_topic")
+        return typing.cast(typing.Optional[_ITopic_9eca4852], result)
+
+    @builtins.property
+    def review_url(self) -> typing.Optional[builtins.str]:
+        '''The URL for review associated with this manual approval.
+
+        :default: - No URL
+        '''
+        result = self._values.get("review_url")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -4505,17 +4583,26 @@ class ShellStepProps:
 
         Example::
 
-            # code_pipeline: codepipeline.Pipeline
-            
+            # pipeline: pipelines.CodePipeline
             
-            source_artifact = codepipeline.Artifact("MySourceArtifact")
+            preprod = MyApplicationStage(self, "PreProd")
+            prod = MyApplicationStage(self, "Prod")
+            topic = sns.Topic(self, "ChangeApprovalTopic")
             
-            pipeline = pipelines.CodePipeline(self, "Pipeline",
-                code_pipeline=code_pipeline,
-                synth=pipelines.ShellStep("Synth",
-                    input=pipelines.CodePipelineFileSet.from_artifact(source_artifact),
-                    commands=["npm ci", "npm run build", "npx cdk synth"]
-                )
+            pipeline.add_stage(preprod,
+                post=[
+                    pipelines.ShellStep("Validate Endpoint",
+                        commands=["curl -Ssf https://my.webservice.com/"]
+                    )
+                ]
+            )
+            pipeline.add_stage(prod,
+                pre=[pipelines.ManualApprovalStep("PromoteToProd",
+                    # All options below are optional
+                    comment="Please validate changes",
+                    review_url="https://my.webservice.com/",
+                    notification_topic=topic
+                )]
             )
         '''
         if __debug__:
@@ -6594,6 +6681,7 @@ class CodePipeline(
         synth: IFileSetProducer,
         artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
         asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
+        cdk_assets_cli_version: typing.Optional[builtins.str] = None,
         cli_version: typing.Optional[builtins.str] = None,
         code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         code_pipeline: typing.Optional[_Pipeline_ea38de84] = None,
@@ -6620,7 +6708,8 @@ class CodePipeline(
         :param synth: The build step that produces the CDK Cloud Assembly. The primary output of this step needs to be the ``cdk.out`` directory generated by the ``cdk synth`` command. If you use a ``ShellStep`` here and you don't configure an output directory, the output directory will automatically be assumed to be ``cdk.out``.
         :param artifact_bucket: An existing S3 Bucket to use for storing the pipeline's artifact. Default: - A new S3 bucket will be created.
         :param asset_publishing_code_build_defaults: Additional customizations to apply to the asset publishing CodeBuild projects. Default: - Only ``codeBuildDefaults`` are applied
-        :param cli_version: CDK CLI version to use in self-mutation and asset publishing steps. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the ``SelfMutate`` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after ``SelfMutate`` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. Default: - Latest version
+        :param cdk_assets_cli_version: CDK CLI version to use in asset publishing steps. If you want to lock the ``cdk-assets`` version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. Default: - Latest version
+        :param cli_version: CDK CLI version to use in self-mutation step. If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here. We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions. If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the *next time* the ``SelfMutate`` step runs it will still be using the CLI of the the *previous* version that was in this property: it will only start using the new version after ``SelfMutate`` completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version. Default: - Latest version
         :param code_build_defaults: Customize the CodeBuild projects created for this pipeline. Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_7_0
         :param code_pipeline: An existing Pipeline to be reused and built upon. [disable-awslint:ref-via-interface] Default: - a new underlying pipeline is created.
         :param cross_account_keys: Create KMS keys for the artifact buckets, allowing cross-account deployments. The artifact buckets have to be encrypted to support deploying CDK apps to another account, so if you want to do that or want to have your artifact buckets encrypted, be sure to set this value to ``true``. Be aware there is a cost associated with maintaining the KMS keys. Default: false
@@ -6648,6 +6737,7 @@ class CodePipeline(
             synth=synth,
             artifact_bucket=artifact_bucket,
             asset_publishing_code_build_defaults=asset_publishing_code_build_defaults,
+            cdk_assets_cli_version=cdk_assets_cli_version,
             cli_version=cli_version,
             code_build_defaults=code_build_defaults,
             code_pipeline=code_pipeline,
@@ -7317,6 +7407,7 @@ class ManualApprovalStep(
         
         preprod = MyApplicationStage(self, "PreProd")
         prod = MyApplicationStage(self, "Prod")
+        topic = sns.Topic(self, "ChangeApprovalTopic")
         
         pipeline.add_stage(preprod,
             post=[
@@ -7326,7 +7417,12 @@ class ManualApprovalStep(
             ]
         )
         pipeline.add_stage(prod,
-            pre=[pipelines.ManualApprovalStep("PromoteToProd")]
+            pre=[pipelines.ManualApprovalStep("PromoteToProd",
+                # All options below are optional
+                comment="Please validate changes",
+                review_url="https://my.webservice.com/",
+                notification_topic=topic
+            )]
         )
     '''
 
@@ -7335,15 +7431,23 @@ class ManualApprovalStep(
         id: builtins.str,
         *,
         comment: typing.Optional[builtins.str] = None,
+        notification_topic: typing.Optional[_ITopic_9eca4852] = None,
+        review_url: typing.Optional[builtins.str] = None,
     ) -> None:
         '''
         :param id: Identifier for this step.
         :param comment: The comment to display with this manual approval. Default: - No comment
+        :param notification_topic: Optional SNS topic to send notifications to when an approval is pending. Default: - No notifications
+        :param review_url: The URL for review associated with this manual approval. Default: - No URL
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__e1bf3ac4525b2831190c490c38deb9452f7e662bb66f5cb63ba43cdac1db0dc4)
             check_type(argname="argument id", value=id, expected_type=type_hints["id"])
-        props = ManualApprovalStepProps(comment=comment)
+        props = ManualApprovalStepProps(
+            comment=comment,
+            notification_topic=notification_topic,
+            review_url=review_url,
+        )
 
         jsii.create(self.__class__, self, [id, props])
 
@@ -7356,6 +7460,24 @@ class ManualApprovalStep(
         '''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "comment"))
 
+    @builtins.property
+    @jsii.member(jsii_name="notificationTopic")
+    def notification_topic(self) -> typing.Optional[_ITopic_9eca4852]:
+        '''Optional SNS topic to send notifications.
+
+        :default: - No notifications
+        '''
+        return typing.cast(typing.Optional[_ITopic_9eca4852], jsii.get(self, "notificationTopic"))
+
+    @builtins.property
+    @jsii.member(jsii_name="reviewUrl")
+    def review_url(self) -> typing.Optional[builtins.str]:
+        '''The URL for review associated with this manual approval.
+
+        :default: - No URL
+        '''
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "reviewUrl"))
+
 
 class ShellStep(
     Step,
@@ -7371,17 +7493,26 @@ class ShellStep(
 
     Example::
 
-        # code_pipeline: codepipeline.Pipeline
-        
+        # pipeline: pipelines.CodePipeline
         
-        source_artifact = codepipeline.Artifact("MySourceArtifact")
+        preprod = MyApplicationStage(self, "PreProd")
+        prod = MyApplicationStage(self, "Prod")
+        topic = sns.Topic(self, "ChangeApprovalTopic")
         
-        pipeline = pipelines.CodePipeline(self, "Pipeline",
-            code_pipeline=code_pipeline,
-            synth=pipelines.ShellStep("Synth",
-                input=pipelines.CodePipelineFileSet.from_artifact(source_artifact),
-                commands=["npm ci", "npm run build", "npx cdk synth"]
-            )
+        pipeline.add_stage(preprod,
+            post=[
+                pipelines.ShellStep("Validate Endpoint",
+                    commands=["curl -Ssf https://my.webservice.com/"]
+                )
+            ]
+        )
+        pipeline.add_stage(prod,
+            pre=[pipelines.ManualApprovalStep("PromoteToProd",
+                # All options below are optional
+                comment="Please validate changes",
+                review_url="https://my.webservice.com/",
+                notification_topic=topic
+            )]
         )
     '''
 
@@ -7968,6 +8099,7 @@ def _typecheckingstub__c46bc21ca63efb27c935c31017ebbc8c85b3b93ae1798e54892dd3eae
     synth: IFileSetProducer,
     artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
     asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
+    cdk_assets_cli_version: typing.Optional[builtins.str] = None,
     cli_version: typing.Optional[builtins.str] = None,
     code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     code_pipeline: typing.Optional[_Pipeline_ea38de84] = None,
@@ -8109,6 +8241,8 @@ def _typecheckingstub__99773084b7df122e2f7df8455d5966ec674016081ec53bbdb52b9a758
 def _typecheckingstub__5a0a42f985a6aa39b8db8606833d899bd8c93567a96ac5acb2c9407bde8793ed(
     *,
     comment: typing.Optional[builtins.str] = None,
+    notification_topic: typing.Optional[_ITopic_9eca4852] = None,
+    review_url: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -8433,6 +8567,7 @@ def _typecheckingstub__7b4b4a0bcbd5fab3e4b78aa07ff9504469ae96c16799604ca3345bcb9
     synth: IFileSetProducer,
     artifact_bucket: typing.Optional[_IBucket_42e086fd] = None,
     asset_publishing_code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
+    cdk_assets_cli_version: typing.Optional[builtins.str] = None,
     cli_version: typing.Optional[builtins.str] = None,
     code_build_defaults: typing.Optional[typing.Union[CodeBuildOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     code_pipeline: typing.Optional[_Pipeline_ea38de84] = None,
@@ -8592,6 +8727,8 @@ def _typecheckingstub__e1bf3ac4525b2831190c490c38deb9452f7e662bb66f5cb63ba43cdac
     id: builtins.str,
     *,
     comment: typing.Optional[builtins.str] = None,
+    notification_topic: typing.Optional[_ITopic_9eca4852] = None,
+    review_url: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass

aws_cdk/triggers/__init__.py

@@ -142,7 +142,11 @@ def check_type(argname: str, value: object, expected_type: typing.Any) -> typing
 from .._jsii import *
 
 import constructs as _constructs_77d1e7e8
-from .. import Duration as _Duration_4839e8c3, Size as _Size_7b441c34
+from .. import (
+    Duration as _Duration_4839e8c3,
+    RemovalPolicy as _RemovalPolicy_9f93c814,
+    Size as _Size_7b441c34,
+)
 from ..aws_codeguruprofiler import IProfilingGroup as _IProfilingGroup_0bba72c4
 from ..aws_ec2 import (
     ISecurityGroup as _ISecurityGroup_acf8a799,
@@ -445,6 +449,7 @@ class TriggerFunction(
         log_format: typing.Optional[builtins.str] = None,
         logging_format: typing.Optional[_LoggingFormat_30be8e01] = None,
         log_group: typing.Optional[_ILogGroup_3c4fa718] = None,
+        log_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
         log_retention: typing.Optional[_RetentionDays_070f99f0] = None,
         log_retention_retry_options: typing.Optional[typing.Union[_LogRetentionRetryOptions_ad797a7a, typing.Dict[builtins.str, typing.Any]]] = None,
         log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
@@ -504,7 +509,8 @@ class TriggerFunction(
         :param log_format: (deprecated) Sets the logFormat for the function. Default: "Text"
         :param logging_format: Sets the loggingFormat for the function. Default: LoggingFormat.TEXT
         :param log_group: The log group the function sends logs to. By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/<function name>. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention. Use the ``logGroup`` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. Default: ``/aws/lambda/${this.functionName}`` - default log group created by Lambda
-        :param log_retention: The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with ``logs.LogGroup`` and use the ``logGroup`` property to instruct the Lambda function to send logs to it. Migrating from ``logRetention`` to ``logGroup`` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct:: import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; Default: logs.RetentionDays.INFINITE
+        :param log_removal_policy: (deprecated) Determine the removal policy of the log group that is auto-created by this construct. Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs. Default: RemovalPolicy.Retain
+        :param log_retention: (deprecated) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with ``logs.LogGroup`` and use the ``logGroup`` property to instruct the Lambda function to send logs to it. Migrating from ``logRetention`` to ``logGroup`` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct:: import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; Default: logs.RetentionDays.INFINITE
         :param log_retention_retry_options: When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs. This is a legacy API and we strongly recommend you migrate to ``logGroup`` if you can. ``logGroup`` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. Default: - Default AWS SDK retry options.
         :param log_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This is a legacy API and we strongly recommend you migrate to ``logGroup`` if you can. ``logGroup`` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. Default: - A new role is created.
         :param memory_size: The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide. Default: 128
@@ -565,6 +571,7 @@ class TriggerFunction(
             log_format=log_format,
             logging_format=logging_format,
             log_group=log_group,
+            log_removal_policy=log_removal_policy,
             log_retention=log_retention,
             log_retention_retry_options=log_retention_retry_options,
             log_retention_role=log_retention_role,
@@ -938,6 +945,7 @@ class TriggerProps(TriggerOptions):
         "log_format": "logFormat",
         "logging_format": "loggingFormat",
         "log_group": "logGroup",
+        "log_removal_policy": "logRemovalPolicy",
         "log_retention": "logRetention",
         "log_retention_retry_options": "logRetentionRetryOptions",
         "log_retention_role": "logRetentionRole",
@@ -999,6 +1007,7 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
         log_format: typing.Optional[builtins.str] = None,
         logging_format: typing.Optional[_LoggingFormat_30be8e01] = None,
         log_group: typing.Optional[_ILogGroup_3c4fa718] = None,
+        log_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
         log_retention: typing.Optional[_RetentionDays_070f99f0] = None,
         log_retention_retry_options: typing.Optional[typing.Union[_LogRetentionRetryOptions_ad797a7a, typing.Dict[builtins.str, typing.Any]]] = None,
         log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
@@ -1057,7 +1066,8 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
         :param log_format: (deprecated) Sets the logFormat for the function. Default: "Text"
         :param logging_format: Sets the loggingFormat for the function. Default: LoggingFormat.TEXT
         :param log_group: The log group the function sends logs to. By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/<function name>. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention. Use the ``logGroup`` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. Default: ``/aws/lambda/${this.functionName}`` - default log group created by Lambda
-        :param log_retention: The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with ``logs.LogGroup`` and use the ``logGroup`` property to instruct the Lambda function to send logs to it. Migrating from ``logRetention`` to ``logGroup`` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct:: import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; Default: logs.RetentionDays.INFINITE
+        :param log_removal_policy: (deprecated) Determine the removal policy of the log group that is auto-created by this construct. Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs. Default: RemovalPolicy.Retain
+        :param log_retention: (deprecated) The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to ``INFINITE``. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with ``logs.LogGroup`` and use the ``logGroup`` property to instruct the Lambda function to send logs to it. Migrating from ``logRetention`` to ``logGroup`` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct:: import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; Default: logs.RetentionDays.INFINITE
         :param log_retention_retry_options: When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs. This is a legacy API and we strongly recommend you migrate to ``logGroup`` if you can. ``logGroup`` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. Default: - Default AWS SDK retry options.
         :param log_retention_role: The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This is a legacy API and we strongly recommend you migrate to ``logGroup`` if you can. ``logGroup`` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. Default: - A new role is created.
         :param memory_size: The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide. Default: 128
@@ -1136,6 +1146,7 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
             check_type(argname="argument log_format", value=log_format, expected_type=type_hints["log_format"])
             check_type(argname="argument logging_format", value=logging_format, expected_type=type_hints["logging_format"])
             check_type(argname="argument log_group", value=log_group, expected_type=type_hints["log_group"])
+            check_type(argname="argument log_removal_policy", value=log_removal_policy, expected_type=type_hints["log_removal_policy"])
             check_type(argname="argument log_retention", value=log_retention, expected_type=type_hints["log_retention"])
             check_type(argname="argument log_retention_retry_options", value=log_retention_retry_options, expected_type=type_hints["log_retention_retry_options"])
             check_type(argname="argument log_retention_role", value=log_retention_role, expected_type=type_hints["log_retention_role"])
@@ -1226,6 +1237,8 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
             self._values["logging_format"] = logging_format
         if log_group is not None:
             self._values["log_group"] = log_group
+        if log_removal_policy is not None:
+            self._values["log_removal_policy"] = log_removal_policy
         if log_retention is not None:
             self._values["log_retention"] = log_retention
         if log_retention_retry_options is not None:
@@ -1615,9 +1628,27 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
         result = self._values.get("log_group")
         return typing.cast(typing.Optional[_ILogGroup_3c4fa718], result)
 
+    @builtins.property
+    def log_removal_policy(self) -> typing.Optional[_RemovalPolicy_9f93c814]:
+        '''(deprecated) Determine the removal policy of the log group that is auto-created by this construct.
+
+        Normally you want to retain the log group so you can diagnose issues
+        from logs even after a deployment that no longer includes the log group.
+        In that case, use the normal date-based retention policy to age out your
+        logs.
+
+        :default: RemovalPolicy.Retain
+
+        :deprecated: use ``logGroup`` instead
+
+        :stability: deprecated
+        '''
+        result = self._values.get("log_removal_policy")
+        return typing.cast(typing.Optional[_RemovalPolicy_9f93c814], result)
+
     @builtins.property
     def log_retention(self) -> typing.Optional[_RetentionDays_070f99f0]:
-        '''The number of days log events are kept in CloudWatch Logs.
+        '''(deprecated) The number of days log events are kept in CloudWatch Logs.
 
         When updating
         this property, unsetting it doesn't remove the log retention policy. To
@@ -1638,6 +1669,10 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
            my_log_group.log_group_name
 
         :default: logs.RetentionDays.INFINITE
+
+        :deprecated: use ``logGroup`` instead
+
+        :stability: deprecated
         '''
         result = self._values.get("log_retention")
         return typing.cast(typing.Optional[_RetentionDays_070f99f0], result)
@@ -2053,6 +2088,7 @@ def _typecheckingstub__6f34c5ba084706d20d6ef37a7f59673b20ed3425ffc7035fc8ea888e9
     log_format: typing.Optional[builtins.str] = None,
     logging_format: typing.Optional[_LoggingFormat_30be8e01] = None,
     log_group: typing.Optional[_ILogGroup_3c4fa718] = None,
+    log_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
     log_retention: typing.Optional[_RetentionDays_070f99f0] = None,
     log_retention_retry_options: typing.Optional[typing.Union[_LogRetentionRetryOptions_ad797a7a, typing.Dict[builtins.str, typing.Any]]] = None,
     log_retention_role: typing.Optional[_IRole_235f5d8e] = None,
@@ -2145,6 +2181,7 @@ def _typecheckingstub__b2f4b009b0160d566d798bfa6d813ccc8440e1a9e0f75c99449184a2f
     log_format: typing.Optional[builtins.str] = None,
     logging_format: typing.Optional[_LoggingFormat_30be8e01] = None,
     log_group: typing.Optional[_ILogGroup_3c4fa718] = None,
+    log_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
     log_retention: typing.Optional[_RetentionDays_070f99f0] = None,
     log_retention_retry_options: typing.Optional[typing.Union[_LogRetentionRetryOptions_ad797a7a, typing.Dict[builtins.str, typing.Any]]] = None,
     log_retention_role: typing.Optional[_IRole_235f5d8e] = None,

{aws_cdk_lib-2.201.0.dist-info → aws_cdk_lib-2.203.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.201.0
+Version: 2.203.0
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services
@@ -20,9 +20,9 @@ Requires-Python: ~=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: aws-cdk.asset-awscli-v1==2.2.237
+Requires-Dist: aws-cdk.asset-awscli-v1==2.2.242
 Requires-Dist: aws-cdk.asset-node-proxy-agent-v6<3.0.0,>=2.1.0
-Requires-Dist: aws-cdk.cloud-assembly-schema<45.0.0,>=44.2.0
+Requires-Dist: aws-cdk.cloud-assembly-schema<45.0.0,>=44.8.0
 Requires-Dist: constructs<11.0.0,>=10.0.0
 Requires-Dist: jsii<2.0.0,>=1.112.0
 Requires-Dist: publication>=0.0.3