awslambdadestinations

Documentation

Index

• func NewEventBridgeDestination_Override(e EventBridgeDestination, eventBus awsevents.IEventBus)
• func NewLambdaDestination_Override(l LambdaDestination, fn awslambda.IFunction, options *LambdaDestinationOptions)
• func NewSnsDestination_Override(s SnsDestination, topic awssns.ITopic)
• func NewSqsDestination_Override(s SqsDestination, queue awssqs.IQueue)
• type EventBridgeDestination
  • func NewEventBridgeDestination(eventBus awsevents.IEventBus) EventBridgeDestination
• type LambdaDestination
  • func NewLambdaDestination(fn awslambda.IFunction, options *LambdaDestinationOptions) LambdaDestination
• type LambdaDestinationOptions
• type SnsDestination
  • func NewSnsDestination(topic awssns.ITopic) SnsDestination
• type SqsDestination
  • func NewSqsDestination(queue awssqs.IQueue) SqsDestination

Functions

func NewEventBridgeDestination_Override

func NewEventBridgeDestination_Override(e EventBridgeDestination, eventBus awsevents.IEventBus)

Experimental.

func NewLambdaDestination_Override

func NewLambdaDestination_Override(l LambdaDestination, fn awslambda.IFunction, options *LambdaDestinationOptions)

Experimental.

func NewSnsDestination_Override

func NewSnsDestination_Override(s SnsDestination, topic awssns.ITopic)

Experimental.

func NewSqsDestination_Override

func NewSqsDestination_Override(s SqsDestination, queue awssqs.IQueue)

Experimental.

Types

type EventBridgeDestination

type EventBridgeDestination interface {
	awslambda.IDestination
	Bind(_scope constructs.Construct, fn awslambda.IFunction, _options *awslambda.DestinationOptions) *awslambda.DestinationConfig
}

Use an Event Bridge event bus as a Lambda destination.

If no event bus is specified, the default event bus is used. Experimental.

func NewEventBridgeDestination

func NewEventBridgeDestination(eventBus awsevents.IEventBus) EventBridgeDestination

Experimental.

type LambdaDestination

type LambdaDestination interface {
	awslambda.IDestination
	Bind(scope constructs.Construct, fn awslambda.IFunction, options *awslambda.DestinationOptions) *awslambda.DestinationConfig
}

Use a Lambda function as a Lambda destination. Experimental.

func NewLambdaDestination

func NewLambdaDestination(fn awslambda.IFunction, options *LambdaDestinationOptions) LambdaDestination

Experimental.

type LambdaDestinationOptions

type LambdaDestinationOptions struct {
	// Whether the destination function receives only the `responsePayload` of the source function.
	//
	// When set to `true` and used as `onSuccess` destination, the destination
	// function will be invoked with the payload returned by the source function.
	//
	// When set to `true` and used as `onFailure` destination, the destination
	// function will be invoked with the error object returned by source function.
	//
	// See the README of this module to see a full explanation of this option.
	// Experimental.
	ResponseOnly *bool `json:"responseOnly"`
}

Options for a Lambda destination. Experimental.

type SnsDestination

type SnsDestination interface {
	awslambda.IDestination
	Bind(_scope constructs.Construct, fn awslambda.IFunction, _options *awslambda.DestinationOptions) *awslambda.DestinationConfig
}

Use a SNS topic as a Lambda destination. Experimental.

func NewSnsDestination

func NewSnsDestination(topic awssns.ITopic) SnsDestination

Experimental.

type SqsDestination

type SqsDestination interface {
	awslambda.IDestination
	Bind(_scope constructs.Construct, fn awslambda.IFunction, _options *awslambda.DestinationOptions) *awslambda.DestinationConfig
}

Use a SQS queue as a Lambda destination. Experimental.

func NewSqsDestination

func NewSqsDestination(queue awssqs.IQueue) SqsDestination

Experimental.