# Eventbridge SaaS Partner fURLs
[](https://constructs.dev/packages/cdk-eventbridge-partner-processors)
[](https://badge.fury.io/js/cdk-eventbridge-partner-processors)
[](https://badge.fury.io/py/a-bigelow.cdk-eventbridge-partner-processors)
[](https://badge.fury.io/go/github.com%2Fa-bigelow%2Fcdk-eventbridge-partner-processors-go)
This CDK Construct library provides CDK constructs for the 1st-party (i.e. developed by AWS) lambda fURL webhook receivers for:
- GitHub
- Stripe
- Twilio
## Usage Examples (Simplified)
These examples are consistent for all 3 primary exported constructs of this library:
- `GitHubEventProcessor`
- `TwilioEventProcessor`
- `StripeEventProcessor`
>Note: Click on the above `View on Construct Hub` button to view auto-generated examples in Python/Go
### Typescript
```ts
import { GitHubEventProcessor } from 'cdk-eventbridge-partner-processors';
import { Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { EventBus } from 'aws-cdk-lib/aws-events';
import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
export class MyStackWithABetterName extends Stack {
constructor(scope: Construct, id: string, props: StackProps) {
super(scope, id, props);
// This library has no opinion on how you reference your EventBus,
// It just needs to fulfill the IEventBus protocol
const myEventBus = new EventBus(this, 'TheBestBusEver', {
eventBusName: 'TheGreatestBus'
});
// This library has no opinion on how you reference your secret,
// It just needs to fulfill the ISecret protocol
const mySecret = Secret.fromSecretNameV2(this, 'MyNuclearCodeSecret', '/home/recipes/icbm')
// Function will automatically receive permission to:
// 1. Post events to the given bus
// 2. Read the given secret
const githubEventProcessor = new GitHubEventProcessor(this, 'GitHubProcessor', {
eventBus: myEventBus,
webhookSecret: mySecret,
lambdaInvocationAlarmThreshold: 2000,
})
}
}
```
### Golang
```go
package main
import (
partner "github.com/a-bigelow/cdk-eventbridge-partner-processors-go"
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsevents"
"github.com/aws/constructs-go/constructs/v10"
"github.com/aws/jsii-runtime-go"
)
type ClusterStackProps struct {
awscdk.StackProps
}
func NewClusterStack(scope constructs.Construct, id string, props *ClusterStackProps) awscdk.Stack {
var sprops awscdk.StackProps
if props != nil {
sprops = props.StackProps
}
stack := awscdk.NewStack(scope, &id, &sprops)
// The code that defines your stack goes here
eventProps := awsevents.EventBusProps{EventBusName: jsii.String("name")}
eventBus := awsevents.NewEventBus(stack, jsii.String("id"), &eventProps)
secret := secretsmanager.secret.fromSecretNameV2(scope, jsii.String("secret"), jsii.String("secretName"))
partnerProcessor := partner.GithubEventProcessor{
EventBus: eventBus,
WebhookSecret: secret,
LambdaInvocationAlarmThreshold: 2000,
}
_ = partner.NewGitHubEventProcessor(stack, jsii.String("id"), partnerProcessor)
return stack
}
```
### Disclaimer
> :warning: The Lambda Functions that handle the actual event processing in this Library are owned and maintained by Amazon Web Services. This CDK Construct library provides a thin deployment wrapper for these functions. Changes made to the S3 location of the functions will break this library. Until I have a way to deterministically track where these things are, please raise an **issue** if you have reason to believe that the functions have moved.
### AWS Documentation
See [here](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html) for additional information.
# API Reference
## Constructs
### GitHubEventProcessor
CDK wrapper for the GitHub Eventbridge processor.
> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html#furls-connection-github](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html#furls-connection-github)
#### Initializers
```typescript
import { GitHubEventProcessor } from 'cdk-eventbridge-partner-processors'
new GitHubEventProcessor(scope: Construct, id: string, props: GitHubProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | GitHubProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* GitHubProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { GitHubEventProcessor } from 'cdk-eventbridge-partner-processors'
GitHubEventProcessor.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| invocationAlarm | InvocationAlarm | *No description.* |
| partnerEventsFunction | aws-cdk-lib.aws_lambda.Function | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `invocationAlarm`Required
```typescript
public readonly invocationAlarm: InvocationAlarm;
```
- *Type:* InvocationAlarm
---
##### `partnerEventsFunction`Required
```typescript
public readonly partnerEventsFunction: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
---
### InvocationAlarm
Cloudwatch Alarm used across this construct library.
#### Initializers
```typescript
import { InvocationAlarm } from 'cdk-eventbridge-partner-processors'
new InvocationAlarm(scope: Construct, id: string, props: InvocationAlarmProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | InvocationAlarmProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* InvocationAlarmProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { InvocationAlarm } from 'cdk-eventbridge-partner-processors'
InvocationAlarm.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
### PartnerProcessor
Abstract class for Lambda-driven Eventbridge integrations.
This only works because the pattern for the S3 Keys lines up to: lambda-templates/-lambdasrc.zip
> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html)
#### Initializers
```typescript
import { PartnerProcessor } from 'cdk-eventbridge-partner-processors'
new PartnerProcessor(scope: Construct, id: string, props: PartnerFunctionProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | PartnerFunctionProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* PartnerFunctionProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { PartnerProcessor } from 'cdk-eventbridge-partner-processors'
PartnerProcessor.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| invocationAlarm | InvocationAlarm | *No description.* |
| partnerEventsFunction | aws-cdk-lib.aws_lambda.Function | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `invocationAlarm`Required
```typescript
public readonly invocationAlarm: InvocationAlarm;
```
- *Type:* InvocationAlarm
---
##### `partnerEventsFunction`Required
```typescript
public readonly partnerEventsFunction: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
---
### StripeEventProcessor
CDK wrapper for the Stripe Eventbridge processor.
> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html#furls-connection-github](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html#furls-connection-github)
#### Initializers
```typescript
import { StripeEventProcessor } from 'cdk-eventbridge-partner-processors'
new StripeEventProcessor(scope: Construct, id: string, props: StripeProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | StripeProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* StripeProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { StripeEventProcessor } from 'cdk-eventbridge-partner-processors'
StripeEventProcessor.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| invocationAlarm | InvocationAlarm | *No description.* |
| partnerEventsFunction | aws-cdk-lib.aws_lambda.Function | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `invocationAlarm`Required
```typescript
public readonly invocationAlarm: InvocationAlarm;
```
- *Type:* InvocationAlarm
---
##### `partnerEventsFunction`Required
```typescript
public readonly partnerEventsFunction: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
---
### TwilioEventProcessor
CDK wrapper for the Twilio Eventbridge processor.
> [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html#furls-connection-github](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas-furls.html#furls-connection-github)
#### Initializers
```typescript
import { TwilioEventProcessor } from 'cdk-eventbridge-partner-processors'
new TwilioEventProcessor(scope: Construct, id: string, props: TwilioProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | TwilioProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* TwilioProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { TwilioEventProcessor } from 'cdk-eventbridge-partner-processors'
TwilioEventProcessor.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| invocationAlarm | InvocationAlarm | *No description.* |
| partnerEventsFunction | aws-cdk-lib.aws_lambda.Function | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `invocationAlarm`Required
```typescript
public readonly invocationAlarm: InvocationAlarm;
```
- *Type:* InvocationAlarm
---
##### `partnerEventsFunction`Required
```typescript
public readonly partnerEventsFunction: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
---
## Structs
### GitHubProps
#### Initializer
```typescript
import { GitHubProps } from 'cdk-eventbridge-partner-processors'
const gitHubProps: GitHubProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| eventBus | aws-cdk-lib.aws_events.IEventBus | Eventbus to send GitHub events to. |
| lambdaInvocationAlarmThreshold | number | Maximum number of concurrent invocations on the fURL function before triggering the alarm. |
| webhookSecret | aws-cdk-lib.aws_secretsmanager.ISecret | SM Secret containing the secret string used to validate webhook events. |
---
##### `eventBus`Required
```typescript
public readonly eventBus: IEventBus;
```
- *Type:* aws-cdk-lib.aws_events.IEventBus
Eventbus to send GitHub events to.
---
##### `lambdaInvocationAlarmThreshold`Required
```typescript
public readonly lambdaInvocationAlarmThreshold: number;
```
- *Type:* number
Maximum number of concurrent invocations on the fURL function before triggering the alarm.
---
##### `webhookSecret`Required
```typescript
public readonly webhookSecret: ISecret;
```
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
SM Secret containing the secret string used to validate webhook events.
---
### InvocationAlarmProps
#### Initializer
```typescript
import { InvocationAlarmProps } from 'cdk-eventbridge-partner-processors'
const invocationAlarmProps: InvocationAlarmProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| eventFunction | aws-cdk-lib.aws_lambda.IFunction | The function to monitor. |
| threshold | number | Lambda Invocation threshold. |
---
##### `eventFunction`Required
```typescript
public readonly eventFunction: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
The function to monitor.
---
##### `threshold`Required
```typescript
public readonly threshold: number;
```
- *Type:* number
Lambda Invocation threshold.
---
### PartnerFunctionProps
#### Initializer
```typescript
import { PartnerFunctionProps } from 'cdk-eventbridge-partner-processors'
const partnerFunctionProps: PartnerFunctionProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| eventbridgePartner | Partner | The partner to create an events processor for. |
| eventBus | aws-cdk-lib.aws_events.IEventBus | Eventbus to send Partner events to. |
| lambdaInvocationAlarmThreshold | number | Maximum number of concurrent invocations on the fURL function before triggering the alarm. |
| webhookSecret | aws-cdk-lib.aws_secretsmanager.ISecret | SM Secret containing the secret string used to validate webhook events. |
---
##### `eventbridgePartner`Required
```typescript
public readonly eventbridgePartner: Partner;
```
- *Type:* Partner
The partner to create an events processor for.
---
##### `eventBus`Required
```typescript
public readonly eventBus: IEventBus;
```
- *Type:* aws-cdk-lib.aws_events.IEventBus
Eventbus to send Partner events to.
---
##### `lambdaInvocationAlarmThreshold`Required
```typescript
public readonly lambdaInvocationAlarmThreshold: number;
```
- *Type:* number
Maximum number of concurrent invocations on the fURL function before triggering the alarm.
---
##### `webhookSecret`Required
```typescript
public readonly webhookSecret: ISecret;
```
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
SM Secret containing the secret string used to validate webhook events.
---
### StripeProps
#### Initializer
```typescript
import { StripeProps } from 'cdk-eventbridge-partner-processors'
const stripeProps: StripeProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| eventBus | aws-cdk-lib.aws_events.IEventBus | Eventbus to send GitHub events to. |
| lambdaInvocationAlarmThreshold | number | Maximum number of concurrent invocations on the fURL function before triggering the alarm. |
| webhookSecret | aws-cdk-lib.aws_secretsmanager.ISecret | SM Secret containing the secret string used to validate webhook events. |
---
##### `eventBus`Required
```typescript
public readonly eventBus: IEventBus;
```
- *Type:* aws-cdk-lib.aws_events.IEventBus
Eventbus to send GitHub events to.
---
##### `lambdaInvocationAlarmThreshold`Required
```typescript
public readonly lambdaInvocationAlarmThreshold: number;
```
- *Type:* number
Maximum number of concurrent invocations on the fURL function before triggering the alarm.
---
##### `webhookSecret`Required
```typescript
public readonly webhookSecret: ISecret;
```
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
SM Secret containing the secret string used to validate webhook events.
---
### TwilioProps
#### Initializer
```typescript
import { TwilioProps } from 'cdk-eventbridge-partner-processors'
const twilioProps: TwilioProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| eventBus | aws-cdk-lib.aws_events.IEventBus | Eventbus to send GitHub events to. |
| lambdaInvocationAlarmThreshold | number | Maximum number of concurrent invocations on the fURL function before triggering the alarm. |
| webhookSecret | aws-cdk-lib.aws_secretsmanager.ISecret | SM Secret containing the secret string used to validate webhook events. |
---
##### `eventBus`Required
```typescript
public readonly eventBus: IEventBus;
```
- *Type:* aws-cdk-lib.aws_events.IEventBus
Eventbus to send GitHub events to.
---
##### `lambdaInvocationAlarmThreshold`Required
```typescript
public readonly lambdaInvocationAlarmThreshold: number;
```
- *Type:* number
Maximum number of concurrent invocations on the fURL function before triggering the alarm.
---
##### `webhookSecret`Required
```typescript
public readonly webhookSecret: ISecret;
```
- *Type:* aws-cdk-lib.aws_secretsmanager.ISecret
SM Secret containing the secret string used to validate webhook events.
---
## Enums
### Partner
Supported partners with fURL integrations.
#### Members
| **Name** | **Description** |
| --- | --- |
| GITHUB | *No description.* |
| STRIPE | *No description.* |
| TWILIO | *No description.* |
---
##### `GITHUB`
---
##### `STRIPE`
---
##### `TWILIO`
---