Show / Hide Table of Contents

Class CfnEventSourceMapping

The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnEventSourceMapping
Implements
IInspectable
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventSourceMapping : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnEventSourceMapping Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

    CloudformationResource: AWS::Lambda::EventSourceMapping

    ExampleMetadata: fixture=_generated

    Examples
    // The code below shows an example of how to instantiate this type.
                 // The values are placeholders you should change.
                 using Amazon.CDK.AWS.Lambda;
    
                 var cfnEventSourceMapping = new CfnEventSourceMapping(this, "MyCfnEventSourceMapping", new CfnEventSourceMappingProps {
                     FunctionName = "functionName",
    
                     // the properties below are optional
                     AmazonManagedKafkaEventSourceConfig = new AmazonManagedKafkaEventSourceConfigProperty {
                         ConsumerGroupId = "consumerGroupId",
                         SchemaRegistryConfig = new SchemaRegistryConfigProperty {
                             AccessConfigs = new [] { new SchemaRegistryAccessConfigProperty {
                                 Type = "type",
                                 Uri = "uri"
                             } },
                             EventRecordFormat = "eventRecordFormat",
                             SchemaRegistryUri = "schemaRegistryUri",
                             SchemaValidationConfigs = new [] { new SchemaValidationConfigProperty {
                                 Attribute = "attribute"
                             } }
                         }
                     },
                     BatchSize = 123,
                     BisectBatchOnFunctionError = false,
                     DestinationConfig = new DestinationConfigProperty {
                         OnFailure = new OnFailureProperty {
                             Destination = "destination"
                         }
                     },
                     DocumentDbEventSourceConfig = new DocumentDBEventSourceConfigProperty {
                         CollectionName = "collectionName",
                         DatabaseName = "databaseName",
                         FullDocument = "fullDocument"
                     },
                     Enabled = false,
                     EventSourceArn = "eventSourceArn",
                     FilterCriteria = new FilterCriteriaProperty {
                         Filters = new [] { new FilterProperty {
                             Pattern = "pattern"
                         } }
                     },
                     FunctionResponseTypes = new [] { "functionResponseTypes" },
                     KmsKeyArn = "kmsKeyArn",
                     MaximumBatchingWindowInSeconds = 123,
                     MaximumRecordAgeInSeconds = 123,
                     MaximumRetryAttempts = 123,
                     MetricsConfig = new MetricsConfigProperty {
                         Metrics = new [] { "metrics" }
                     },
                     ParallelizationFactor = 123,
                     ProvisionedPollerConfig = new ProvisionedPollerConfigProperty {
                         MaximumPollers = 123,
                         MinimumPollers = 123
                     },
                     Queues = new [] { "queues" },
                     ScalingConfig = new ScalingConfigProperty {
                         MaximumConcurrency = 123
                     },
                     SelfManagedEventSource = new SelfManagedEventSourceProperty {
                         Endpoints = new EndpointsProperty {
                             KafkaBootstrapServers = new [] { "kafkaBootstrapServers" }
                         }
                     },
                     SelfManagedKafkaEventSourceConfig = new SelfManagedKafkaEventSourceConfigProperty {
                         ConsumerGroupId = "consumerGroupId",
                         SchemaRegistryConfig = new SchemaRegistryConfigProperty {
                             AccessConfigs = new [] { new SchemaRegistryAccessConfigProperty {
                                 Type = "type",
                                 Uri = "uri"
                             } },
                             EventRecordFormat = "eventRecordFormat",
                             SchemaRegistryUri = "schemaRegistryUri",
                             SchemaValidationConfigs = new [] { new SchemaValidationConfigProperty {
                                 Attribute = "attribute"
                             } }
                         }
                     },
                     SourceAccessConfigurations = new [] { new SourceAccessConfigurationProperty {
                         Type = "type",
                         Uri = "uri"
                     } },
                     StartingPosition = "startingPosition",
                     StartingPositionTimestamp = 123,
                     Tags = new [] { new CfnTag {
                         Key = "key",
                         Value = "value"
                     } },
                     Topics = new [] { "topics" },
                     TumblingWindowInSeconds = 123
                 });

    Synopsis

    Constructors

    CfnEventSourceMapping(Construct, string, ICfnEventSourceMappingProps)

    The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

    Properties

    AmazonManagedKafkaEventSourceConfig

    Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

    AttrEventSourceMappingArn

    The Amazon Resource Name (ARN) of the event source mapping.

    AttrId

    The event source mapping's ID.

    BatchSize

    The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.

    BisectBatchOnFunctionError

    (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    CdkTagManager

    Tag Manager which manages the tags for this resource.

    CfnProperties

    The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

    DestinationConfig

    (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.

    DocumentDbEventSourceConfig

    Specific configuration settings for a DocumentDB event source.

    Enabled

    When true, the event source mapping is active.

    EventSourceArn

    The Amazon Resource Name (ARN) of the event source.

    FilterCriteria

    An object that defines the filter criteria that determine whether Lambda should process an event.

    FunctionName

    The name or ARN of the Lambda function.

    FunctionResponseTypes

    (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.

    KmsKeyArn

    The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .

    MaximumBatchingWindowInSeconds

    The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

    MaximumRecordAgeInSeconds

    (Kinesis and DynamoDB Streams only) Discard records older than the specified age.

    MaximumRetryAttempts

    (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.

    MetricsConfig

    The metrics configuration for your event source.

    ParallelizationFactor

    (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.

    ProvisionedPollerConfig

    (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.

    Queues

    (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

    ScalingConfig

    (Amazon SQS only) The scaling configuration for the event source.

    SelfManagedEventSource

    The self-managed Apache Kafka cluster for your event source.

    SelfManagedKafkaEventSourceConfig

    Specific configuration settings for a self-managed Apache Kafka event source.

    SourceAccessConfigurations

    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

    StartingPosition

    The position in a stream from which to start reading.

    StartingPositionTimestamp

    With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

    Tags

    A list of tags to add to the event source mapping.

    Topics

    The name of the Kafka topic.

    TumblingWindowInSeconds

    (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    RenderProperties(IDictionary<string, object>)

    The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

    Constructors

    CfnEventSourceMapping(Construct, string, ICfnEventSourceMappingProps)

    The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

    public CfnEventSourceMapping(Construct scope, string id, ICfnEventSourceMappingProps props)
    Parameters
    scope Construct

    Scope in which this resource is defined.

    id string

    Construct identifier for this resource (unique in its scope).

    props ICfnEventSourceMappingProps

    Resource properties.

    Remarks

    Lambda reads items from the event source and triggers the function.

    For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

      CloudformationResource: AWS::Lambda::EventSourceMapping

      ExampleMetadata: fixture=_generated

      Properties

      AmazonManagedKafkaEventSourceConfig

      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

      public virtual object? AmazonManagedKafkaEventSourceConfig { get; set; }
      Property Value

      object

      Remarks

      Lambda reads items from the event source and triggers the function.

      For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

        CloudformationResource: AWS::Lambda::EventSourceMapping

        ExampleMetadata: fixture=_generated

        AttrEventSourceMappingArn

        The Amazon Resource Name (ARN) of the event source mapping.

        public virtual string AttrEventSourceMappingArn { get; }
        Property Value

        string

        Remarks

        CloudformationAttribute: EventSourceMappingArn

        AttrId

        The event source mapping's ID.

        public virtual string AttrId { get; }
        Property Value

        string

        Remarks

        CloudformationAttribute: Id

        BatchSize

        The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.

        public virtual double? BatchSize { get; set; }
        Property Value

        double?

        Remarks

        Lambda reads items from the event source and triggers the function.

        For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

          CloudformationResource: AWS::Lambda::EventSourceMapping

          ExampleMetadata: fixture=_generated

          BisectBatchOnFunctionError

          (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.

          public virtual object? BisectBatchOnFunctionError { get; set; }
          Property Value

          object

          Remarks

          Lambda reads items from the event source and triggers the function.

          For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

            CloudformationResource: AWS::Lambda::EventSourceMapping

            ExampleMetadata: fixture=_generated

            CFN_RESOURCE_TYPE_NAME

            The CloudFormation resource type name for this resource class.

            public static string CFN_RESOURCE_TYPE_NAME { get; }
            Property Value

            string

            Remarks

            Lambda reads items from the event source and triggers the function.

            For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

              CloudformationResource: AWS::Lambda::EventSourceMapping

              ExampleMetadata: fixture=_generated

              CdkTagManager

              Tag Manager which manages the tags for this resource.

              public virtual TagManager CdkTagManager { get; }
              Property Value

              TagManager

              Remarks

              Lambda reads items from the event source and triggers the function.

              For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                CloudformationResource: AWS::Lambda::EventSourceMapping

                ExampleMetadata: fixture=_generated

                CfnProperties

                The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

                protected override IDictionary<string, object> CfnProperties { get; }
                Property Value

                IDictionary<string, object>

                Overrides
                CfnResource.CfnProperties
                Remarks

                Lambda reads items from the event source and triggers the function.

                For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                  CloudformationResource: AWS::Lambda::EventSourceMapping

                  ExampleMetadata: fixture=_generated

                  DestinationConfig

                  (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.

                  public virtual object? DestinationConfig { get; set; }
                  Property Value

                  object

                  Remarks

                  Lambda reads items from the event source and triggers the function.

                  For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                    CloudformationResource: AWS::Lambda::EventSourceMapping

                    ExampleMetadata: fixture=_generated

                    DocumentDbEventSourceConfig

                    Specific configuration settings for a DocumentDB event source.

                    public virtual object? DocumentDbEventSourceConfig { get; set; }
                    Property Value

                    object

                    Remarks

                    Lambda reads items from the event source and triggers the function.

                    For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                      CloudformationResource: AWS::Lambda::EventSourceMapping

                      ExampleMetadata: fixture=_generated

                      Enabled

                      When true, the event source mapping is active.

                      public virtual object? Enabled { get; set; }
                      Property Value

                      object

                      Remarks

                      When false, Lambda pauses polling and invocation.

                      EventSourceArn

                      The Amazon Resource Name (ARN) of the event source.

                      public virtual string? EventSourceArn { get; set; }
                      Property Value

                      string

                      Remarks

                      Lambda reads items from the event source and triggers the function.

                      For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                        CloudformationResource: AWS::Lambda::EventSourceMapping

                        ExampleMetadata: fixture=_generated

                        FilterCriteria

                        An object that defines the filter criteria that determine whether Lambda should process an event.

                        public virtual object? FilterCriteria { get; set; }
                        Property Value

                        object

                        Remarks

                        Lambda reads items from the event source and triggers the function.

                        For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                          CloudformationResource: AWS::Lambda::EventSourceMapping

                          ExampleMetadata: fixture=_generated

                          FunctionName

                          The name or ARN of the Lambda function.

                          public virtual string FunctionName { get; set; }
                          Property Value

                          string

                          Remarks

                          Lambda reads items from the event source and triggers the function.

                          For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                            CloudformationResource: AWS::Lambda::EventSourceMapping

                            ExampleMetadata: fixture=_generated

                            FunctionResponseTypes

                            (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.

                            public virtual string[]? FunctionResponseTypes { get; set; }
                            Property Value

                            string[]

                            Remarks

                            Lambda reads items from the event source and triggers the function.

                            For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                              CloudformationResource: AWS::Lambda::EventSourceMapping

                              ExampleMetadata: fixture=_generated

                              KmsKeyArn

                              The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .

                              public virtual string? KmsKeyArn { get; set; }
                              Property Value

                              string

                              Remarks

                              Lambda reads items from the event source and triggers the function.

                              For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                CloudformationResource: AWS::Lambda::EventSourceMapping

                                ExampleMetadata: fixture=_generated

                                MaximumBatchingWindowInSeconds

                                The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

                                public virtual double? MaximumBatchingWindowInSeconds { get; set; }
                                Property Value

                                double?

                                Remarks

                                Lambda reads items from the event source and triggers the function.

                                For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                  CloudformationResource: AWS::Lambda::EventSourceMapping

                                  ExampleMetadata: fixture=_generated

                                  MaximumRecordAgeInSeconds

                                  (Kinesis and DynamoDB Streams only) Discard records older than the specified age.

                                  public virtual double? MaximumRecordAgeInSeconds { get; set; }
                                  Property Value

                                  double?

                                  Remarks

                                  Lambda reads items from the event source and triggers the function.

                                  For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                    CloudformationResource: AWS::Lambda::EventSourceMapping

                                    ExampleMetadata: fixture=_generated

                                    MaximumRetryAttempts

                                    (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.

                                    public virtual double? MaximumRetryAttempts { get; set; }
                                    Property Value

                                    double?

                                    Remarks

                                    Lambda reads items from the event source and triggers the function.

                                    For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                      CloudformationResource: AWS::Lambda::EventSourceMapping

                                      ExampleMetadata: fixture=_generated

                                      MetricsConfig

                                      The metrics configuration for your event source.

                                      public virtual object? MetricsConfig { get; set; }
                                      Property Value

                                      object

                                      Remarks

                                      Lambda reads items from the event source and triggers the function.

                                      For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                        CloudformationResource: AWS::Lambda::EventSourceMapping

                                        ExampleMetadata: fixture=_generated

                                        ParallelizationFactor

                                        (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.

                                        public virtual double? ParallelizationFactor { get; set; }
                                        Property Value

                                        double?

                                        Remarks

                                        Lambda reads items from the event source and triggers the function.

                                        For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                          CloudformationResource: AWS::Lambda::EventSourceMapping

                                          ExampleMetadata: fixture=_generated

                                          ProvisionedPollerConfig

                                          (Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.

                                          public virtual object? ProvisionedPollerConfig { get; set; }
                                          Property Value

                                          object

                                          Remarks

                                          Lambda reads items from the event source and triggers the function.

                                          For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                            CloudformationResource: AWS::Lambda::EventSourceMapping

                                            ExampleMetadata: fixture=_generated

                                            Queues

                                            (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

                                            public virtual string[]? Queues { get; set; }
                                            Property Value

                                            string[]

                                            Remarks

                                            Lambda reads items from the event source and triggers the function.

                                            For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                              CloudformationResource: AWS::Lambda::EventSourceMapping

                                              ExampleMetadata: fixture=_generated

                                              ScalingConfig

                                              (Amazon SQS only) The scaling configuration for the event source.

                                              public virtual object? ScalingConfig { get; set; }
                                              Property Value

                                              object

                                              Remarks

                                              Lambda reads items from the event source and triggers the function.

                                              For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                CloudformationResource: AWS::Lambda::EventSourceMapping

                                                ExampleMetadata: fixture=_generated

                                                SelfManagedEventSource

                                                The self-managed Apache Kafka cluster for your event source.

                                                public virtual object? SelfManagedEventSource { get; set; }
                                                Property Value

                                                object

                                                Remarks

                                                Lambda reads items from the event source and triggers the function.

                                                For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                  CloudformationResource: AWS::Lambda::EventSourceMapping

                                                  ExampleMetadata: fixture=_generated

                                                  SelfManagedKafkaEventSourceConfig

                                                  Specific configuration settings for a self-managed Apache Kafka event source.

                                                  public virtual object? SelfManagedKafkaEventSourceConfig { get; set; }
                                                  Property Value

                                                  object

                                                  Remarks

                                                  Lambda reads items from the event source and triggers the function.

                                                  For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                    CloudformationResource: AWS::Lambda::EventSourceMapping

                                                    ExampleMetadata: fixture=_generated

                                                    SourceAccessConfigurations

                                                    An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

                                                    public virtual object? SourceAccessConfigurations { get; set; }
                                                    Property Value

                                                    object

                                                    Remarks

                                                    Lambda reads items from the event source and triggers the function.

                                                    For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                      CloudformationResource: AWS::Lambda::EventSourceMapping

                                                      ExampleMetadata: fixture=_generated

                                                      StartingPosition

                                                      The position in a stream from which to start reading.

                                                      public virtual string? StartingPosition { get; set; }
                                                      Property Value

                                                      string

                                                      Remarks

                                                      Required for Amazon Kinesis and Amazon DynamoDB.

                                                      StartingPositionTimestamp

                                                      With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

                                                      public virtual double? StartingPositionTimestamp { get; set; }
                                                      Property Value

                                                      double?

                                                      Remarks

                                                      Lambda reads items from the event source and triggers the function.

                                                      For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                        CloudformationResource: AWS::Lambda::EventSourceMapping

                                                        ExampleMetadata: fixture=_generated

                                                        Tags

                                                        A list of tags to add to the event source mapping.

                                                        public virtual ICfnTag[]? Tags { get; set; }
                                                        Property Value

                                                        ICfnTag[]

                                                        Remarks

                                                        Lambda reads items from the event source and triggers the function.

                                                        For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                          CloudformationResource: AWS::Lambda::EventSourceMapping

                                                          ExampleMetadata: fixture=_generated

                                                          Topics

                                                          The name of the Kafka topic.

                                                          public virtual string[]? Topics { get; set; }
                                                          Property Value

                                                          string[]

                                                          Remarks

                                                          Lambda reads items from the event source and triggers the function.

                                                          For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                            CloudformationResource: AWS::Lambda::EventSourceMapping

                                                            ExampleMetadata: fixture=_generated

                                                            TumblingWindowInSeconds

                                                            (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

                                                            public virtual double? TumblingWindowInSeconds { get; set; }
                                                            Property Value

                                                            double?

                                                            Remarks

                                                            Lambda reads items from the event source and triggers the function.

                                                            For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                              CloudformationResource: AWS::Lambda::EventSourceMapping

                                                              ExampleMetadata: fixture=_generated

                                                              Methods

                                                              Inspect(TreeInspector)

                                                              Examines the CloudFormation resource and discloses attributes.

                                                              public virtual void Inspect(TreeInspector inspector)
                                                              Parameters
                                                              inspector TreeInspector

                                                              tree inspector to collect and process attributes.

                                                              Remarks

                                                              Lambda reads items from the event source and triggers the function.

                                                              For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                                CloudformationResource: AWS::Lambda::EventSourceMapping

                                                                ExampleMetadata: fixture=_generated

                                                                RenderProperties(IDictionary<string, object>)

                                                                The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function.

                                                                protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
                                                                Parameters
                                                                props IDictionary<string, object>
                                                                Returns

                                                                IDictionary<string, object>

                                                                Overrides
                                                                CfnResource.RenderProperties(IDictionary<string, object>)
                                                                Remarks

                                                                Lambda reads items from the event source and triggers the function.

                                                                For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                                  CloudformationResource: AWS::Lambda::EventSourceMapping

                                                                  ExampleMetadata: fixture=_generated

                                                                  Implements

                                                                  IInspectable
                                                                  ITaggableV2
                                                                  Back to top Generated by DocFX