Class EventSourceMapping

Defines a Lambda EventSourceMapping resource.

Inheritance
System.Object
Construct
Resource
EventSourceMapping
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Lambda
Assembly: Amazon.CDK.AWS.Lambda.dll
Syntax (csharp)
public class EventSourceMapping : Resource, IEventSourceMapping, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class EventSourceMapping
    Inherits Resource
    Implements IEventSourceMapping, IResource, IConstruct, IConstruct, IDependable
Remarks

Usually, you won't need to define the mapping yourself. This will usually be done by event sources. For example, to add an SQS event source to a function:

import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
lambda.addEventSource(new SqsEventSource(sqs));

The SqsEventSource class will automatically create the mapping, and will also modify the Lambda's execution role so it can consume messages from the queue.

Synopsis

Constructors

EventSourceMapping(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
EventSourceMapping(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
EventSourceMapping(Construct, String, IEventSourceMappingProps)

Properties

EventSourceMappingId

The identifier for this EventSourceMapping.

Methods

FromEventSourceMappingId(Construct, String, String)

Import an event source into this stack from its event source id.

Constructors

EventSourceMapping(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected EventSourceMapping(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

EventSourceMapping(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected EventSourceMapping(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

EventSourceMapping(Construct, String, IEventSourceMappingProps)

public EventSourceMapping(Construct scope, string id, IEventSourceMappingProps props)
Parameters
scope Constructs.Construct
id System.String
props IEventSourceMappingProps

Properties

EventSourceMappingId

The identifier for this EventSourceMapping.

public virtual string EventSourceMappingId { get; }
Property Value

System.String

Methods

FromEventSourceMappingId(Construct, String, String)

Import an event source into this stack from its event source id.

public static IEventSourceMapping FromEventSourceMappingId(Construct scope, string id, string eventSourceMappingId)
Parameters
scope Constructs.Construct
id System.String
eventSourceMappingId System.String
Returns

IEventSourceMapping

Implements

Constructs.IConstruct