Class EventManager

Provides operations on AWS EventBridge.

A new instance of this class is injected into CommonConstruct constructor.
If a custom construct extends CommonConstruct, an instance is available within the context.

Example

import { CommonConstruct } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonConstruct {
  constructor(parent: Construct, id: string, props: common.CommonStackProps) {
    super(parent, id, props)
    this.props = props
    this.eventManager.createLambdaRule('MyLambdaRule', this, lambdaFunction)
  }
}

See

[CDK EventBridge Module]https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events-readme.html

Index

Constructors

constructor

Methods

createDynamoDbToLambdaCfnPipe createEventBus createFargateTaskRule createLambdaRule createRule createSqsToLambdaCfnPipe createSqsToSfnCfnPipe

Constructors

constructor

new EventManager(): EventManager
Returns EventManager

Methods

createDynamoDbToLambdaCfnPipe

createDynamoDbToLambdaCfnPipe(
    id: string,
    scope: CommonConstruct,
    props: DynamoDbToLambdaPipeProps,
    sourceDynamoDbStreamArn: string,
    targetLambdaFunction: IFunction,
): CfnPipe
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: DynamoDbToLambdaPipeProps
  the props for the pipe
- sourceDynamoDbStreamArn: string
  the source dynamoDb stream
- targetLambdaFunction: IFunction
  the target lambda function
Returns CfnPipe
- Defined in packages/aws/src/services/eventbridge/main.ts:351

createEventBus

createEventBus(
    id: string,
    scope: CommonConstruct,
    props: EventBusProps,
): EventBus
Method to create an event bus
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: EventBusProps
  event bus properties
Returns EventBus
- Defined in packages/aws/src/services/eventbridge/main.ts:47

createFargateTaskRule

createFargateTaskRule(
    id: string,
    scope: CommonConstruct,
    props: RuleProps,
    cluster: ICluster,
    task: ITaskDefinition,
    subnetIds: string[],
    role: Role | CfnRole,
    eventPattern?: any,
): CfnRule
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: RuleProps
  the CfnRule properties for the event rule
- cluster: ICluster
  the ECS cluster to run the Fargate task in
- task: ITaskDefinition
  the ECS task definition to execute
- subnetIds: string[]
  the list of subnet IDs for the Fargate task's VPC configuration
- role: Role | CfnRole
  the IAM role granting EventBridge permission to run the ECS task
- OptionaleventPattern: any
  optional event pattern to filter events
Returns CfnRule
- Defined in packages/aws/src/services/eventbridge/main.ts:181

createLambdaRule

createLambdaRule(
    id: string,
    scope: CommonConstruct,
    props: RuleProps,
    lambdaFunction: IFunction,
    eventBusName?: string,
    eventPattern?: any,
    scheduleExpression?: string,
): CfnRule
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: RuleProps
  the CfnRule properties for the event rule
- lambdaFunction: IFunction
  the Lambda function to invoke as the rule target
- OptionaleventBusName: string
  optional name of the custom event bus to attach the rule to
- OptionaleventPattern: any
  optional event pattern to filter events
- OptionalscheduleExpression: string
  optional cron or rate expression for scheduled rules
Returns CfnRule
- Defined in packages/aws/src/services/eventbridge/main.ts:122

createRule

createRule(
    id: string,
    scope: CommonConstruct,
    props: EventRuleProps,
    eventBus?: IEventBus,
    targets?: IRuleTarget[],
): Rule
Method to create an event rule
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: EventRuleProps
  event rule properties
- OptionaleventBus: IEventBus
  optional custom event bus
- Optionaltargets: IRuleTarget[]
  optional event targets
Returns Rule
- Defined in packages/aws/src/services/eventbridge/main.ts:78

createSqsToLambdaCfnPipe

createSqsToLambdaCfnPipe(
    id: string,
    scope: CommonConstruct,
    props: SqsToLambdaPipeProps,
    sourceQueue: IQueue,
    targetLambdaFunction: IFunction,
): CfnPipe
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: SqsToLambdaPipeProps
  the props for the pipe
- sourceQueue: IQueue
  the source sqs queue
- targetLambdaFunction: IFunction
  the target lambda function
Returns CfnPipe
- Defined in packages/aws/src/services/eventbridge/main.ts:292

createSqsToSfnCfnPipe

createSqsToSfnCfnPipe(
    id: string,
    scope: CommonConstruct,
    props: SqsToSfnPipeProps,
    sourceQueue: IQueue,
    targetStepFunction: IStateMachine,
): CfnPipe
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: SqsToSfnPipeProps
  the props for the pipe
- sourceQueue: IQueue
  the source sqs queue
- targetStepFunction: IStateMachine
  the target step function
Returns CfnPipe
- Defined in packages/aws/src/services/eventbridge/main.ts:230

Class EventManager

Example

See

Index

Constructors

Methods

Constructors

constructor

Returns EventManager

Methods

createDynamoDbToLambdaCfnPipe

Parameters

Returns CfnPipe

createEventBus

Parameters

Returns EventBus

createFargateTaskRule

Parameters

Returns CfnRule

createLambdaRule

Parameters

Returns CfnRule

createRule

Parameters

Returns Rule

createSqsToLambdaCfnPipe

Parameters

Returns CfnPipe

createSqsToSfnCfnPipe

Parameters

Returns CfnPipe

Settings

On This Page