aws-cdk-lib 2.160.0__py3-none-any.whl → 2.161.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +21 -14
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.160.0.jsii.tgz → aws-cdk-lib@2.161.1.jsii.tgz} +0 -0
- aws_cdk/aws_apigatewayv2/__init__.py +13 -14
- aws_cdk/aws_autoscaling/__init__.py +2 -2
- aws_cdk/aws_b2bi/__init__.py +2283 -672
- aws_cdk/aws_batch/__init__.py +9 -5
- aws_cdk/aws_bedrock/__init__.py +52 -20
- aws_cdk/aws_cloudformation/__init__.py +9 -9
- aws_cdk/aws_cloudtrail/__init__.py +97 -183
- aws_cdk/aws_cloudwatch/__init__.py +38 -42
- aws_cdk/aws_datasync/__init__.py +1 -1
- aws_cdk/aws_ec2/__init__.py +114 -8
- aws_cdk/aws_ecs/__init__.py +513 -2
- aws_cdk/aws_eks/__init__.py +118 -2
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +5 -3
- aws_cdk/aws_glue/__init__.py +386 -0
- aws_cdk/aws_iotfleetwise/__init__.py +49 -49
- aws_cdk/aws_iottwinmaker/__init__.py +4 -4
- aws_cdk/aws_iotwireless/__init__.py +2 -1
- aws_cdk/aws_kinesisfirehose/__init__.py +52 -76
- aws_cdk/aws_lambda/__init__.py +383 -244
- aws_cdk/aws_logs/__init__.py +431 -3
- aws_cdk/aws_mediaconnect/__init__.py +6 -4
- aws_cdk/aws_medialive/__init__.py +36 -0
- aws_cdk/aws_organizations/__init__.py +4 -3
- aws_cdk/aws_pipes/__init__.py +2 -2
- aws_cdk/aws_quicksight/__init__.py +1086 -6
- aws_cdk/aws_rds/__init__.py +158 -3
- aws_cdk/aws_route53resolver/__init__.py +3 -17
- aws_cdk/aws_s3/__init__.py +20 -11
- aws_cdk/aws_s3_deployment/__init__.py +45 -0
- aws_cdk/aws_s3express/__init__.py +314 -4
- aws_cdk/aws_sagemaker/__init__.py +44 -4
- aws_cdk/aws_secretsmanager/__init__.py +14 -7
- aws_cdk/aws_securityhub/__init__.py +16 -14
- aws_cdk/aws_ses/__init__.py +52 -18
- aws_cdk/aws_sqs/__init__.py +16 -14
- aws_cdk/aws_ssm/__init__.py +6 -2
- aws_cdk/aws_synthetics/__init__.py +46 -0
- aws_cdk/aws_waf/__init__.py +33 -22
- aws_cdk/aws_wafregional/__init__.py +36 -24
- aws_cdk/aws_workspacesweb/__init__.py +54 -3
- aws_cdk/cloudformation_include/__init__.py +28 -0
- aws_cdk/cx_api/__init__.py +50 -0
- {aws_cdk_lib-2.160.0.dist-info → aws_cdk_lib-2.161.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.160.0.dist-info → aws_cdk_lib-2.161.1.dist-info}/RECORD +51 -51
- {aws_cdk_lib-2.160.0.dist-info → aws_cdk_lib-2.161.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.160.0.dist-info → aws_cdk_lib-2.161.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.160.0.dist-info → aws_cdk_lib-2.161.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.160.0.dist-info → aws_cdk_lib-2.161.1.dist-info}/top_level.txt +0 -0
aws_cdk/aws_lambda/__init__.py
CHANGED
|
@@ -3579,7 +3579,7 @@ class CfnCodeSigningConfig(
|
|
|
3579
3579
|
:param allowed_publishers: List of allowed publishers.
|
|
3580
3580
|
:param code_signing_policies: The code signing policy controls the validation failure action for signature mismatch or expiry.
|
|
3581
3581
|
:param description: Code signing configuration description.
|
|
3582
|
-
:param tags: A list of tags to
|
|
3582
|
+
:param tags: A list of tags to add to the code signing configuration. .. epigraph:: You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
3583
3583
|
'''
|
|
3584
3584
|
if __debug__:
|
|
3585
3585
|
type_hints = typing.get_type_hints(_typecheckingstub__df94ded3fb87e8ca56187dcab5a6bf12d335e2671120df0386f527f736b58b76)
|
|
@@ -3705,7 +3705,7 @@ class CfnCodeSigningConfig(
|
|
|
3705
3705
|
@builtins.property
|
|
3706
3706
|
@jsii.member(jsii_name="tags")
|
|
3707
3707
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
3708
|
-
'''A list of tags to
|
|
3708
|
+
'''A list of tags to add to the code signing configuration.'''
|
|
3709
3709
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
3710
3710
|
|
|
3711
3711
|
@tags.setter
|
|
@@ -3858,7 +3858,7 @@ class CfnCodeSigningConfigProps:
|
|
|
3858
3858
|
:param allowed_publishers: List of allowed publishers.
|
|
3859
3859
|
:param code_signing_policies: The code signing policy controls the validation failure action for signature mismatch or expiry.
|
|
3860
3860
|
:param description: Code signing configuration description.
|
|
3861
|
-
:param tags: A list of tags to
|
|
3861
|
+
:param tags: A list of tags to add to the code signing configuration. .. epigraph:: You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
3862
3862
|
|
|
3863
3863
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html
|
|
3864
3864
|
:exampleMetadata: fixture=_generated
|
|
@@ -3935,7 +3935,11 @@ class CfnCodeSigningConfigProps:
|
|
|
3935
3935
|
|
|
3936
3936
|
@builtins.property
|
|
3937
3937
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
3938
|
-
'''A list of tags to
|
|
3938
|
+
'''A list of tags to add to the code signing configuration.
|
|
3939
|
+
|
|
3940
|
+
.. epigraph::
|
|
3941
|
+
|
|
3942
|
+
You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
3939
3943
|
|
|
3940
3944
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-tags
|
|
3941
3945
|
'''
|
|
@@ -4593,31 +4597,31 @@ class CfnEventSourceMapping(
|
|
|
4593
4597
|
'''
|
|
4594
4598
|
:param scope: Scope in which this resource is defined.
|
|
4595
4599
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4596
|
-
:param function_name: The name of the Lambda function.
|
|
4597
|
-
:param amazon_managed_kafka_event_source_config: Specific configuration settings for an MSK event source.
|
|
4598
|
-
:param batch_size: The maximum number of
|
|
4599
|
-
:param bisect_batch_on_function_error: (Streams) If the function returns an error, split the batch in two and retry.
|
|
4600
|
-
:param destination_config: A configuration object that specifies the destination of an event after Lambda processes it.
|
|
4601
|
-
:param document_db_event_source_config:
|
|
4602
|
-
:param enabled:
|
|
4603
|
-
:param event_source_arn: The Amazon Resource Name (ARN) of the event source.
|
|
4604
|
-
:param filter_criteria:
|
|
4605
|
-
:param function_response_types: (Streams) A list of response
|
|
4606
|
-
:param kms_key_arn: The
|
|
4607
|
-
:param maximum_batching_window_in_seconds:
|
|
4608
|
-
:param maximum_record_age_in_seconds: (Streams) The maximum age
|
|
4609
|
-
:param maximum_retry_attempts: (Streams) The maximum number of
|
|
4610
|
-
:param parallelization_factor: (Streams) The number of batches to process from each shard
|
|
4611
|
-
:param queues: (
|
|
4612
|
-
:param scaling_config: The scaling configuration for the event source.
|
|
4613
|
-
:param self_managed_event_source: The
|
|
4614
|
-
:param self_managed_kafka_event_source_config: Specific configuration settings for a
|
|
4615
|
-
:param source_access_configurations:
|
|
4616
|
-
:param starting_position: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
|
|
4617
|
-
:param starting_position_timestamp: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
|
|
4618
|
-
:param tags:
|
|
4619
|
-
:param topics:
|
|
4620
|
-
:param tumbling_window_in_seconds: (Streams)
|
|
4600
|
+
:param function_name: The name or ARN of the Lambda function. **Name formats** - *Function name* – ``MyFunction`` . - *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction`` . - *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`` . - *Partial ARN* – ``123456789012:function:MyFunction`` . The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
|
|
4601
|
+
:param amazon_managed_kafka_event_source_config: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
|
4602
|
+
:param batch_size: The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). - *Amazon Kinesis* – Default 100. Max 10,000. - *Amazon DynamoDB Streams* – Default 100. Max 10,000. - *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. - *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. - *Self-managed Apache Kafka* – Default 100. Max 10,000. - *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. - *DocumentDB* – Default 100. Max 10,000.
|
|
4603
|
+
:param bisect_batch_on_function_error: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
|
|
4604
|
+
:param destination_config: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
|
|
4605
|
+
:param document_db_event_source_config: Specific configuration settings for a DocumentDB event source.
|
|
4606
|
+
:param enabled: When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
|
|
4607
|
+
:param event_source_arn: The Amazon Resource Name (ARN) of the event source. - *Amazon Kinesis* – The ARN of the data stream or a stream consumer. - *Amazon DynamoDB Streams* – The ARN of the stream. - *Amazon Simple Queue Service* – The ARN of the queue. - *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for `cross-account event source mappings <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc>`_ ). - *Amazon MQ* – The ARN of the broker. - *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
|
|
4608
|
+
:param filter_criteria: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see `Lambda event filtering <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html>`_ .
|
|
4609
|
+
:param function_response_types: (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping. Valid Values: ``ReportBatchItemFailures``
|
|
4610
|
+
:param kms_key_arn: The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's `filter criteria <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics>`_ .
|
|
4611
|
+
:param maximum_batching_window_in_seconds: The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. *Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0 *Default ( Amazon MSK , Kafka, Amazon MQ , Amazon DocumentDB event sources)* : 500 ms *Related setting:* For Amazon SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.
|
|
4612
|
+
:param maximum_record_age_in_seconds: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. .. epigraph:: The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
|
|
4613
|
+
:param maximum_retry_attempts: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
|
|
4614
|
+
:param parallelization_factor: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
|
|
4615
|
+
:param queues: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
|
|
4616
|
+
:param scaling_config: (Amazon SQS only) The scaling configuration for the event source. For more information, see `Configuring maximum concurrency for Amazon SQS event sources <https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency>`_ .
|
|
4617
|
+
:param self_managed_event_source: The self-managed Apache Kafka cluster for your event source.
|
|
4618
|
+
:param self_managed_kafka_event_source_config: Specific configuration settings for a self-managed Apache Kafka event source.
|
|
4619
|
+
:param source_access_configurations: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
|
|
4620
|
+
:param starting_position: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. - *LATEST* - Read only new records. - *TRIM_HORIZON* - Process all available records. - *AT_TIMESTAMP* - Specify a time from which to start reading records.
|
|
4621
|
+
:param starting_position_timestamp: With ``StartingPosition`` set to ``AT_TIMESTAMP`` , the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.
|
|
4622
|
+
:param tags: A list of tags to add to the event source mapping. .. epigraph:: You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
4623
|
+
:param topics: The name of the Kafka topic.
|
|
4624
|
+
:param tumbling_window_in_seconds: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
|
|
4621
4625
|
'''
|
|
4622
4626
|
if __debug__:
|
|
4623
4627
|
type_hints = typing.get_type_hints(_typecheckingstub__2fc9432254acf5a7dbe3c68dcedbda61de1f0e804a81d20ae79e04857b83d419)
|
|
@@ -4686,7 +4690,8 @@ class CfnEventSourceMapping(
|
|
|
4686
4690
|
@builtins.property
|
|
4687
4691
|
@jsii.member(jsii_name="attrEventSourceMappingArn")
|
|
4688
4692
|
def attr_event_source_mapping_arn(self) -> builtins.str:
|
|
4689
|
-
'''
|
|
4693
|
+
'''The Amazon Resource Name (ARN) of the event source mapping.
|
|
4694
|
+
|
|
4690
4695
|
:cloudformationAttribute: EventSourceMappingArn
|
|
4691
4696
|
'''
|
|
4692
4697
|
return typing.cast(builtins.str, jsii.get(self, "attrEventSourceMappingArn"))
|
|
@@ -4694,7 +4699,7 @@ class CfnEventSourceMapping(
|
|
|
4694
4699
|
@builtins.property
|
|
4695
4700
|
@jsii.member(jsii_name="attrId")
|
|
4696
4701
|
def attr_id(self) -> builtins.str:
|
|
4697
|
-
'''
|
|
4702
|
+
'''The event source mapping's ID.
|
|
4698
4703
|
|
|
4699
4704
|
:cloudformationAttribute: Id
|
|
4700
4705
|
'''
|
|
@@ -4714,7 +4719,7 @@ class CfnEventSourceMapping(
|
|
|
4714
4719
|
@builtins.property
|
|
4715
4720
|
@jsii.member(jsii_name="functionName")
|
|
4716
4721
|
def function_name(self) -> builtins.str:
|
|
4717
|
-
'''The name of the Lambda function.'''
|
|
4722
|
+
'''The name or ARN of the Lambda function.'''
|
|
4718
4723
|
return typing.cast(builtins.str, jsii.get(self, "functionName"))
|
|
4719
4724
|
|
|
4720
4725
|
@function_name.setter
|
|
@@ -4729,7 +4734,7 @@ class CfnEventSourceMapping(
|
|
|
4729
4734
|
def amazon_managed_kafka_event_source_config(
|
|
4730
4735
|
self,
|
|
4731
4736
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty"]]:
|
|
4732
|
-
'''Specific configuration settings for an MSK event source.'''
|
|
4737
|
+
'''Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.'''
|
|
4733
4738
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty"]], jsii.get(self, "amazonManagedKafkaEventSourceConfig"))
|
|
4734
4739
|
|
|
4735
4740
|
@amazon_managed_kafka_event_source_config.setter
|
|
@@ -4745,7 +4750,7 @@ class CfnEventSourceMapping(
|
|
|
4745
4750
|
@builtins.property
|
|
4746
4751
|
@jsii.member(jsii_name="batchSize")
|
|
4747
4752
|
def batch_size(self) -> typing.Optional[jsii.Number]:
|
|
4748
|
-
'''The maximum number of
|
|
4753
|
+
'''The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.'''
|
|
4749
4754
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "batchSize"))
|
|
4750
4755
|
|
|
4751
4756
|
@batch_size.setter
|
|
@@ -4760,7 +4765,7 @@ class CfnEventSourceMapping(
|
|
|
4760
4765
|
def bisect_batch_on_function_error(
|
|
4761
4766
|
self,
|
|
4762
4767
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4763
|
-
'''(Streams) If the function returns an error, split the batch in two and retry.'''
|
|
4768
|
+
'''(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.'''
|
|
4764
4769
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "bisectBatchOnFunctionError"))
|
|
4765
4770
|
|
|
4766
4771
|
@bisect_batch_on_function_error.setter
|
|
@@ -4778,7 +4783,7 @@ class CfnEventSourceMapping(
|
|
|
4778
4783
|
def destination_config(
|
|
4779
4784
|
self,
|
|
4780
4785
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.DestinationConfigProperty"]]:
|
|
4781
|
-
'''A configuration object that specifies the destination of an event after Lambda processes it.'''
|
|
4786
|
+
'''(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.'''
|
|
4782
4787
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.DestinationConfigProperty"]], jsii.get(self, "destinationConfig"))
|
|
4783
4788
|
|
|
4784
4789
|
@destination_config.setter
|
|
@@ -4796,7 +4801,7 @@ class CfnEventSourceMapping(
|
|
|
4796
4801
|
def document_db_event_source_config(
|
|
4797
4802
|
self,
|
|
4798
4803
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.DocumentDBEventSourceConfigProperty"]]:
|
|
4799
|
-
'''
|
|
4804
|
+
'''Specific configuration settings for a DocumentDB event source.'''
|
|
4800
4805
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.DocumentDBEventSourceConfigProperty"]], jsii.get(self, "documentDbEventSourceConfig"))
|
|
4801
4806
|
|
|
4802
4807
|
@document_db_event_source_config.setter
|
|
@@ -4814,7 +4819,10 @@ class CfnEventSourceMapping(
|
|
|
4814
4819
|
def enabled(
|
|
4815
4820
|
self,
|
|
4816
4821
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4817
|
-
'''
|
|
4822
|
+
'''When true, the event source mapping is active.
|
|
4823
|
+
|
|
4824
|
+
When false, Lambda pauses polling and invocation.
|
|
4825
|
+
'''
|
|
4818
4826
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "enabled"))
|
|
4819
4827
|
|
|
4820
4828
|
@enabled.setter
|
|
@@ -4845,7 +4853,7 @@ class CfnEventSourceMapping(
|
|
|
4845
4853
|
def filter_criteria(
|
|
4846
4854
|
self,
|
|
4847
4855
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.FilterCriteriaProperty"]]:
|
|
4848
|
-
'''
|
|
4856
|
+
'''An object that defines the filter criteria that determine whether Lambda should process an event.'''
|
|
4849
4857
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.FilterCriteriaProperty"]], jsii.get(self, "filterCriteria"))
|
|
4850
4858
|
|
|
4851
4859
|
@filter_criteria.setter
|
|
@@ -4861,7 +4869,7 @@ class CfnEventSourceMapping(
|
|
|
4861
4869
|
@builtins.property
|
|
4862
4870
|
@jsii.member(jsii_name="functionResponseTypes")
|
|
4863
4871
|
def function_response_types(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
4864
|
-
'''(Streams) A list of response
|
|
4872
|
+
'''(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.'''
|
|
4865
4873
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "functionResponseTypes"))
|
|
4866
4874
|
|
|
4867
4875
|
@function_response_types.setter
|
|
@@ -4877,7 +4885,7 @@ class CfnEventSourceMapping(
|
|
|
4877
4885
|
@builtins.property
|
|
4878
4886
|
@jsii.member(jsii_name="kmsKeyArn")
|
|
4879
4887
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
4880
|
-
'''The
|
|
4888
|
+
'''The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's `filter criteria <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics>`_ .'''
|
|
4881
4889
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kmsKeyArn"))
|
|
4882
4890
|
|
|
4883
4891
|
@kms_key_arn.setter
|
|
@@ -4890,7 +4898,7 @@ class CfnEventSourceMapping(
|
|
|
4890
4898
|
@builtins.property
|
|
4891
4899
|
@jsii.member(jsii_name="maximumBatchingWindowInSeconds")
|
|
4892
4900
|
def maximum_batching_window_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
4893
|
-
'''
|
|
4901
|
+
'''The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.'''
|
|
4894
4902
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "maximumBatchingWindowInSeconds"))
|
|
4895
4903
|
|
|
4896
4904
|
@maximum_batching_window_in_seconds.setter
|
|
@@ -4906,7 +4914,7 @@ class CfnEventSourceMapping(
|
|
|
4906
4914
|
@builtins.property
|
|
4907
4915
|
@jsii.member(jsii_name="maximumRecordAgeInSeconds")
|
|
4908
4916
|
def maximum_record_age_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
4909
|
-
'''(
|
|
4917
|
+
'''(Kinesis and DynamoDB Streams only) Discard records older than the specified age.'''
|
|
4910
4918
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "maximumRecordAgeInSeconds"))
|
|
4911
4919
|
|
|
4912
4920
|
@maximum_record_age_in_seconds.setter
|
|
@@ -4922,7 +4930,7 @@ class CfnEventSourceMapping(
|
|
|
4922
4930
|
@builtins.property
|
|
4923
4931
|
@jsii.member(jsii_name="maximumRetryAttempts")
|
|
4924
4932
|
def maximum_retry_attempts(self) -> typing.Optional[jsii.Number]:
|
|
4925
|
-
'''(
|
|
4933
|
+
'''(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.'''
|
|
4926
4934
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "maximumRetryAttempts"))
|
|
4927
4935
|
|
|
4928
4936
|
@maximum_retry_attempts.setter
|
|
@@ -4935,7 +4943,7 @@ class CfnEventSourceMapping(
|
|
|
4935
4943
|
@builtins.property
|
|
4936
4944
|
@jsii.member(jsii_name="parallelizationFactor")
|
|
4937
4945
|
def parallelization_factor(self) -> typing.Optional[jsii.Number]:
|
|
4938
|
-
'''(Streams) The number of batches to process from each shard
|
|
4946
|
+
'''(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.'''
|
|
4939
4947
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "parallelizationFactor"))
|
|
4940
4948
|
|
|
4941
4949
|
@parallelization_factor.setter
|
|
@@ -4948,7 +4956,7 @@ class CfnEventSourceMapping(
|
|
|
4948
4956
|
@builtins.property
|
|
4949
4957
|
@jsii.member(jsii_name="queues")
|
|
4950
4958
|
def queues(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
4951
|
-
'''(
|
|
4959
|
+
'''(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.'''
|
|
4952
4960
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "queues"))
|
|
4953
4961
|
|
|
4954
4962
|
@queues.setter
|
|
@@ -4963,7 +4971,7 @@ class CfnEventSourceMapping(
|
|
|
4963
4971
|
def scaling_config(
|
|
4964
4972
|
self,
|
|
4965
4973
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.ScalingConfigProperty"]]:
|
|
4966
|
-
'''The scaling configuration for the event source.'''
|
|
4974
|
+
'''(Amazon SQS only) The scaling configuration for the event source.'''
|
|
4967
4975
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.ScalingConfigProperty"]], jsii.get(self, "scalingConfig"))
|
|
4968
4976
|
|
|
4969
4977
|
@scaling_config.setter
|
|
@@ -4981,7 +4989,7 @@ class CfnEventSourceMapping(
|
|
|
4981
4989
|
def self_managed_event_source(
|
|
4982
4990
|
self,
|
|
4983
4991
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.SelfManagedEventSourceProperty"]]:
|
|
4984
|
-
'''The
|
|
4992
|
+
'''The self-managed Apache Kafka cluster for your event source.'''
|
|
4985
4993
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.SelfManagedEventSourceProperty"]], jsii.get(self, "selfManagedEventSource"))
|
|
4986
4994
|
|
|
4987
4995
|
@self_managed_event_source.setter
|
|
@@ -4999,7 +5007,7 @@ class CfnEventSourceMapping(
|
|
|
4999
5007
|
def self_managed_kafka_event_source_config(
|
|
5000
5008
|
self,
|
|
5001
5009
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty"]]:
|
|
5002
|
-
'''Specific configuration settings for a
|
|
5010
|
+
'''Specific configuration settings for a self-managed Apache Kafka event source.'''
|
|
5003
5011
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty"]], jsii.get(self, "selfManagedKafkaEventSourceConfig"))
|
|
5004
5012
|
|
|
5005
5013
|
@self_managed_kafka_event_source_config.setter
|
|
@@ -5017,7 +5025,7 @@ class CfnEventSourceMapping(
|
|
|
5017
5025
|
def source_access_configurations(
|
|
5018
5026
|
self,
|
|
5019
5027
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.SourceAccessConfigurationProperty"]]]]:
|
|
5020
|
-
'''
|
|
5028
|
+
'''An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.'''
|
|
5021
5029
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.SourceAccessConfigurationProperty"]]]], jsii.get(self, "sourceAccessConfigurations"))
|
|
5022
5030
|
|
|
5023
5031
|
@source_access_configurations.setter
|
|
@@ -5033,7 +5041,10 @@ class CfnEventSourceMapping(
|
|
|
5033
5041
|
@builtins.property
|
|
5034
5042
|
@jsii.member(jsii_name="startingPosition")
|
|
5035
5043
|
def starting_position(self) -> typing.Optional[builtins.str]:
|
|
5036
|
-
'''The position in a stream from which to start reading.
|
|
5044
|
+
'''The position in a stream from which to start reading.
|
|
5045
|
+
|
|
5046
|
+
Required for Amazon Kinesis and Amazon DynamoDB.
|
|
5047
|
+
'''
|
|
5037
5048
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "startingPosition"))
|
|
5038
5049
|
|
|
5039
5050
|
@starting_position.setter
|
|
@@ -5046,7 +5057,7 @@ class CfnEventSourceMapping(
|
|
|
5046
5057
|
@builtins.property
|
|
5047
5058
|
@jsii.member(jsii_name="startingPositionTimestamp")
|
|
5048
5059
|
def starting_position_timestamp(self) -> typing.Optional[jsii.Number]:
|
|
5049
|
-
'''With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.'''
|
|
5060
|
+
'''With ``StartingPosition`` set to ``AT_TIMESTAMP`` , the time from which to start reading, in Unix time seconds.'''
|
|
5050
5061
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "startingPositionTimestamp"))
|
|
5051
5062
|
|
|
5052
5063
|
@starting_position_timestamp.setter
|
|
@@ -5059,6 +5070,7 @@ class CfnEventSourceMapping(
|
|
|
5059
5070
|
@builtins.property
|
|
5060
5071
|
@jsii.member(jsii_name="tags")
|
|
5061
5072
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5073
|
+
'''A list of tags to add to the event source mapping.'''
|
|
5062
5074
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
5063
5075
|
|
|
5064
5076
|
@tags.setter
|
|
@@ -5071,7 +5083,7 @@ class CfnEventSourceMapping(
|
|
|
5071
5083
|
@builtins.property
|
|
5072
5084
|
@jsii.member(jsii_name="topics")
|
|
5073
5085
|
def topics(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5074
|
-
'''
|
|
5086
|
+
'''The name of the Kafka topic.'''
|
|
5075
5087
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "topics"))
|
|
5076
5088
|
|
|
5077
5089
|
@topics.setter
|
|
@@ -5084,7 +5096,7 @@ class CfnEventSourceMapping(
|
|
|
5084
5096
|
@builtins.property
|
|
5085
5097
|
@jsii.member(jsii_name="tumblingWindowInSeconds")
|
|
5086
5098
|
def tumbling_window_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
5087
|
-
'''(Streams)
|
|
5099
|
+
'''(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.'''
|
|
5088
5100
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "tumblingWindowInSeconds"))
|
|
5089
5101
|
|
|
5090
5102
|
@tumbling_window_in_seconds.setter
|
|
@@ -5105,9 +5117,9 @@ class CfnEventSourceMapping(
|
|
|
5105
5117
|
*,
|
|
5106
5118
|
consumer_group_id: typing.Optional[builtins.str] = None,
|
|
5107
5119
|
) -> None:
|
|
5108
|
-
'''Specific configuration settings for an MSK event source.
|
|
5120
|
+
'''Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
|
5109
5121
|
|
|
5110
|
-
:param consumer_group_id: The identifier for the Kafka
|
|
5122
|
+
:param consumer_group_id: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see `Customizable consumer group ID <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id>`_ .
|
|
5111
5123
|
|
|
5112
5124
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html
|
|
5113
5125
|
:exampleMetadata: fixture=_generated
|
|
@@ -5131,7 +5143,9 @@ class CfnEventSourceMapping(
|
|
|
5131
5143
|
|
|
5132
5144
|
@builtins.property
|
|
5133
5145
|
def consumer_group_id(self) -> typing.Optional[builtins.str]:
|
|
5134
|
-
'''The identifier for the Kafka
|
|
5146
|
+
'''The identifier for the Kafka consumer group to join.
|
|
5147
|
+
|
|
5148
|
+
The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see `Customizable consumer group ID <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id>`_ .
|
|
5135
5149
|
|
|
5136
5150
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig-consumergroupid
|
|
5137
5151
|
'''
|
|
@@ -5162,7 +5176,7 @@ class CfnEventSourceMapping(
|
|
|
5162
5176
|
) -> None:
|
|
5163
5177
|
'''A configuration object that specifies the destination of an event after Lambda processes it.
|
|
5164
5178
|
|
|
5165
|
-
:param on_failure:
|
|
5179
|
+
:param on_failure: The destination configuration for failed invocations.
|
|
5166
5180
|
|
|
5167
5181
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html
|
|
5168
5182
|
:exampleMetadata: fixture=_generated
|
|
@@ -5190,7 +5204,7 @@ class CfnEventSourceMapping(
|
|
|
5190
5204
|
def on_failure(
|
|
5191
5205
|
self,
|
|
5192
5206
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.OnFailureProperty"]]:
|
|
5193
|
-
'''
|
|
5207
|
+
'''The destination configuration for failed invocations.
|
|
5194
5208
|
|
|
5195
5209
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html#cfn-lambda-eventsourcemapping-destinationconfig-onfailure
|
|
5196
5210
|
'''
|
|
@@ -5225,11 +5239,11 @@ class CfnEventSourceMapping(
|
|
|
5225
5239
|
database_name: typing.Optional[builtins.str] = None,
|
|
5226
5240
|
full_document: typing.Optional[builtins.str] = None,
|
|
5227
5241
|
) -> None:
|
|
5228
|
-
'''
|
|
5242
|
+
'''Specific configuration settings for a DocumentDB event source.
|
|
5229
5243
|
|
|
5230
|
-
:param collection_name: The collection
|
|
5231
|
-
:param database_name: The database
|
|
5232
|
-
:param full_document:
|
|
5244
|
+
:param collection_name: The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections.
|
|
5245
|
+
:param database_name: The name of the database to consume within the DocumentDB cluster.
|
|
5246
|
+
:param full_document: Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.
|
|
5233
5247
|
|
|
5234
5248
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html
|
|
5235
5249
|
:exampleMetadata: fixture=_generated
|
|
@@ -5261,7 +5275,9 @@ class CfnEventSourceMapping(
|
|
|
5261
5275
|
|
|
5262
5276
|
@builtins.property
|
|
5263
5277
|
def collection_name(self) -> typing.Optional[builtins.str]:
|
|
5264
|
-
'''The collection
|
|
5278
|
+
'''The name of the collection to consume within the database.
|
|
5279
|
+
|
|
5280
|
+
If you do not specify a collection, Lambda consumes all collections.
|
|
5265
5281
|
|
|
5266
5282
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-collectionname
|
|
5267
5283
|
'''
|
|
@@ -5270,7 +5286,7 @@ class CfnEventSourceMapping(
|
|
|
5270
5286
|
|
|
5271
5287
|
@builtins.property
|
|
5272
5288
|
def database_name(self) -> typing.Optional[builtins.str]:
|
|
5273
|
-
'''The database
|
|
5289
|
+
'''The name of the database to consume within the DocumentDB cluster.
|
|
5274
5290
|
|
|
5275
5291
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-databasename
|
|
5276
5292
|
'''
|
|
@@ -5279,9 +5295,9 @@ class CfnEventSourceMapping(
|
|
|
5279
5295
|
|
|
5280
5296
|
@builtins.property
|
|
5281
5297
|
def full_document(self) -> typing.Optional[builtins.str]:
|
|
5282
|
-
'''
|
|
5298
|
+
'''Determines what DocumentDB sends to your event stream during document update operations.
|
|
5283
5299
|
|
|
5284
|
-
|
|
5300
|
+
If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes.
|
|
5285
5301
|
|
|
5286
5302
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-documentdbeventsourceconfig.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig-fulldocument
|
|
5287
5303
|
'''
|
|
@@ -5310,9 +5326,9 @@ class CfnEventSourceMapping(
|
|
|
5310
5326
|
*,
|
|
5311
5327
|
kafka_bootstrap_servers: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
5312
5328
|
) -> None:
|
|
5313
|
-
'''The
|
|
5329
|
+
'''The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]`` .
|
|
5314
5330
|
|
|
5315
|
-
:param kafka_bootstrap_servers:
|
|
5331
|
+
:param kafka_bootstrap_servers: The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]`` .
|
|
5316
5332
|
|
|
5317
5333
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-endpoints.html
|
|
5318
5334
|
:exampleMetadata: fixture=_generated
|
|
@@ -5336,7 +5352,7 @@ class CfnEventSourceMapping(
|
|
|
5336
5352
|
|
|
5337
5353
|
@builtins.property
|
|
5338
5354
|
def kafka_bootstrap_servers(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5339
|
-
'''
|
|
5355
|
+
'''The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]`` .
|
|
5340
5356
|
|
|
5341
5357
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-endpoints.html#cfn-lambda-eventsourcemapping-endpoints-kafkabootstrapservers
|
|
5342
5358
|
'''
|
|
@@ -5365,9 +5381,9 @@ class CfnEventSourceMapping(
|
|
|
5365
5381
|
*,
|
|
5366
5382
|
filters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnEventSourceMapping.FilterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
5367
5383
|
) -> None:
|
|
5368
|
-
'''
|
|
5384
|
+
'''An object that contains the filters for an event source.
|
|
5369
5385
|
|
|
5370
|
-
:param filters:
|
|
5386
|
+
:param filters: A list of filters.
|
|
5371
5387
|
|
|
5372
5388
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html
|
|
5373
5389
|
:exampleMetadata: fixture=_generated
|
|
@@ -5395,7 +5411,7 @@ class CfnEventSourceMapping(
|
|
|
5395
5411
|
def filters(
|
|
5396
5412
|
self,
|
|
5397
5413
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.FilterProperty"]]]]:
|
|
5398
|
-
'''
|
|
5414
|
+
'''A list of filters.
|
|
5399
5415
|
|
|
5400
5416
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html#cfn-lambda-eventsourcemapping-filtercriteria-filters
|
|
5401
5417
|
'''
|
|
@@ -5420,9 +5436,9 @@ class CfnEventSourceMapping(
|
|
|
5420
5436
|
)
|
|
5421
5437
|
class FilterProperty:
|
|
5422
5438
|
def __init__(self, *, pattern: typing.Optional[builtins.str] = None) -> None:
|
|
5423
|
-
'''
|
|
5439
|
+
'''A structure within a ``FilterCriteria`` object that defines an event filtering pattern.
|
|
5424
5440
|
|
|
5425
|
-
:param pattern:
|
|
5441
|
+
:param pattern: A filter pattern. For more information on the syntax of a filter pattern, see `Filter rule syntax <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax>`_ .
|
|
5426
5442
|
|
|
5427
5443
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filter.html
|
|
5428
5444
|
:exampleMetadata: fixture=_generated
|
|
@@ -5446,7 +5462,9 @@ class CfnEventSourceMapping(
|
|
|
5446
5462
|
|
|
5447
5463
|
@builtins.property
|
|
5448
5464
|
def pattern(self) -> typing.Optional[builtins.str]:
|
|
5449
|
-
'''
|
|
5465
|
+
'''A filter pattern.
|
|
5466
|
+
|
|
5467
|
+
For more information on the syntax of a filter pattern, see `Filter rule syntax <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax>`_ .
|
|
5450
5468
|
|
|
5451
5469
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filter.html#cfn-lambda-eventsourcemapping-filter-pattern
|
|
5452
5470
|
'''
|
|
@@ -5475,9 +5493,9 @@ class CfnEventSourceMapping(
|
|
|
5475
5493
|
*,
|
|
5476
5494
|
destination: typing.Optional[builtins.str] = None,
|
|
5477
5495
|
) -> None:
|
|
5478
|
-
'''A destination for
|
|
5496
|
+
'''A destination for events that failed processing.
|
|
5479
5497
|
|
|
5480
|
-
:param destination: The Amazon Resource Name (ARN) of the destination resource.
|
|
5498
|
+
:param destination: The Amazon Resource Name (ARN) of the destination resource. To retain records of `asynchronous invocations <https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations>`_ , you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination. To retain records of failed invocations from `Kinesis and DynamoDB event sources <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations>`_ , you can configure an Amazon SNS topic or Amazon SQS queue as the destination. To retain records of failed invocations from `self-managed Kafka <https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination>`_ or `Amazon MSK <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination>`_ , you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
|
|
5481
5499
|
|
|
5482
5500
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html
|
|
5483
5501
|
:exampleMetadata: fixture=_generated
|
|
@@ -5503,6 +5521,12 @@ class CfnEventSourceMapping(
|
|
|
5503
5521
|
def destination(self) -> typing.Optional[builtins.str]:
|
|
5504
5522
|
'''The Amazon Resource Name (ARN) of the destination resource.
|
|
5505
5523
|
|
|
5524
|
+
To retain records of `asynchronous invocations <https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations>`_ , you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, or Amazon EventBridge event bus as the destination.
|
|
5525
|
+
|
|
5526
|
+
To retain records of failed invocations from `Kinesis and DynamoDB event sources <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations>`_ , you can configure an Amazon SNS topic or Amazon SQS queue as the destination.
|
|
5527
|
+
|
|
5528
|
+
To retain records of failed invocations from `self-managed Kafka <https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination>`_ or `Amazon MSK <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination>`_ , you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.
|
|
5529
|
+
|
|
5506
5530
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html#cfn-lambda-eventsourcemapping-onfailure-destination
|
|
5507
5531
|
'''
|
|
5508
5532
|
result = self._values.get("destination")
|
|
@@ -5530,9 +5554,11 @@ class CfnEventSourceMapping(
|
|
|
5530
5554
|
*,
|
|
5531
5555
|
maximum_concurrency: typing.Optional[jsii.Number] = None,
|
|
5532
5556
|
) -> None:
|
|
5533
|
-
'''The scaling configuration for the event source.
|
|
5557
|
+
'''(Amazon SQS only) The scaling configuration for the event source.
|
|
5558
|
+
|
|
5559
|
+
To remove the configuration, pass an empty value.
|
|
5534
5560
|
|
|
5535
|
-
:param maximum_concurrency:
|
|
5561
|
+
:param maximum_concurrency: Limits the number of concurrent instances that the Amazon SQS event source can invoke.
|
|
5536
5562
|
|
|
5537
5563
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html
|
|
5538
5564
|
:exampleMetadata: fixture=_generated
|
|
@@ -5556,7 +5582,7 @@ class CfnEventSourceMapping(
|
|
|
5556
5582
|
|
|
5557
5583
|
@builtins.property
|
|
5558
5584
|
def maximum_concurrency(self) -> typing.Optional[jsii.Number]:
|
|
5559
|
-
'''
|
|
5585
|
+
'''Limits the number of concurrent instances that the Amazon SQS event source can invoke.
|
|
5560
5586
|
|
|
5561
5587
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html#cfn-lambda-eventsourcemapping-scalingconfig-maximumconcurrency
|
|
5562
5588
|
'''
|
|
@@ -5585,9 +5611,9 @@ class CfnEventSourceMapping(
|
|
|
5585
5611
|
*,
|
|
5586
5612
|
endpoints: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnEventSourceMapping.EndpointsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5587
5613
|
) -> None:
|
|
5588
|
-
'''The
|
|
5614
|
+
'''The self-managed Apache Kafka cluster for your event source.
|
|
5589
5615
|
|
|
5590
|
-
:param endpoints: The
|
|
5616
|
+
:param endpoints: The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]`` .
|
|
5591
5617
|
|
|
5592
5618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html
|
|
5593
5619
|
:exampleMetadata: fixture=_generated
|
|
@@ -5615,7 +5641,7 @@ class CfnEventSourceMapping(
|
|
|
5615
5641
|
def endpoints(
|
|
5616
5642
|
self,
|
|
5617
5643
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEventSourceMapping.EndpointsProperty"]]:
|
|
5618
|
-
'''The
|
|
5644
|
+
'''The list of bootstrap servers for your Kafka brokers in the following format: ``"KafkaBootstrapServers": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]`` .
|
|
5619
5645
|
|
|
5620
5646
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource-endpoints
|
|
5621
5647
|
'''
|
|
@@ -5644,9 +5670,9 @@ class CfnEventSourceMapping(
|
|
|
5644
5670
|
*,
|
|
5645
5671
|
consumer_group_id: typing.Optional[builtins.str] = None,
|
|
5646
5672
|
) -> None:
|
|
5647
|
-
'''Specific configuration settings for a
|
|
5673
|
+
'''Specific configuration settings for a self-managed Apache Kafka event source.
|
|
5648
5674
|
|
|
5649
|
-
:param consumer_group_id: The identifier for the Kafka
|
|
5675
|
+
:param consumer_group_id: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see `Customizable consumer group ID <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id>`_ .
|
|
5650
5676
|
|
|
5651
5677
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html
|
|
5652
5678
|
:exampleMetadata: fixture=_generated
|
|
@@ -5670,7 +5696,9 @@ class CfnEventSourceMapping(
|
|
|
5670
5696
|
|
|
5671
5697
|
@builtins.property
|
|
5672
5698
|
def consumer_group_id(self) -> typing.Optional[builtins.str]:
|
|
5673
|
-
'''The identifier for the Kafka
|
|
5699
|
+
'''The identifier for the Kafka consumer group to join.
|
|
5700
|
+
|
|
5701
|
+
The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see `Customizable consumer group ID <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id>`_ .
|
|
5674
5702
|
|
|
5675
5703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig-consumergroupid
|
|
5676
5704
|
'''
|
|
@@ -5700,10 +5728,10 @@ class CfnEventSourceMapping(
|
|
|
5700
5728
|
type: typing.Optional[builtins.str] = None,
|
|
5701
5729
|
uri: typing.Optional[builtins.str] = None,
|
|
5702
5730
|
) -> None:
|
|
5703
|
-
'''
|
|
5731
|
+
'''An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
|
|
5704
5732
|
|
|
5705
|
-
:param type: The type of source access
|
|
5706
|
-
:param uri: The
|
|
5733
|
+
:param type: The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``"Type":"SASL_SCRAM_512_AUTH"`` . - ``BASIC_AUTH`` – (Amazon MQ) The AWS Secrets Manager secret that stores your broker credentials. - ``BASIC_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers. - ``VPC_SUBNET`` – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster. - ``VPC_SECURITY_GROUP`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers. - ``SASL_SCRAM_256_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers. - ``SASL_SCRAM_512_AUTH`` – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers. - ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call. - ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers. - ``SERVER_ROOT_CA_CERTIFICATE`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
|
|
5734
|
+
:param uri: The value for your chosen configuration in ``Type`` . For example: ``"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"`` .
|
|
5707
5735
|
|
|
5708
5736
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html
|
|
5709
5737
|
:exampleMetadata: fixture=_generated
|
|
@@ -5731,7 +5759,17 @@ class CfnEventSourceMapping(
|
|
|
5731
5759
|
|
|
5732
5760
|
@builtins.property
|
|
5733
5761
|
def type(self) -> typing.Optional[builtins.str]:
|
|
5734
|
-
'''The type of source
|
|
5762
|
+
'''The type of authentication protocol, VPC components, or virtual host for your event source. For example: ``"Type":"SASL_SCRAM_512_AUTH"`` .
|
|
5763
|
+
|
|
5764
|
+
- ``BASIC_AUTH`` – (Amazon MQ) The AWS Secrets Manager secret that stores your broker credentials.
|
|
5765
|
+
- ``BASIC_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
|
|
5766
|
+
- ``VPC_SUBNET`` – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
|
|
5767
|
+
- ``VPC_SECURITY_GROUP`` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
|
|
5768
|
+
- ``SASL_SCRAM_256_AUTH`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
|
|
5769
|
+
- ``SASL_SCRAM_512_AUTH`` – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
|
|
5770
|
+
- ``VIRTUAL_HOST`` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
|
|
5771
|
+
- ``CLIENT_CERTIFICATE_TLS_AUTH`` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
|
|
5772
|
+
- ``SERVER_ROOT_CA_CERTIFICATE`` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
|
|
5735
5773
|
|
|
5736
5774
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-type
|
|
5737
5775
|
'''
|
|
@@ -5740,7 +5778,9 @@ class CfnEventSourceMapping(
|
|
|
5740
5778
|
|
|
5741
5779
|
@builtins.property
|
|
5742
5780
|
def uri(self) -> typing.Optional[builtins.str]:
|
|
5743
|
-
'''The
|
|
5781
|
+
'''The value for your chosen configuration in ``Type`` .
|
|
5782
|
+
|
|
5783
|
+
For example: ``"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"`` .
|
|
5744
5784
|
|
|
5745
5785
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-uri
|
|
5746
5786
|
'''
|
|
@@ -5822,31 +5862,31 @@ class CfnEventSourceMappingProps:
|
|
|
5822
5862
|
) -> None:
|
|
5823
5863
|
'''Properties for defining a ``CfnEventSourceMapping``.
|
|
5824
5864
|
|
|
5825
|
-
:param function_name: The name of the Lambda function.
|
|
5826
|
-
:param amazon_managed_kafka_event_source_config: Specific configuration settings for an MSK event source.
|
|
5827
|
-
:param batch_size: The maximum number of
|
|
5828
|
-
:param bisect_batch_on_function_error: (Streams) If the function returns an error, split the batch in two and retry.
|
|
5829
|
-
:param destination_config: A configuration object that specifies the destination of an event after Lambda processes it.
|
|
5830
|
-
:param document_db_event_source_config:
|
|
5831
|
-
:param enabled:
|
|
5832
|
-
:param event_source_arn: The Amazon Resource Name (ARN) of the event source.
|
|
5833
|
-
:param filter_criteria:
|
|
5834
|
-
:param function_response_types: (Streams) A list of response
|
|
5835
|
-
:param kms_key_arn: The
|
|
5836
|
-
:param maximum_batching_window_in_seconds:
|
|
5837
|
-
:param maximum_record_age_in_seconds: (Streams) The maximum age
|
|
5838
|
-
:param maximum_retry_attempts: (Streams) The maximum number of
|
|
5839
|
-
:param parallelization_factor: (Streams) The number of batches to process from each shard
|
|
5840
|
-
:param queues: (
|
|
5841
|
-
:param scaling_config: The scaling configuration for the event source.
|
|
5842
|
-
:param self_managed_event_source: The
|
|
5843
|
-
:param self_managed_kafka_event_source_config: Specific configuration settings for a
|
|
5844
|
-
:param source_access_configurations:
|
|
5845
|
-
:param starting_position: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB
|
|
5846
|
-
:param starting_position_timestamp: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
|
|
5847
|
-
:param tags:
|
|
5848
|
-
:param topics:
|
|
5849
|
-
:param tumbling_window_in_seconds: (Streams)
|
|
5865
|
+
:param function_name: The name or ARN of the Lambda function. **Name formats** - *Function name* – ``MyFunction`` . - *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction`` . - *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`` . - *Partial ARN* – ``123456789012:function:MyFunction`` . The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
|
|
5866
|
+
:param amazon_managed_kafka_event_source_config: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
|
5867
|
+
:param batch_size: The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). - *Amazon Kinesis* – Default 100. Max 10,000. - *Amazon DynamoDB Streams* – Default 100. Max 10,000. - *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. - *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000. - *Self-managed Apache Kafka* – Default 100. Max 10,000. - *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000. - *DocumentDB* – Default 100. Max 10,000.
|
|
5868
|
+
:param bisect_batch_on_function_error: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
|
|
5869
|
+
:param destination_config: (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
|
|
5870
|
+
:param document_db_event_source_config: Specific configuration settings for a DocumentDB event source.
|
|
5871
|
+
:param enabled: When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True
|
|
5872
|
+
:param event_source_arn: The Amazon Resource Name (ARN) of the event source. - *Amazon Kinesis* – The ARN of the data stream or a stream consumer. - *Amazon DynamoDB Streams* – The ARN of the stream. - *Amazon Simple Queue Service* – The ARN of the queue. - *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for `cross-account event source mappings <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc>`_ ). - *Amazon MQ* – The ARN of the broker. - *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
|
|
5873
|
+
:param filter_criteria: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see `Lambda event filtering <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html>`_ .
|
|
5874
|
+
:param function_response_types: (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping. Valid Values: ``ReportBatchItemFailures``
|
|
5875
|
+
:param kms_key_arn: The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's `filter criteria <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics>`_ .
|
|
5876
|
+
:param maximum_batching_window_in_seconds: The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. *Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0 *Default ( Amazon MSK , Kafka, Amazon MQ , Amazon DocumentDB event sources)* : 500 ms *Related setting:* For Amazon SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.
|
|
5877
|
+
:param maximum_record_age_in_seconds: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. .. epigraph:: The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
|
|
5878
|
+
:param maximum_retry_attempts: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
|
|
5879
|
+
:param parallelization_factor: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
|
|
5880
|
+
:param queues: (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
|
|
5881
|
+
:param scaling_config: (Amazon SQS only) The scaling configuration for the event source. For more information, see `Configuring maximum concurrency for Amazon SQS event sources <https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency>`_ .
|
|
5882
|
+
:param self_managed_event_source: The self-managed Apache Kafka cluster for your event source.
|
|
5883
|
+
:param self_managed_kafka_event_source_config: Specific configuration settings for a self-managed Apache Kafka event source.
|
|
5884
|
+
:param source_access_configurations: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
|
|
5885
|
+
:param starting_position: The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB. - *LATEST* - Read only new records. - *TRIM_HORIZON* - Process all available records. - *AT_TIMESTAMP* - Specify a time from which to start reading records.
|
|
5886
|
+
:param starting_position_timestamp: With ``StartingPosition`` set to ``AT_TIMESTAMP`` , the time from which to start reading, in Unix time seconds. ``StartingPositionTimestamp`` cannot be in the future.
|
|
5887
|
+
:param tags: A list of tags to add to the event source mapping. .. epigraph:: You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
5888
|
+
:param topics: The name of the Kafka topic.
|
|
5889
|
+
:param tumbling_window_in_seconds: (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
|
|
5850
5890
|
|
|
5851
5891
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html
|
|
5852
5892
|
:exampleMetadata: fixture=_generated
|
|
@@ -5996,7 +6036,15 @@ class CfnEventSourceMappingProps:
|
|
|
5996
6036
|
|
|
5997
6037
|
@builtins.property
|
|
5998
6038
|
def function_name(self) -> builtins.str:
|
|
5999
|
-
'''The name of the Lambda function.
|
|
6039
|
+
'''The name or ARN of the Lambda function.
|
|
6040
|
+
|
|
6041
|
+
**Name formats** - *Function name* – ``MyFunction`` .
|
|
6042
|
+
|
|
6043
|
+
- *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction`` .
|
|
6044
|
+
- *Version or Alias ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`` .
|
|
6045
|
+
- *Partial ARN* – ``123456789012:function:MyFunction`` .
|
|
6046
|
+
|
|
6047
|
+
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
|
|
6000
6048
|
|
|
6001
6049
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname
|
|
6002
6050
|
'''
|
|
@@ -6008,7 +6056,7 @@ class CfnEventSourceMappingProps:
|
|
|
6008
6056
|
def amazon_managed_kafka_event_source_config(
|
|
6009
6057
|
self,
|
|
6010
6058
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty]]:
|
|
6011
|
-
'''Specific configuration settings for an MSK event source.
|
|
6059
|
+
'''Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
|
6012
6060
|
|
|
6013
6061
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig
|
|
6014
6062
|
'''
|
|
@@ -6017,7 +6065,17 @@ class CfnEventSourceMappingProps:
|
|
|
6017
6065
|
|
|
6018
6066
|
@builtins.property
|
|
6019
6067
|
def batch_size(self) -> typing.Optional[jsii.Number]:
|
|
6020
|
-
'''The maximum number of
|
|
6068
|
+
'''The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
|
|
6069
|
+
|
|
6070
|
+
Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
|
|
6071
|
+
|
|
6072
|
+
- *Amazon Kinesis* – Default 100. Max 10,000.
|
|
6073
|
+
- *Amazon DynamoDB Streams* – Default 100. Max 10,000.
|
|
6074
|
+
- *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
|
|
6075
|
+
- *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.
|
|
6076
|
+
- *Self-managed Apache Kafka* – Default 100. Max 10,000.
|
|
6077
|
+
- *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.
|
|
6078
|
+
- *DocumentDB* – Default 100. Max 10,000.
|
|
6021
6079
|
|
|
6022
6080
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize
|
|
6023
6081
|
'''
|
|
@@ -6028,7 +6086,9 @@ class CfnEventSourceMappingProps:
|
|
|
6028
6086
|
def bisect_batch_on_function_error(
|
|
6029
6087
|
self,
|
|
6030
6088
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
6031
|
-
'''(Streams) If the function returns an error, split the batch in two and retry.
|
|
6089
|
+
'''(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
|
|
6090
|
+
|
|
6091
|
+
The default value is false.
|
|
6032
6092
|
|
|
6033
6093
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror
|
|
6034
6094
|
'''
|
|
@@ -6039,7 +6099,7 @@ class CfnEventSourceMappingProps:
|
|
|
6039
6099
|
def destination_config(
|
|
6040
6100
|
self,
|
|
6041
6101
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.DestinationConfigProperty]]:
|
|
6042
|
-
'''A configuration object that specifies the destination of an event after Lambda processes it.
|
|
6102
|
+
'''(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
|
|
6043
6103
|
|
|
6044
6104
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig
|
|
6045
6105
|
'''
|
|
@@ -6050,7 +6110,7 @@ class CfnEventSourceMappingProps:
|
|
|
6050
6110
|
def document_db_event_source_config(
|
|
6051
6111
|
self,
|
|
6052
6112
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.DocumentDBEventSourceConfigProperty]]:
|
|
6053
|
-
'''
|
|
6113
|
+
'''Specific configuration settings for a DocumentDB event source.
|
|
6054
6114
|
|
|
6055
6115
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig
|
|
6056
6116
|
'''
|
|
@@ -6061,7 +6121,9 @@ class CfnEventSourceMappingProps:
|
|
|
6061
6121
|
def enabled(
|
|
6062
6122
|
self,
|
|
6063
6123
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
6064
|
-
'''
|
|
6124
|
+
'''When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
|
|
6125
|
+
|
|
6126
|
+
Default: True
|
|
6065
6127
|
|
|
6066
6128
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled
|
|
6067
6129
|
'''
|
|
@@ -6072,6 +6134,13 @@ class CfnEventSourceMappingProps:
|
|
|
6072
6134
|
def event_source_arn(self) -> typing.Optional[builtins.str]:
|
|
6073
6135
|
'''The Amazon Resource Name (ARN) of the event source.
|
|
6074
6136
|
|
|
6137
|
+
- *Amazon Kinesis* – The ARN of the data stream or a stream consumer.
|
|
6138
|
+
- *Amazon DynamoDB Streams* – The ARN of the stream.
|
|
6139
|
+
- *Amazon Simple Queue Service* – The ARN of the queue.
|
|
6140
|
+
- *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster or the ARN of the VPC connection (for `cross-account event source mappings <https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc>`_ ).
|
|
6141
|
+
- *Amazon MQ* – The ARN of the broker.
|
|
6142
|
+
- *Amazon DocumentDB* – The ARN of the DocumentDB change stream.
|
|
6143
|
+
|
|
6075
6144
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn
|
|
6076
6145
|
'''
|
|
6077
6146
|
result = self._values.get("event_source_arn")
|
|
@@ -6081,7 +6150,9 @@ class CfnEventSourceMappingProps:
|
|
|
6081
6150
|
def filter_criteria(
|
|
6082
6151
|
self,
|
|
6083
6152
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.FilterCriteriaProperty]]:
|
|
6084
|
-
'''
|
|
6153
|
+
'''An object that defines the filter criteria that determine whether Lambda should process an event.
|
|
6154
|
+
|
|
6155
|
+
For more information, see `Lambda event filtering <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html>`_ .
|
|
6085
6156
|
|
|
6086
6157
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria
|
|
6087
6158
|
'''
|
|
@@ -6090,7 +6161,9 @@ class CfnEventSourceMappingProps:
|
|
|
6090
6161
|
|
|
6091
6162
|
@builtins.property
|
|
6092
6163
|
def function_response_types(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6093
|
-
'''(Streams) A list of response
|
|
6164
|
+
'''(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
|
|
6165
|
+
|
|
6166
|
+
Valid Values: ``ReportBatchItemFailures``
|
|
6094
6167
|
|
|
6095
6168
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes
|
|
6096
6169
|
'''
|
|
@@ -6099,7 +6172,7 @@ class CfnEventSourceMappingProps:
|
|
|
6099
6172
|
|
|
6100
6173
|
@builtins.property
|
|
6101
6174
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
6102
|
-
'''The
|
|
6175
|
+
'''The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's `filter criteria <https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics>`_ .
|
|
6103
6176
|
|
|
6104
6177
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn
|
|
6105
6178
|
'''
|
|
@@ -6108,7 +6181,13 @@ class CfnEventSourceMappingProps:
|
|
|
6108
6181
|
|
|
6109
6182
|
@builtins.property
|
|
6110
6183
|
def maximum_batching_window_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
6111
|
-
'''
|
|
6184
|
+
'''The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
|
|
6185
|
+
|
|
6186
|
+
*Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0
|
|
6187
|
+
|
|
6188
|
+
*Default ( Amazon MSK , Kafka, Amazon MQ , Amazon DocumentDB event sources)* : 500 ms
|
|
6189
|
+
|
|
6190
|
+
*Related setting:* For Amazon SQS event sources, when you set ``BatchSize`` to a value greater than 10, you must set ``MaximumBatchingWindowInSeconds`` to at least 1.
|
|
6112
6191
|
|
|
6113
6192
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds
|
|
6114
6193
|
'''
|
|
@@ -6117,7 +6196,13 @@ class CfnEventSourceMappingProps:
|
|
|
6117
6196
|
|
|
6118
6197
|
@builtins.property
|
|
6119
6198
|
def maximum_record_age_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
6120
|
-
'''(
|
|
6199
|
+
'''(Kinesis and DynamoDB Streams only) Discard records older than the specified age.
|
|
6200
|
+
|
|
6201
|
+
The default value is -1,
|
|
6202
|
+
which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
|
|
6203
|
+
.. epigraph::
|
|
6204
|
+
|
|
6205
|
+
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
|
|
6121
6206
|
|
|
6122
6207
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds
|
|
6123
6208
|
'''
|
|
@@ -6126,7 +6211,10 @@ class CfnEventSourceMappingProps:
|
|
|
6126
6211
|
|
|
6127
6212
|
@builtins.property
|
|
6128
6213
|
def maximum_retry_attempts(self) -> typing.Optional[jsii.Number]:
|
|
6129
|
-
'''(
|
|
6214
|
+
'''(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
|
|
6215
|
+
|
|
6216
|
+
The default value is -1,
|
|
6217
|
+
which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
|
|
6130
6218
|
|
|
6131
6219
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts
|
|
6132
6220
|
'''
|
|
@@ -6135,7 +6223,9 @@ class CfnEventSourceMappingProps:
|
|
|
6135
6223
|
|
|
6136
6224
|
@builtins.property
|
|
6137
6225
|
def parallelization_factor(self) -> typing.Optional[jsii.Number]:
|
|
6138
|
-
'''(Streams) The number of batches to process from each shard
|
|
6226
|
+
'''(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.
|
|
6227
|
+
|
|
6228
|
+
The default value is 1.
|
|
6139
6229
|
|
|
6140
6230
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor
|
|
6141
6231
|
'''
|
|
@@ -6144,7 +6234,7 @@ class CfnEventSourceMappingProps:
|
|
|
6144
6234
|
|
|
6145
6235
|
@builtins.property
|
|
6146
6236
|
def queues(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6147
|
-
'''(
|
|
6237
|
+
'''(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
|
|
6148
6238
|
|
|
6149
6239
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues
|
|
6150
6240
|
'''
|
|
@@ -6155,7 +6245,9 @@ class CfnEventSourceMappingProps:
|
|
|
6155
6245
|
def scaling_config(
|
|
6156
6246
|
self,
|
|
6157
6247
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.ScalingConfigProperty]]:
|
|
6158
|
-
'''The scaling configuration for the event source.
|
|
6248
|
+
'''(Amazon SQS only) The scaling configuration for the event source.
|
|
6249
|
+
|
|
6250
|
+
For more information, see `Configuring maximum concurrency for Amazon SQS event sources <https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency>`_ .
|
|
6159
6251
|
|
|
6160
6252
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig
|
|
6161
6253
|
'''
|
|
@@ -6166,7 +6258,7 @@ class CfnEventSourceMappingProps:
|
|
|
6166
6258
|
def self_managed_event_source(
|
|
6167
6259
|
self,
|
|
6168
6260
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.SelfManagedEventSourceProperty]]:
|
|
6169
|
-
'''The
|
|
6261
|
+
'''The self-managed Apache Kafka cluster for your event source.
|
|
6170
6262
|
|
|
6171
6263
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource
|
|
6172
6264
|
'''
|
|
@@ -6177,7 +6269,7 @@ class CfnEventSourceMappingProps:
|
|
|
6177
6269
|
def self_managed_kafka_event_source_config(
|
|
6178
6270
|
self,
|
|
6179
6271
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty]]:
|
|
6180
|
-
'''Specific configuration settings for a
|
|
6272
|
+
'''Specific configuration settings for a self-managed Apache Kafka event source.
|
|
6181
6273
|
|
|
6182
6274
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig
|
|
6183
6275
|
'''
|
|
@@ -6188,7 +6280,7 @@ class CfnEventSourceMappingProps:
|
|
|
6188
6280
|
def source_access_configurations(
|
|
6189
6281
|
self,
|
|
6190
6282
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnEventSourceMapping.SourceAccessConfigurationProperty]]]]:
|
|
6191
|
-
'''
|
|
6283
|
+
'''An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
|
|
6192
6284
|
|
|
6193
6285
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations
|
|
6194
6286
|
'''
|
|
@@ -6197,9 +6289,11 @@ class CfnEventSourceMappingProps:
|
|
|
6197
6289
|
|
|
6198
6290
|
@builtins.property
|
|
6199
6291
|
def starting_position(self) -> typing.Optional[builtins.str]:
|
|
6200
|
-
'''The position in a stream from which to start reading.
|
|
6292
|
+
'''The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.
|
|
6201
6293
|
|
|
6202
|
-
|
|
6294
|
+
- *LATEST* - Read only new records.
|
|
6295
|
+
- *TRIM_HORIZON* - Process all available records.
|
|
6296
|
+
- *AT_TIMESTAMP* - Specify a time from which to start reading records.
|
|
6203
6297
|
|
|
6204
6298
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition
|
|
6205
6299
|
'''
|
|
@@ -6208,7 +6302,9 @@ class CfnEventSourceMappingProps:
|
|
|
6208
6302
|
|
|
6209
6303
|
@builtins.property
|
|
6210
6304
|
def starting_position_timestamp(self) -> typing.Optional[jsii.Number]:
|
|
6211
|
-
'''With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
|
|
6305
|
+
'''With ``StartingPosition`` set to ``AT_TIMESTAMP`` , the time from which to start reading, in Unix time seconds.
|
|
6306
|
+
|
|
6307
|
+
``StartingPositionTimestamp`` cannot be in the future.
|
|
6212
6308
|
|
|
6213
6309
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp
|
|
6214
6310
|
'''
|
|
@@ -6217,7 +6313,12 @@ class CfnEventSourceMappingProps:
|
|
|
6217
6313
|
|
|
6218
6314
|
@builtins.property
|
|
6219
6315
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
6220
|
-
'''
|
|
6316
|
+
'''A list of tags to add to the event source mapping.
|
|
6317
|
+
|
|
6318
|
+
.. epigraph::
|
|
6319
|
+
|
|
6320
|
+
You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
6321
|
+
|
|
6221
6322
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tags
|
|
6222
6323
|
'''
|
|
6223
6324
|
result = self._values.get("tags")
|
|
@@ -6225,7 +6326,7 @@ class CfnEventSourceMappingProps:
|
|
|
6225
6326
|
|
|
6226
6327
|
@builtins.property
|
|
6227
6328
|
def topics(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6228
|
-
'''
|
|
6329
|
+
'''The name of the Kafka topic.
|
|
6229
6330
|
|
|
6230
6331
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics
|
|
6231
6332
|
'''
|
|
@@ -6234,7 +6335,9 @@ class CfnEventSourceMappingProps:
|
|
|
6234
6335
|
|
|
6235
6336
|
@builtins.property
|
|
6236
6337
|
def tumbling_window_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
6237
|
-
'''(Streams)
|
|
6338
|
+
'''(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.
|
|
6339
|
+
|
|
6340
|
+
A value of 0 seconds indicates no tumbling window.
|
|
6238
6341
|
|
|
6239
6342
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds
|
|
6240
6343
|
'''
|
|
@@ -6395,32 +6498,32 @@ class CfnFunction(
|
|
|
6395
6498
|
'''
|
|
6396
6499
|
:param scope: Scope in which this resource is defined.
|
|
6397
6500
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6398
|
-
:param code: The
|
|
6501
|
+
:param code: The code for the function. You can define your function code in multiple ways:. - For .zip deployment packages, you can specify the Amazon S3 location of the .zip file in the ``S3Bucket`` , ``S3Key`` , and ``S3ObjectVersion`` properties. - For .zip deployment packages, you can alternatively define the function code inline in the ``ZipFile`` property. This method works only for Node.js and Python functions. - For container images, specify the URI of your container image in the Amazon ECR registry in the ``ImageUri`` property.
|
|
6399
6502
|
:param role: The Amazon Resource Name (ARN) of the function's execution role.
|
|
6400
|
-
:param architectures: The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64
|
|
6503
|
+
:param architectures: The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64`` .
|
|
6401
6504
|
:param code_signing_config_arn: To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
|
|
6402
|
-
:param dead_letter_config:
|
|
6505
|
+
:param dead_letter_config: A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see `Dead-letter queues <https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq>`_ .
|
|
6403
6506
|
:param description: A description of the function.
|
|
6404
|
-
:param environment:
|
|
6507
|
+
:param environment: Environment variables that are accessible from function code during execution.
|
|
6405
6508
|
:param ephemeral_storage: The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
|
|
6406
|
-
:param file_system_configs: Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an `AWS::EFS::MountTarget <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html>`_ resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see `DependsOn Attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html>`_.
|
|
6407
|
-
:param function_name: The name of the Lambda function, up to 64 characters in length. If you don't specify a name,
|
|
6408
|
-
:param handler: The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see `Lambda programming model <https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html>`_.
|
|
6409
|
-
:param image_config: Configuration values that override the container image Dockerfile settings. For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_.
|
|
6410
|
-
:param kms_key_arn: The ARN of the
|
|
6509
|
+
:param file_system_configs: Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an `AWS::EFS::MountTarget <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html>`_ resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see `DependsOn Attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html>`_ .
|
|
6510
|
+
:param function_name: The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
6511
|
+
:param handler: The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see `Lambda programming model <https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html>`_ .
|
|
6512
|
+
:param image_config: Configuration values that override the container image Dockerfile settings. For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_ .
|
|
6513
|
+
:param kms_key_arn: The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's `environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption>`_ . When `Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html>`_ is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry ( Amazon ECR ). If you don't provide a customer managed key, Lambda uses a default service key.
|
|
6411
6514
|
:param layers: A list of `function layers <https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html>`_ to add to the function's execution environment. Specify each layer by its ARN, including the version.
|
|
6412
6515
|
:param logging_config: The function's Amazon CloudWatch Logs configuration settings.
|
|
6413
6516
|
:param memory_size: The amount of `memory available to the function <https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console>`_ at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
|
|
6414
6517
|
:param package_type: The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
|
|
6415
|
-
:param recursive_loop:
|
|
6518
|
+
:param recursive_loop: The status of your function's recursive loop detection configuration. When this value is set to ``Allow`` and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action. When this value is set to ``Terminate`` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
|
|
6416
6519
|
:param reserved_concurrent_executions: The number of simultaneous executions to reserve for the function.
|
|
6417
|
-
:param runtime: The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see `Runtime use after deprecation <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels>`_. For a list of all currently supported runtimes, see `Supported runtimes <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported>`_.
|
|
6418
|
-
:param runtime_management_config: Sets the runtime management configuration for a function's version. For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_.
|
|
6419
|
-
:param snap_start: The function's `SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
6420
|
-
:param tags: A list of `tags <https://docs.aws.amazon.com/lambda/latest/dg/tagging.html>`_ to apply to the function.
|
|
6421
|
-
:param timeout: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see `Lambda execution environment <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html>`_.
|
|
6422
|
-
:param tracing_config:
|
|
6423
|
-
:param vpc_config:
|
|
6520
|
+
:param runtime: The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_ . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see `Runtime use after deprecation <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels>`_ . For a list of all currently supported runtimes, see `Supported runtimes <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported>`_ .
|
|
6521
|
+
:param runtime_management_config: Sets the runtime management configuration for a function's version. For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_ .
|
|
6522
|
+
:param snap_start: The function's `AWS Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
6523
|
+
:param tags: A list of `tags <https://docs.aws.amazon.com/lambda/latest/dg/tagging.html>`_ to apply to the function. .. epigraph:: You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
6524
|
+
:param timeout: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see `Lambda execution environment <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html>`_ .
|
|
6525
|
+
:param tracing_config: Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with `X-Ray <https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html>`_ .
|
|
6526
|
+
:param vpc_config: For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see `Configuring a Lambda function to access resources in a VPC <https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html>`_ .
|
|
6424
6527
|
'''
|
|
6425
6528
|
if __debug__:
|
|
6426
6529
|
type_hints = typing.get_type_hints(_typecheckingstub__d971f3872acf20816e6da364ff9e6bec83fe2e68bbb9a7debc845b40036ee553)
|
|
@@ -6490,7 +6593,8 @@ class CfnFunction(
|
|
|
6490
6593
|
@builtins.property
|
|
6491
6594
|
@jsii.member(jsii_name="attrArn")
|
|
6492
6595
|
def attr_arn(self) -> builtins.str:
|
|
6493
|
-
'''
|
|
6596
|
+
'''The Amazon Resource Name (ARN) of the function.
|
|
6597
|
+
|
|
6494
6598
|
:cloudformationAttribute: Arn
|
|
6495
6599
|
'''
|
|
6496
6600
|
return typing.cast(builtins.str, jsii.get(self, "attrArn"))
|
|
@@ -6536,7 +6640,10 @@ class CfnFunction(
|
|
|
6536
6640
|
@builtins.property
|
|
6537
6641
|
@jsii.member(jsii_name="code")
|
|
6538
6642
|
def code(self) -> typing.Union[_IResolvable_da3f097b, "CfnFunction.CodeProperty"]:
|
|
6539
|
-
'''The
|
|
6643
|
+
'''The code for the function.
|
|
6644
|
+
|
|
6645
|
+
You can define your function code in multiple ways:.
|
|
6646
|
+
'''
|
|
6540
6647
|
return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnFunction.CodeProperty"], jsii.get(self, "code"))
|
|
6541
6648
|
|
|
6542
6649
|
@code.setter
|
|
@@ -6593,7 +6700,7 @@ class CfnFunction(
|
|
|
6593
6700
|
def dead_letter_config(
|
|
6594
6701
|
self,
|
|
6595
6702
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.DeadLetterConfigProperty"]]:
|
|
6596
|
-
'''
|
|
6703
|
+
'''A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.'''
|
|
6597
6704
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.DeadLetterConfigProperty"]], jsii.get(self, "deadLetterConfig"))
|
|
6598
6705
|
|
|
6599
6706
|
@dead_letter_config.setter
|
|
@@ -6624,7 +6731,7 @@ class CfnFunction(
|
|
|
6624
6731
|
def environment(
|
|
6625
6732
|
self,
|
|
6626
6733
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.EnvironmentProperty"]]:
|
|
6627
|
-
'''
|
|
6734
|
+
'''Environment variables that are accessible from function code during execution.'''
|
|
6628
6735
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.EnvironmentProperty"]], jsii.get(self, "environment"))
|
|
6629
6736
|
|
|
6630
6737
|
@environment.setter
|
|
@@ -6720,7 +6827,7 @@ class CfnFunction(
|
|
|
6720
6827
|
@builtins.property
|
|
6721
6828
|
@jsii.member(jsii_name="kmsKeyArn")
|
|
6722
6829
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
6723
|
-
'''The ARN of the
|
|
6830
|
+
'''The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's `environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption>`_ . When `Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html>`_ is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry ( Amazon ECR ). If you don't provide a customer managed key, Lambda uses a default service key.'''
|
|
6724
6831
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kmsKeyArn"))
|
|
6725
6832
|
|
|
6726
6833
|
@kms_key_arn.setter
|
|
@@ -6790,7 +6897,7 @@ class CfnFunction(
|
|
|
6790
6897
|
@builtins.property
|
|
6791
6898
|
@jsii.member(jsii_name="recursiveLoop")
|
|
6792
6899
|
def recursive_loop(self) -> typing.Optional[builtins.str]:
|
|
6793
|
-
'''
|
|
6900
|
+
'''The status of your function's recursive loop detection configuration.'''
|
|
6794
6901
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "recursiveLoop"))
|
|
6795
6902
|
|
|
6796
6903
|
@recursive_loop.setter
|
|
@@ -6819,7 +6926,7 @@ class CfnFunction(
|
|
|
6819
6926
|
@builtins.property
|
|
6820
6927
|
@jsii.member(jsii_name="runtime")
|
|
6821
6928
|
def runtime(self) -> typing.Optional[builtins.str]:
|
|
6822
|
-
'''The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
|
|
6929
|
+
'''The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_ . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.'''
|
|
6823
6930
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "runtime"))
|
|
6824
6931
|
|
|
6825
6932
|
@runtime.setter
|
|
@@ -6852,7 +6959,7 @@ class CfnFunction(
|
|
|
6852
6959
|
def snap_start(
|
|
6853
6960
|
self,
|
|
6854
6961
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.SnapStartProperty"]]:
|
|
6855
|
-
'''The function's `SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.'''
|
|
6962
|
+
'''The function's `AWS Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.'''
|
|
6856
6963
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.SnapStartProperty"]], jsii.get(self, "snapStart"))
|
|
6857
6964
|
|
|
6858
6965
|
@snap_start.setter
|
|
@@ -6896,7 +7003,7 @@ class CfnFunction(
|
|
|
6896
7003
|
def tracing_config(
|
|
6897
7004
|
self,
|
|
6898
7005
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.TracingConfigProperty"]]:
|
|
6899
|
-
'''
|
|
7006
|
+
'''Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with `X-Ray <https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html>`_ .'''
|
|
6900
7007
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.TracingConfigProperty"]], jsii.get(self, "tracingConfig"))
|
|
6901
7008
|
|
|
6902
7009
|
@tracing_config.setter
|
|
@@ -6914,7 +7021,7 @@ class CfnFunction(
|
|
|
6914
7021
|
def vpc_config(
|
|
6915
7022
|
self,
|
|
6916
7023
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.VpcConfigProperty"]]:
|
|
6917
|
-
'''
|
|
7024
|
+
'''For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.'''
|
|
6918
7025
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFunction.VpcConfigProperty"]], jsii.get(self, "vpcConfig"))
|
|
6919
7026
|
|
|
6920
7027
|
@vpc_config.setter
|
|
@@ -6950,14 +7057,16 @@ class CfnFunction(
|
|
|
6950
7057
|
source_kms_key_arn: typing.Optional[builtins.str] = None,
|
|
6951
7058
|
zip_file: typing.Optional[builtins.str] = None,
|
|
6952
7059
|
) -> None:
|
|
6953
|
-
'''The `deployment package <https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html>`_ for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.
|
|
7060
|
+
'''The `deployment package <https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html>`_ for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.
|
|
7061
|
+
|
|
7062
|
+
Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.
|
|
6954
7063
|
|
|
6955
7064
|
:param image_uri: URI of a `container image <https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html>`_ in the Amazon ECR registry.
|
|
6956
|
-
:param s3_bucket: An Amazon S3 bucket in the same AWS
|
|
7065
|
+
:param s3_bucket: An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account .
|
|
6957
7066
|
:param s3_key: The Amazon S3 key of the deployment package.
|
|
6958
7067
|
:param s3_object_version: For versioned objects, the version of the deployment package object to use.
|
|
6959
7068
|
:param source_kms_key_arn:
|
|
6960
|
-
:param zip_file: (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter,
|
|
7069
|
+
:param zip_file: (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named ``index`` and zips it to create a `deployment package <https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html>`_ . This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index`` . For example, ``index.handler`` . For JSON, you must escape quotes and special characters such as newline ( ``\\n`` ) with a backslash. If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ( `cfn-response <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html>`_ ) that simplifies sending responses. See `Using AWS Lambda with AWS CloudFormation <https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html>`_ for details.
|
|
6961
7070
|
|
|
6962
7071
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html
|
|
6963
7072
|
:exampleMetadata: fixture=_generated
|
|
@@ -7010,9 +7119,9 @@ class CfnFunction(
|
|
|
7010
7119
|
|
|
7011
7120
|
@builtins.property
|
|
7012
7121
|
def s3_bucket(self) -> typing.Optional[builtins.str]:
|
|
7013
|
-
'''An Amazon S3 bucket in the same AWS
|
|
7122
|
+
'''An Amazon S3 bucket in the same AWS Region as your function.
|
|
7014
7123
|
|
|
7015
|
-
The bucket can be in a different AWS
|
|
7124
|
+
The bucket can be in a different AWS account .
|
|
7016
7125
|
|
|
7017
7126
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket
|
|
7018
7127
|
'''
|
|
@@ -7047,7 +7156,11 @@ class CfnFunction(
|
|
|
7047
7156
|
|
|
7048
7157
|
@builtins.property
|
|
7049
7158
|
def zip_file(self) -> typing.Optional[builtins.str]:
|
|
7050
|
-
'''(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter,
|
|
7159
|
+
'''(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named ``index`` and zips it to create a `deployment package <https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html>`_ . This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index`` . For example, ``index.handler`` .
|
|
7160
|
+
|
|
7161
|
+
For JSON, you must escape quotes and special characters such as newline ( ``\\n`` ) with a backslash.
|
|
7162
|
+
|
|
7163
|
+
If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ( `cfn-response <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html>`_ ) that simplifies sending responses. See `Using AWS Lambda with AWS CloudFormation <https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html>`_ for details.
|
|
7051
7164
|
|
|
7052
7165
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile
|
|
7053
7166
|
'''
|
|
@@ -7131,7 +7244,7 @@ class CfnFunction(
|
|
|
7131
7244
|
|
|
7132
7245
|
You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
|
|
7133
7246
|
|
|
7134
|
-
:param variables: Environment variable key-value pairs. For more information, see `Using Lambda environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html>`_.
|
|
7247
|
+
:param variables: Environment variable key-value pairs. For more information, see `Using Lambda environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html>`_ .
|
|
7135
7248
|
|
|
7136
7249
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html
|
|
7137
7250
|
:exampleMetadata: fixture=_generated
|
|
@@ -7161,7 +7274,7 @@ class CfnFunction(
|
|
|
7161
7274
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]]:
|
|
7162
7275
|
'''Environment variable key-value pairs.
|
|
7163
7276
|
|
|
7164
|
-
For more information, see `Using Lambda environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html>`_.
|
|
7277
|
+
For more information, see `Using Lambda environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html>`_ .
|
|
7165
7278
|
|
|
7166
7279
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html#cfn-lambda-function-environment-variables
|
|
7167
7280
|
'''
|
|
@@ -7245,10 +7358,10 @@ class CfnFunction(
|
|
|
7245
7358
|
arn: builtins.str,
|
|
7246
7359
|
local_mount_path: builtins.str,
|
|
7247
7360
|
) -> None:
|
|
7248
|
-
'''Details about the connection between a Lambda function and an `Amazon EFS file system <https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html>`_.
|
|
7361
|
+
'''Details about the connection between a Lambda function and an `Amazon EFS file system <https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html>`_ .
|
|
7249
7362
|
|
|
7250
7363
|
:param arn: The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
|
|
7251
|
-
:param local_mount_path: The path where the function can access the file system, starting with ``/mnt
|
|
7364
|
+
:param local_mount_path: The path where the function can access the file system, starting with ``/mnt/`` .
|
|
7252
7365
|
|
|
7253
7366
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html
|
|
7254
7367
|
:exampleMetadata: fixture=_generated
|
|
@@ -7285,7 +7398,7 @@ class CfnFunction(
|
|
|
7285
7398
|
|
|
7286
7399
|
@builtins.property
|
|
7287
7400
|
def local_mount_path(self) -> builtins.str:
|
|
7288
|
-
'''The path where the function can access the file system, starting with ``/mnt
|
|
7401
|
+
'''The path where the function can access the file system, starting with ``/mnt/`` .
|
|
7289
7402
|
|
|
7290
7403
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-localmountpath
|
|
7291
7404
|
'''
|
|
@@ -7323,7 +7436,7 @@ class CfnFunction(
|
|
|
7323
7436
|
) -> None:
|
|
7324
7437
|
'''Configuration values that override the container image Dockerfile settings.
|
|
7325
7438
|
|
|
7326
|
-
For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_.
|
|
7439
|
+
For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_ .
|
|
7327
7440
|
|
|
7328
7441
|
:param command: Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.
|
|
7329
7442
|
:param entry_point: Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.
|
|
@@ -7424,7 +7537,7 @@ class CfnFunction(
|
|
|
7424
7537
|
|
|
7425
7538
|
:param application_log_level: Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest.
|
|
7426
7539
|
:param log_format: The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.
|
|
7427
|
-
:param log_group: The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/<function name
|
|
7540
|
+
:param log_group: The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/<function name>`` . To use a different log group, enter an existing log group or enter a new log group name.
|
|
7428
7541
|
:param system_log_level: Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.
|
|
7429
7542
|
|
|
7430
7543
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html
|
|
@@ -7485,7 +7598,7 @@ class CfnFunction(
|
|
|
7485
7598
|
def log_group(self) -> typing.Optional[builtins.str]:
|
|
7486
7599
|
'''The name of the Amazon CloudWatch log group the function sends logs to.
|
|
7487
7600
|
|
|
7488
|
-
By default, Lambda functions send logs to a default log group named ``/aws/lambda/<function name
|
|
7601
|
+
By default, Lambda functions send logs to a default log group named ``/aws/lambda/<function name>`` . To use a different log group, enter an existing log group or enter a new log group name.
|
|
7489
7602
|
|
|
7490
7603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-loggingconfig.html#cfn-lambda-function-loggingconfig-loggroup
|
|
7491
7604
|
'''
|
|
@@ -7531,10 +7644,10 @@ class CfnFunction(
|
|
|
7531
7644
|
) -> None:
|
|
7532
7645
|
'''Sets the runtime management configuration for a function's version.
|
|
7533
7646
|
|
|
7534
|
-
For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_.
|
|
7647
|
+
For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_ .
|
|
7535
7648
|
|
|
7536
|
-
:param update_runtime_on: Specify the runtime update mode. - *Auto (default)* - Automatically update to the most recent and secure runtime version using a `Two-phase runtime version rollout <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase>`_. This is the best choice for most customers to ensure they always benefit from runtime updates. - *FunctionUpdate* -
|
|
7537
|
-
:param runtime_version_arn: The ARN of the runtime version you want the function to use. This is only required if you're using the *Manual* runtime update mode.
|
|
7649
|
+
:param update_runtime_on: Specify the runtime update mode. - *Auto (default)* - Automatically update to the most recent and secure runtime version using a `Two-phase runtime version rollout <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase>`_ . This is the best choice for most customers to ensure they always benefit from runtime updates. - *FunctionUpdate* - Lambda updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. - *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see `Roll back a runtime version <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback>`_ . *Valid Values* : ``Auto`` | ``FunctionUpdate`` | ``Manual``
|
|
7650
|
+
:param runtime_version_arn: The ARN of the runtime version you want the function to use. .. epigraph:: This is only required if you're using the *Manual* runtime update mode.
|
|
7538
7651
|
|
|
7539
7652
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html
|
|
7540
7653
|
:exampleMetadata: fixture=_generated
|
|
@@ -7566,11 +7679,11 @@ class CfnFunction(
|
|
|
7566
7679
|
def update_runtime_on(self) -> builtins.str:
|
|
7567
7680
|
'''Specify the runtime update mode.
|
|
7568
7681
|
|
|
7569
|
-
- *Auto (default)* - Automatically update to the most recent and secure runtime version using a `Two-phase runtime version rollout <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase>`_. This is the best choice for most customers to ensure they always benefit from runtime updates.
|
|
7570
|
-
- *FunctionUpdate* -
|
|
7571
|
-
- *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see `Roll back a runtime version <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback>`_.
|
|
7682
|
+
- *Auto (default)* - Automatically update to the most recent and secure runtime version using a `Two-phase runtime version rollout <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase>`_ . This is the best choice for most customers to ensure they always benefit from runtime updates.
|
|
7683
|
+
- *FunctionUpdate* - Lambda updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
|
|
7684
|
+
- *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see `Roll back a runtime version <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback>`_ .
|
|
7572
7685
|
|
|
7573
|
-
*Valid Values
|
|
7686
|
+
*Valid Values* : ``Auto`` | ``FunctionUpdate`` | ``Manual``
|
|
7574
7687
|
|
|
7575
7688
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html#cfn-lambda-function-runtimemanagementconfig-updateruntimeon
|
|
7576
7689
|
'''
|
|
@@ -7582,7 +7695,9 @@ class CfnFunction(
|
|
|
7582
7695
|
def runtime_version_arn(self) -> typing.Optional[builtins.str]:
|
|
7583
7696
|
'''The ARN of the runtime version you want the function to use.
|
|
7584
7697
|
|
|
7585
|
-
|
|
7698
|
+
.. epigraph::
|
|
7699
|
+
|
|
7700
|
+
This is only required if you're using the *Manual* runtime update mode.
|
|
7586
7701
|
|
|
7587
7702
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-runtimemanagementconfig.html#cfn-lambda-function-runtimemanagementconfig-runtimeversionarn
|
|
7588
7703
|
'''
|
|
@@ -7607,7 +7722,7 @@ class CfnFunction(
|
|
|
7607
7722
|
)
|
|
7608
7723
|
class SnapStartProperty:
|
|
7609
7724
|
def __init__(self, *, apply_on: builtins.str) -> None:
|
|
7610
|
-
'''The function's `SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
7725
|
+
'''The function's `AWS Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
7611
7726
|
|
|
7612
7727
|
:param apply_on: Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.
|
|
7613
7728
|
|
|
@@ -7669,8 +7784,8 @@ class CfnFunction(
|
|
|
7669
7784
|
) -> None:
|
|
7670
7785
|
'''The function's `SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
7671
7786
|
|
|
7672
|
-
:param apply_on: When set to ``PublishedVersions
|
|
7673
|
-
:param optimization_status: When you provide a `qualified Amazon Resource Name (ARN) <https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using>`_, this response element indicates whether SnapStart is activated for the specified function version.
|
|
7787
|
+
:param apply_on: When set to ``PublishedVersions`` , Lambda creates a snapshot of the execution environment when you publish a function version.
|
|
7788
|
+
:param optimization_status: When you provide a `qualified Amazon Resource Name (ARN) <https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using>`_ , this response element indicates whether SnapStart is activated for the specified function version.
|
|
7674
7789
|
|
|
7675
7790
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html
|
|
7676
7791
|
:exampleMetadata: fixture=_generated
|
|
@@ -7698,7 +7813,7 @@ class CfnFunction(
|
|
|
7698
7813
|
|
|
7699
7814
|
@builtins.property
|
|
7700
7815
|
def apply_on(self) -> typing.Optional[builtins.str]:
|
|
7701
|
-
'''When set to ``PublishedVersions
|
|
7816
|
+
'''When set to ``PublishedVersions`` , Lambda creates a snapshot of the execution environment when you publish a function version.
|
|
7702
7817
|
|
|
7703
7818
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html#cfn-lambda-function-snapstartresponse-applyon
|
|
7704
7819
|
'''
|
|
@@ -7707,7 +7822,7 @@ class CfnFunction(
|
|
|
7707
7822
|
|
|
7708
7823
|
@builtins.property
|
|
7709
7824
|
def optimization_status(self) -> typing.Optional[builtins.str]:
|
|
7710
|
-
'''When you provide a `qualified Amazon Resource Name (ARN) <https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using>`_, this response element indicates whether SnapStart is activated for the specified function version.
|
|
7825
|
+
'''When you provide a `qualified Amazon Resource Name (ARN) <https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using>`_ , this response element indicates whether SnapStart is activated for the specified function version.
|
|
7711
7826
|
|
|
7712
7827
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html#cfn-lambda-function-snapstartresponse-optimizationstatus
|
|
7713
7828
|
'''
|
|
@@ -7732,7 +7847,7 @@ class CfnFunction(
|
|
|
7732
7847
|
)
|
|
7733
7848
|
class TracingConfigProperty:
|
|
7734
7849
|
def __init__(self, *, mode: typing.Optional[builtins.str] = None) -> None:
|
|
7735
|
-
'''The function's ` <https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html>`_ tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active
|
|
7850
|
+
'''The function's `AWS X-Ray <https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html>`_ tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active`` .
|
|
7736
7851
|
|
|
7737
7852
|
:param mode: The tracing mode.
|
|
7738
7853
|
|
|
@@ -7795,9 +7910,12 @@ class CfnFunction(
|
|
|
7795
7910
|
) -> None:
|
|
7796
7911
|
'''The VPC security groups and subnets that are attached to a Lambda function.
|
|
7797
7912
|
|
|
7798
|
-
When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see `VPC Settings <https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html>`_.
|
|
7799
|
-
|
|
7800
|
-
|
|
7913
|
+
When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see `VPC Settings <https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html>`_ .
|
|
7914
|
+
.. epigraph::
|
|
7915
|
+
|
|
7916
|
+
When you delete a function, AWS CloudFormation monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before AWS CloudFormation can delete the VPC's resources.
|
|
7917
|
+
|
|
7918
|
+
To monitor network interfaces, AWS CloudFormation needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, AWS CloudFormation does not wait for network interfaces to be deleted.
|
|
7801
7919
|
|
|
7802
7920
|
:param ipv6_allowed_for_dual_stack: Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.
|
|
7803
7921
|
:param security_group_ids: A list of VPC security group IDs.
|
|
@@ -7937,32 +8055,32 @@ class CfnFunctionProps:
|
|
|
7937
8055
|
) -> None:
|
|
7938
8056
|
'''Properties for defining a ``CfnFunction``.
|
|
7939
8057
|
|
|
7940
|
-
:param code: The
|
|
8058
|
+
:param code: The code for the function. You can define your function code in multiple ways:. - For .zip deployment packages, you can specify the Amazon S3 location of the .zip file in the ``S3Bucket`` , ``S3Key`` , and ``S3ObjectVersion`` properties. - For .zip deployment packages, you can alternatively define the function code inline in the ``ZipFile`` property. This method works only for Node.js and Python functions. - For container images, specify the URI of your container image in the Amazon ECR registry in the ``ImageUri`` property.
|
|
7941
8059
|
:param role: The Amazon Resource Name (ARN) of the function's execution role.
|
|
7942
|
-
:param architectures: The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64
|
|
8060
|
+
:param architectures: The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64`` .
|
|
7943
8061
|
:param code_signing_config_arn: To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.
|
|
7944
|
-
:param dead_letter_config:
|
|
8062
|
+
:param dead_letter_config: A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see `Dead-letter queues <https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq>`_ .
|
|
7945
8063
|
:param description: A description of the function.
|
|
7946
|
-
:param environment:
|
|
8064
|
+
:param environment: Environment variables that are accessible from function code during execution.
|
|
7947
8065
|
:param ephemeral_storage: The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.
|
|
7948
|
-
:param file_system_configs: Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an `AWS::EFS::MountTarget <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html>`_ resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see `DependsOn Attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html>`_.
|
|
7949
|
-
:param function_name: The name of the Lambda function, up to 64 characters in length. If you don't specify a name,
|
|
7950
|
-
:param handler: The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see `Lambda programming model <https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html>`_.
|
|
7951
|
-
:param image_config: Configuration values that override the container image Dockerfile settings. For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_.
|
|
7952
|
-
:param kms_key_arn: The ARN of the
|
|
8066
|
+
:param file_system_configs: Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an `AWS::EFS::MountTarget <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html>`_ resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see `DependsOn Attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html>`_ .
|
|
8067
|
+
:param function_name: The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
8068
|
+
:param handler: The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see `Lambda programming model <https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html>`_ .
|
|
8069
|
+
:param image_config: Configuration values that override the container image Dockerfile settings. For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_ .
|
|
8070
|
+
:param kms_key_arn: The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's `environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption>`_ . When `Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html>`_ is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry ( Amazon ECR ). If you don't provide a customer managed key, Lambda uses a default service key.
|
|
7953
8071
|
:param layers: A list of `function layers <https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html>`_ to add to the function's execution environment. Specify each layer by its ARN, including the version.
|
|
7954
8072
|
:param logging_config: The function's Amazon CloudWatch Logs configuration settings.
|
|
7955
8073
|
:param memory_size: The amount of `memory available to the function <https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console>`_ at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
|
|
7956
8074
|
:param package_type: The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
|
|
7957
|
-
:param recursive_loop:
|
|
8075
|
+
:param recursive_loop: The status of your function's recursive loop detection configuration. When this value is set to ``Allow`` and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action. When this value is set to ``Terminate`` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
|
|
7958
8076
|
:param reserved_concurrent_executions: The number of simultaneous executions to reserve for the function.
|
|
7959
|
-
:param runtime: The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see `Runtime use after deprecation <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels>`_. For a list of all currently supported runtimes, see `Supported runtimes <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported>`_.
|
|
7960
|
-
:param runtime_management_config: Sets the runtime management configuration for a function's version. For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_.
|
|
7961
|
-
:param snap_start: The function's `SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
7962
|
-
:param tags: A list of `tags <https://docs.aws.amazon.com/lambda/latest/dg/tagging.html>`_ to apply to the function.
|
|
7963
|
-
:param timeout: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see `Lambda execution environment <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html>`_.
|
|
7964
|
-
:param tracing_config:
|
|
7965
|
-
:param vpc_config:
|
|
8077
|
+
:param runtime: The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_ . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image. The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see `Runtime use after deprecation <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels>`_ . For a list of all currently supported runtimes, see `Supported runtimes <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported>`_ .
|
|
8078
|
+
:param runtime_management_config: Sets the runtime management configuration for a function's version. For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_ .
|
|
8079
|
+
:param snap_start: The function's `AWS Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
8080
|
+
:param tags: A list of `tags <https://docs.aws.amazon.com/lambda/latest/dg/tagging.html>`_ to apply to the function. .. epigraph:: You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
8081
|
+
:param timeout: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see `Lambda execution environment <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html>`_ .
|
|
8082
|
+
:param tracing_config: Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with `X-Ray <https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html>`_ .
|
|
8083
|
+
:param vpc_config: For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see `Configuring a Lambda function to access resources in a VPC <https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html>`_ .
|
|
7966
8084
|
|
|
7967
8085
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html
|
|
7968
8086
|
:exampleMetadata: fixture=_generated
|
|
@@ -8130,7 +8248,11 @@ class CfnFunctionProps:
|
|
|
8130
8248
|
|
|
8131
8249
|
@builtins.property
|
|
8132
8250
|
def code(self) -> typing.Union[_IResolvable_da3f097b, CfnFunction.CodeProperty]:
|
|
8133
|
-
'''The
|
|
8251
|
+
'''The code for the function. You can define your function code in multiple ways:.
|
|
8252
|
+
|
|
8253
|
+
- For .zip deployment packages, you can specify the Amazon S3 location of the .zip file in the ``S3Bucket`` , ``S3Key`` , and ``S3ObjectVersion`` properties.
|
|
8254
|
+
- For .zip deployment packages, you can alternatively define the function code inline in the ``ZipFile`` property. This method works only for Node.js and Python functions.
|
|
8255
|
+
- For container images, specify the URI of your container image in the Amazon ECR registry in the ``ImageUri`` property.
|
|
8134
8256
|
|
|
8135
8257
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code
|
|
8136
8258
|
'''
|
|
@@ -8152,7 +8274,7 @@ class CfnFunctionProps:
|
|
|
8152
8274
|
def architectures(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
8153
8275
|
'''The instruction set architecture that the function supports.
|
|
8154
8276
|
|
|
8155
|
-
Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64
|
|
8277
|
+
Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64`` .
|
|
8156
8278
|
|
|
8157
8279
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures
|
|
8158
8280
|
'''
|
|
@@ -8163,7 +8285,8 @@ class CfnFunctionProps:
|
|
|
8163
8285
|
def code_signing_config_arn(self) -> typing.Optional[builtins.str]:
|
|
8164
8286
|
'''To enable code signing for this function, specify the ARN of a code-signing configuration.
|
|
8165
8287
|
|
|
8166
|
-
A code-signing configuration
|
|
8288
|
+
A code-signing configuration
|
|
8289
|
+
includes a set of signing profiles, which define the trusted publishers for this function.
|
|
8167
8290
|
|
|
8168
8291
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn
|
|
8169
8292
|
'''
|
|
@@ -8174,7 +8297,9 @@ class CfnFunctionProps:
|
|
|
8174
8297
|
def dead_letter_config(
|
|
8175
8298
|
self,
|
|
8176
8299
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.DeadLetterConfigProperty]]:
|
|
8177
|
-
'''
|
|
8300
|
+
'''A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing.
|
|
8301
|
+
|
|
8302
|
+
For more information, see `Dead-letter queues <https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq>`_ .
|
|
8178
8303
|
|
|
8179
8304
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig
|
|
8180
8305
|
'''
|
|
@@ -8194,9 +8319,7 @@ class CfnFunctionProps:
|
|
|
8194
8319
|
def environment(
|
|
8195
8320
|
self,
|
|
8196
8321
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.EnvironmentProperty]]:
|
|
8197
|
-
'''
|
|
8198
|
-
|
|
8199
|
-
You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.
|
|
8322
|
+
'''Environment variables that are accessible from function code during execution.
|
|
8200
8323
|
|
|
8201
8324
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment
|
|
8202
8325
|
'''
|
|
@@ -8223,7 +8346,8 @@ class CfnFunctionProps:
|
|
|
8223
8346
|
'''Connection settings for an Amazon EFS file system.
|
|
8224
8347
|
|
|
8225
8348
|
To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an `AWS::EFS::MountTarget <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html>`_ resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function.
|
|
8226
|
-
|
|
8349
|
+
|
|
8350
|
+
For more information about using the ``DependsOn`` attribute, see `DependsOn Attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html>`_ .
|
|
8227
8351
|
|
|
8228
8352
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs
|
|
8229
8353
|
'''
|
|
@@ -8234,7 +8358,8 @@ class CfnFunctionProps:
|
|
|
8234
8358
|
def function_name(self) -> typing.Optional[builtins.str]:
|
|
8235
8359
|
'''The name of the Lambda function, up to 64 characters in length.
|
|
8236
8360
|
|
|
8237
|
-
If you don't specify a name,
|
|
8361
|
+
If you don't specify a name, AWS CloudFormation generates one.
|
|
8362
|
+
|
|
8238
8363
|
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
8239
8364
|
|
|
8240
8365
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname
|
|
@@ -8246,7 +8371,7 @@ class CfnFunctionProps:
|
|
|
8246
8371
|
def handler(self) -> typing.Optional[builtins.str]:
|
|
8247
8372
|
'''The name of the method within your code that Lambda calls to run your function.
|
|
8248
8373
|
|
|
8249
|
-
Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see `Lambda programming model <https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html>`_.
|
|
8374
|
+
Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see `Lambda programming model <https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html>`_ .
|
|
8250
8375
|
|
|
8251
8376
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler
|
|
8252
8377
|
'''
|
|
@@ -8259,7 +8384,7 @@ class CfnFunctionProps:
|
|
|
8259
8384
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.ImageConfigProperty]]:
|
|
8260
8385
|
'''Configuration values that override the container image Dockerfile settings.
|
|
8261
8386
|
|
|
8262
|
-
For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_.
|
|
8387
|
+
For more information, see `Container image settings <https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms>`_ .
|
|
8263
8388
|
|
|
8264
8389
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig
|
|
8265
8390
|
'''
|
|
@@ -8268,7 +8393,7 @@ class CfnFunctionProps:
|
|
|
8268
8393
|
|
|
8269
8394
|
@builtins.property
|
|
8270
8395
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
8271
|
-
'''The ARN of the
|
|
8396
|
+
'''The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that's used to encrypt your function's `environment variables <https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption>`_ . When `Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html>`_ is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry ( Amazon ECR ). If you don't provide a customer managed key, Lambda uses a default service key.
|
|
8272
8397
|
|
|
8273
8398
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn
|
|
8274
8399
|
'''
|
|
@@ -8317,9 +8442,11 @@ class CfnFunctionProps:
|
|
|
8317
8442
|
|
|
8318
8443
|
@builtins.property
|
|
8319
8444
|
def recursive_loop(self) -> typing.Optional[builtins.str]:
|
|
8320
|
-
'''
|
|
8445
|
+
'''The status of your function's recursive loop detection configuration.
|
|
8446
|
+
|
|
8447
|
+
When this value is set to ``Allow`` and Lambda detects your function being invoked as part of a recursive loop, it doesn't take any action.
|
|
8321
8448
|
|
|
8322
|
-
|
|
8449
|
+
When this value is set to ``Terminate`` and Lambda detects your function being invoked as part of a recursive loop, it stops your function being invoked and notifies you.
|
|
8323
8450
|
|
|
8324
8451
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-recursiveloop
|
|
8325
8452
|
'''
|
|
@@ -8337,7 +8464,11 @@ class CfnFunctionProps:
|
|
|
8337
8464
|
|
|
8338
8465
|
@builtins.property
|
|
8339
8466
|
def runtime(self) -> typing.Optional[builtins.str]:
|
|
8340
|
-
'''The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
|
|
8467
|
+
'''The identifier of the function's `runtime <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html>`_ . Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.
|
|
8468
|
+
|
|
8469
|
+
The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see `Runtime use after deprecation <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-deprecation-levels>`_ .
|
|
8470
|
+
|
|
8471
|
+
For a list of all currently supported runtimes, see `Supported runtimes <https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtimes-supported>`_ .
|
|
8341
8472
|
|
|
8342
8473
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime
|
|
8343
8474
|
'''
|
|
@@ -8350,7 +8481,7 @@ class CfnFunctionProps:
|
|
|
8350
8481
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.RuntimeManagementConfigProperty]]:
|
|
8351
8482
|
'''Sets the runtime management configuration for a function's version.
|
|
8352
8483
|
|
|
8353
|
-
For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_.
|
|
8484
|
+
For more information, see `Runtime updates <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html>`_ .
|
|
8354
8485
|
|
|
8355
8486
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtimemanagementconfig
|
|
8356
8487
|
'''
|
|
@@ -8361,7 +8492,7 @@ class CfnFunctionProps:
|
|
|
8361
8492
|
def snap_start(
|
|
8362
8493
|
self,
|
|
8363
8494
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.SnapStartProperty]]:
|
|
8364
|
-
'''The function's `SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
8495
|
+
'''The function's `AWS Lambda SnapStart <https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html>`_ setting.
|
|
8365
8496
|
|
|
8366
8497
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-snapstart
|
|
8367
8498
|
'''
|
|
@@ -8372,6 +8503,10 @@ class CfnFunctionProps:
|
|
|
8372
8503
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
8373
8504
|
'''A list of `tags <https://docs.aws.amazon.com/lambda/latest/dg/tagging.html>`_ to apply to the function.
|
|
8374
8505
|
|
|
8506
|
+
.. epigraph::
|
|
8507
|
+
|
|
8508
|
+
You must have the ``lambda:TagResource`` , ``lambda:UntagResource`` , and ``lambda:ListTags`` permissions for your `IAM principal <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html>`_ to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
|
|
8509
|
+
|
|
8375
8510
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags
|
|
8376
8511
|
'''
|
|
8377
8512
|
result = self._values.get("tags")
|
|
@@ -8381,7 +8516,7 @@ class CfnFunctionProps:
|
|
|
8381
8516
|
def timeout(self) -> typing.Optional[jsii.Number]:
|
|
8382
8517
|
'''The amount of time (in seconds) that Lambda allows a function to run before stopping it.
|
|
8383
8518
|
|
|
8384
|
-
The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see `Lambda execution environment <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html>`_.
|
|
8519
|
+
The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see `Lambda execution environment <https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html>`_ .
|
|
8385
8520
|
|
|
8386
8521
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout
|
|
8387
8522
|
'''
|
|
@@ -8392,7 +8527,7 @@ class CfnFunctionProps:
|
|
|
8392
8527
|
def tracing_config(
|
|
8393
8528
|
self,
|
|
8394
8529
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.TracingConfigProperty]]:
|
|
8395
|
-
'''
|
|
8530
|
+
'''Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with `X-Ray <https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html>`_ .
|
|
8396
8531
|
|
|
8397
8532
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig
|
|
8398
8533
|
'''
|
|
@@ -8403,11 +8538,9 @@ class CfnFunctionProps:
|
|
|
8403
8538
|
def vpc_config(
|
|
8404
8539
|
self,
|
|
8405
8540
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFunction.VpcConfigProperty]]:
|
|
8406
|
-
'''
|
|
8541
|
+
'''For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
|
|
8407
8542
|
|
|
8408
|
-
When you connect a function to a VPC,
|
|
8409
|
-
When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources.
|
|
8410
|
-
To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.
|
|
8543
|
+
When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see `Configuring a Lambda function to access resources in a VPC <https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html>`_ .
|
|
8411
8544
|
|
|
8412
8545
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig
|
|
8413
8546
|
'''
|
|
@@ -9293,7 +9426,7 @@ class CfnPermission(
|
|
|
9293
9426
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
9294
9427
|
:param action: The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction`` .
|
|
9295
9428
|
:param function_name: The name or ARN of the Lambda function, version, or alias. **Name formats** - *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias). - *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function`` . - *Partial ARN* – ``123456789012:function:my-function`` . You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
|
|
9296
|
-
:param principal: The AWS service
|
|
9429
|
+
:param principal: The AWS service , AWS account , IAM user, or IAM role that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.
|
|
9297
9430
|
:param event_source_token: For Alexa Smart Home functions, a token that the invoker must supply.
|
|
9298
9431
|
:param function_url_auth_type: The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see `Security and auth model for Lambda function URLs <https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html>`_ .
|
|
9299
9432
|
:param principal_org_id: The identifier for your organization in AWS Organizations . Use this to grant permissions to all the AWS accounts under this organization.
|
|
@@ -9389,7 +9522,7 @@ class CfnPermission(
|
|
|
9389
9522
|
@builtins.property
|
|
9390
9523
|
@jsii.member(jsii_name="principal")
|
|
9391
9524
|
def principal(self) -> builtins.str:
|
|
9392
|
-
'''The AWS service
|
|
9525
|
+
'''The AWS service , AWS account , IAM user, or IAM role that invokes the function.'''
|
|
9393
9526
|
return typing.cast(builtins.str, jsii.get(self, "principal"))
|
|
9394
9527
|
|
|
9395
9528
|
@principal.setter
|
|
@@ -9496,7 +9629,7 @@ class CfnPermissionProps:
|
|
|
9496
9629
|
|
|
9497
9630
|
:param action: The action that the principal can use on the function. For example, ``lambda:InvokeFunction`` or ``lambda:GetFunction`` .
|
|
9498
9631
|
:param function_name: The name or ARN of the Lambda function, version, or alias. **Name formats** - *Function name* – ``my-function`` (name-only), ``my-function:v1`` (with alias). - *Function ARN* – ``arn:aws:lambda:us-west-2:123456789012:function:my-function`` . - *Partial ARN* – ``123456789012:function:my-function`` . You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
|
|
9499
|
-
:param principal: The AWS service
|
|
9632
|
+
:param principal: The AWS service , AWS account , IAM user, or IAM role that invokes the function. If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.
|
|
9500
9633
|
:param event_source_token: For Alexa Smart Home functions, a token that the invoker must supply.
|
|
9501
9634
|
:param function_url_auth_type: The type of authentication that your function URL uses. Set to ``AWS_IAM`` if you want to restrict access to authenticated users only. Set to ``NONE`` if you want to bypass IAM authentication to create a public endpoint. For more information, see `Security and auth model for Lambda function URLs <https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html>`_ .
|
|
9502
9635
|
:param principal_org_id: The identifier for your organization in AWS Organizations . Use this to grant permissions to all the AWS accounts under this organization.
|
|
@@ -9582,7 +9715,7 @@ class CfnPermissionProps:
|
|
|
9582
9715
|
|
|
9583
9716
|
@builtins.property
|
|
9584
9717
|
def principal(self) -> builtins.str:
|
|
9585
|
-
'''The AWS service
|
|
9718
|
+
'''The AWS service , AWS account , IAM user, or IAM role that invokes the function.
|
|
9586
9719
|
|
|
9587
9720
|
If you specify a service, use ``SourceArn`` or ``SourceAccount`` to limit who can invoke the function through that service.
|
|
9588
9721
|
|
|
@@ -25621,6 +25754,12 @@ class FunctionUrl(
|
|
|
25621
25754
|
check_type(argname="argument grantee", value=grantee, expected_type=type_hints["grantee"])
|
|
25622
25755
|
return typing.cast(_Grant_a7ae64f8, jsii.invoke(self, "grantInvokeUrl", [grantee]))
|
|
25623
25756
|
|
|
25757
|
+
@builtins.property
|
|
25758
|
+
@jsii.member(jsii_name="authType")
|
|
25759
|
+
def auth_type(self) -> FunctionUrlAuthType:
|
|
25760
|
+
'''The authentication type used for this Function URL.'''
|
|
25761
|
+
return typing.cast(FunctionUrlAuthType, jsii.get(self, "authType"))
|
|
25762
|
+
|
|
25624
25763
|
@builtins.property
|
|
25625
25764
|
@jsii.member(jsii_name="functionArn")
|
|
25626
25765
|
def function_arn(self) -> builtins.str:
|