# 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`
---