aws-cdk-lib 2.200.2__py3-none-any.whl → 2.224.0__py3-none-any.whl

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,
@@ -152,7 +156,6 @@ from ..aws_ec2 import (
 from ..aws_iam import (
     IRole as _IRole_235f5d8e, PolicyStatement as _PolicyStatement_0fe33853
 )
-from ..aws_kms import IKey as _IKey_5f11635f
 from ..aws_lambda import (
     AdotInstrumentationConfig as _AdotInstrumentationConfig_7c38d65d,
     ApplicationLogLevel as _ApplicationLogLevel_cd92660a,
@@ -161,7 +164,6 @@ from ..aws_lambda import (
     FileSystem as _FileSystem_a5fa005d,
     Function as _Function_244f85d8,
     FunctionProps as _FunctionProps_a308e854,
-    ICodeSigningConfig as _ICodeSigningConfig_edb41d1f,
     IDestination as _IDestination_40f19de4,
     IEventSource as _IEventSource_3686b3f8,
     ILayerVersion as _ILayerVersion_5ac127c8,
@@ -182,6 +184,10 @@ from ..aws_logs import (
 )
 from ..aws_sns import ITopic as _ITopic_9eca4852
 from ..aws_sqs import IQueue as _IQueue_7ed6f679
+from ..interfaces.aws_kms import IKeyRef as _IKeyRef_d4fc6ef3
+from ..interfaces.aws_lambda import (
+    ICodeSigningConfigRef as _ICodeSigningConfigRef_1d909622
+)
 
 
 @jsii.interface(jsii_type="aws-cdk-lib.triggers.ITrigger")
@@ -426,14 +432,14 @@ class TriggerFunction(
         application_log_level: typing.Optional[builtins.str] = None,
         application_log_level_v2: typing.Optional[_ApplicationLogLevel_cd92660a] = None,
         architecture: typing.Optional[_Architecture_12d5a53f] = None,
-        code_signing_config: typing.Optional[_ICodeSigningConfig_edb41d1f] = None,
+        code_signing_config: typing.Optional[_ICodeSigningConfigRef_1d909622] = None,
         current_version_options: typing.Optional[typing.Union[_VersionOptions_981bb3c0, typing.Dict[builtins.str, typing.Any]]] = None,
         dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
         dead_letter_queue_enabled: typing.Optional[builtins.bool] = None,
         dead_letter_topic: typing.Optional[_ITopic_9eca4852] = None,
         description: typing.Optional[builtins.str] = None,
         environment: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
-        environment_encryption: typing.Optional[_IKey_5f11635f] = None,
+        environment_encryption: typing.Optional[_IKeyRef_d4fc6ef3] = None,
         ephemeral_storage_size: typing.Optional[_Size_7b441c34] = None,
         events: typing.Optional[typing.Sequence[_IEventSource_3686b3f8]] = None,
         filesystem: typing.Optional[_FileSystem_a5fa005d] = None,
@@ -445,6 +451,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 +511,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 +573,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 +947,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",
@@ -980,14 +990,14 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
         application_log_level: typing.Optional[builtins.str] = None,
         application_log_level_v2: typing.Optional[_ApplicationLogLevel_cd92660a] = None,
         architecture: typing.Optional[_Architecture_12d5a53f] = None,
-        code_signing_config: typing.Optional[_ICodeSigningConfig_edb41d1f] = None,
+        code_signing_config: typing.Optional[_ICodeSigningConfigRef_1d909622] = None,
         current_version_options: typing.Optional[typing.Union[_VersionOptions_981bb3c0, typing.Dict[builtins.str, typing.Any]]] = None,
         dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
         dead_letter_queue_enabled: typing.Optional[builtins.bool] = None,
         dead_letter_topic: typing.Optional[_ITopic_9eca4852] = None,
         description: typing.Optional[builtins.str] = None,
         environment: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
-        environment_encryption: typing.Optional[_IKey_5f11635f] = None,
+        environment_encryption: typing.Optional[_IKeyRef_d4fc6ef3] = None,
         ephemeral_storage_size: typing.Optional[_Size_7b441c34] = None,
         events: typing.Optional[typing.Sequence[_IEventSource_3686b3f8]] = None,
         filesystem: typing.Optional[_FileSystem_a5fa005d] = None,
@@ -999,6 +1009,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 +1068,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 +1148,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 +1239,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:
@@ -1404,13 +1419,13 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
         return typing.cast(typing.Optional[_Architecture_12d5a53f], result)
 
     @builtins.property
-    def code_signing_config(self) -> typing.Optional[_ICodeSigningConfig_edb41d1f]:
+    def code_signing_config(self) -> typing.Optional[_ICodeSigningConfigRef_1d909622]:
         '''Code signing config associated with this function.
 
         :default: - Not Sign the Code
         '''
         result = self._values.get("code_signing_config")
-        return typing.cast(typing.Optional[_ICodeSigningConfig_edb41d1f], result)
+        return typing.cast(typing.Optional[_ICodeSigningConfigRef_1d909622], result)
 
     @builtins.property
     def current_version_options(self) -> typing.Optional[_VersionOptions_981bb3c0]:
@@ -1481,13 +1496,13 @@ class TriggerFunctionProps(_FunctionProps_a308e854, TriggerOptions):
         return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
 
     @builtins.property
-    def environment_encryption(self) -> typing.Optional[_IKey_5f11635f]:
+    def environment_encryption(self) -> typing.Optional[_IKeyRef_d4fc6ef3]:
         '''The AWS KMS key that's used to encrypt your function's environment variables.
 
         :default: - AWS Lambda creates and uses an AWS managed customer master key (CMK).
         '''
         result = self._values.get("environment_encryption")
-        return typing.cast(typing.Optional[_IKey_5f11635f], result)
+        return typing.cast(typing.Optional[_IKeyRef_d4fc6ef3], result)
 
     @builtins.property
     def ephemeral_storage_size(self) -> typing.Optional[_Size_7b441c34]:
@@ -1615,9 +1630,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 +1671,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)
@@ -2034,14 +2071,14 @@ def _typecheckingstub__6f34c5ba084706d20d6ef37a7f59673b20ed3425ffc7035fc8ea888e9
     application_log_level: typing.Optional[builtins.str] = None,
     application_log_level_v2: typing.Optional[_ApplicationLogLevel_cd92660a] = None,
     architecture: typing.Optional[_Architecture_12d5a53f] = None,
-    code_signing_config: typing.Optional[_ICodeSigningConfig_edb41d1f] = None,
+    code_signing_config: typing.Optional[_ICodeSigningConfigRef_1d909622] = None,
     current_version_options: typing.Optional[typing.Union[_VersionOptions_981bb3c0, typing.Dict[builtins.str, typing.Any]]] = None,
     dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
     dead_letter_queue_enabled: typing.Optional[builtins.bool] = None,
     dead_letter_topic: typing.Optional[_ITopic_9eca4852] = None,
     description: typing.Optional[builtins.str] = None,
     environment: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
-    environment_encryption: typing.Optional[_IKey_5f11635f] = None,
+    environment_encryption: typing.Optional[_IKeyRef_d4fc6ef3] = None,
     ephemeral_storage_size: typing.Optional[_Size_7b441c34] = None,
     events: typing.Optional[typing.Sequence[_IEventSource_3686b3f8]] = None,
     filesystem: typing.Optional[_FileSystem_a5fa005d] = None,
@@ -2053,6 +2090,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,
@@ -2126,14 +2164,14 @@ def _typecheckingstub__b2f4b009b0160d566d798bfa6d813ccc8440e1a9e0f75c99449184a2f
     application_log_level: typing.Optional[builtins.str] = None,
     application_log_level_v2: typing.Optional[_ApplicationLogLevel_cd92660a] = None,
     architecture: typing.Optional[_Architecture_12d5a53f] = None,
-    code_signing_config: typing.Optional[_ICodeSigningConfig_edb41d1f] = None,
+    code_signing_config: typing.Optional[_ICodeSigningConfigRef_1d909622] = None,
     current_version_options: typing.Optional[typing.Union[_VersionOptions_981bb3c0, typing.Dict[builtins.str, typing.Any]]] = None,
     dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
     dead_letter_queue_enabled: typing.Optional[builtins.bool] = None,
     dead_letter_topic: typing.Optional[_ITopic_9eca4852] = None,
     description: typing.Optional[builtins.str] = None,
     environment: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
-    environment_encryption: typing.Optional[_IKey_5f11635f] = None,
+    environment_encryption: typing.Optional[_IKeyRef_d4fc6ef3] = None,
     ephemeral_storage_size: typing.Optional[_Size_7b441c34] = None,
     events: typing.Optional[typing.Sequence[_IEventSource_3686b3f8]] = None,
     filesystem: typing.Optional[_FileSystem_a5fa005d] = None,
@@ -2145,6 +2183,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,
@@ -2173,3 +2212,6 @@ def _typecheckingstub__b2f4b009b0160d566d798bfa6d813ccc8440e1a9e0f75c99449184a2f
 ) -> None:
     """Type checking stubs"""
     pass
+
+for cls in [ITrigger]:
+    typing.cast(typing.Any, cls).__protocol_attrs__ = typing.cast(typing.Any, cls).__protocol_attrs__ - set(['__jsii_proxy_class__', '__jsii_type__'])