(aws-appsync): Add data source integrations to `EventApi`

[garysassano]

Describe the feature

AppSync Events recently added support for data source integrations. This feature should be incorporated into the EventApi construct to enhance its functionality.

Use Case

See above.

Proposed Solution

The implementation should mirror the interface used in the GraphqlApi construct, adding the following methods to EventApi:

• addBedrockDataSource()
• addDynamoDbDataSource()
• addEventBridgeDataSource()
• addHttpDataSource()
• addLambdaDataSource()
• addNoneDataSource()
• addOpenSearchDataSource()
• addRdsDataSource()
• addRdsDataSourceV2()

This enhancement would provide a consistent developer experience between the two constructs when working with various AWS data sources.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.190.0

Environment details (OS name and version, etc.)

Ubuntu 24.04

[pahud]

Hi @garysassano,

Thanks for raising this feature request!

You're correct, AppSync Events recently added support for data source integrations, and this capability is currently missing from the CDK's EventApi construct. Adding methods like addDynamoDbDataSource, addLambdaDataSource, etc., similar to those on the GraphqlApi, would indeed improve consistency and usability.

The necessary changes would involve adding these methods to the EventApi class.

This looks like a valuable enhancement. We encourage contributions! If you're interested in implementing this feature, the team would be happy to review a Pull Request. Please let us know if you plan to work on it or have any further questions.

[SanketNalage]

Hello @pahud and @garysassano We will extend the EventApi class by adding functions in this format:
Each function will allow the integration of a different data source, similar to how it is done in the GraphqlApi construct.

Additionally, I need your help with one more thing:
In which file should I update the EventApi to add these changes?

import * as appsync from 'aws-cdk-lib/aws-appsync';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as eventbridge from 'aws-cdk-lib/aws-events';
import * as rds from 'aws-cdk-lib/aws-rds';
import * as opensearch from 'aws-cdk-lib/aws-opensearchservice';
import * as bedrock from 'aws-cdk-lib/aws-bedrock'; // hypothetical if Bedrock supported directly
import { Construct } from 'constructs';

export interface EventApiProps {
  readonly name: string;
  readonly authenticationType: string;
  // Add other props you may need
}

export class EventApi extends Construct {
  public readonly api: appsync.CfnGraphQLApi;

  constructor(scope: Construct, id: string, props: EventApiProps) {
    super(scope, id);

    this.api = new appsync.CfnGraphQLApi(this, 'Api', {
      name: props.name,
      authenticationType: props.authenticationType,
      // other config
    });
  }

  public addDynamoDbDataSource(id: string, table: dynamodb.ITable, options?: appsync.DataSourceOptions) {
    return new appsync.DynamoDbDataSource(this, id, {
      api: this.api as any,
      table,
      ...options,
    });
  }

  public addLambdaDataSource(id: string, lambdaFunction: lambda.IFunction, options?: appsync.DataSourceOptions) {
    return new appsync.LambdaDataSource(this, id, {
      api: this.api as any,
      lambdaFunction,
      ...options,
    });
  }

  public addHttpDataSource(id: string, endpoint: string, options?: appsync.HttpDataSourceOptions) {
    return new appsync.HttpDataSource(this, id, endpoint, {
      api: this.api as any,
      ...options,
    });
  }

  public addEventBridgeDataSource(id: string, eventBus: eventbridge.IEventBus, options?: appsync.EventBridgeDataSourceOptions) {
    return new appsync.EventBridgeDataSource(this, id, {
      api: this.api as any,
      eventBus,
      ...options,
    });
  }

  public addOpenSearchDataSource(id: string, domain: opensearch.IDomain, options?: appsync.DataSourceOptions) {
    return new appsync.OpenSearchDataSource(this, id, {
      api: this.api as any,
      domain,
      ...options,
    });
  }

  public addNoneDataSource(id: string, options?: appsync.DataSourceOptions) {
    return new appsync.NoneDataSource(this, id, {
      api: this.api as any,
      ...options,
    });
  }

  public addRdsDataSource(id: string, serverlessCluster: rds.IServerlessCluster, secretStore: rds.DatabaseSecret, options?: appsync.RdsDataSourceOptions) {
    return new appsync.RdsDataSource(this, id, {
      api: this.api as any,
      serverlessCluster,
      secretStore,
      ...options,
    });
  }

  public addRdsDataSourceV2(id: string, cluster: rds.IDatabaseCluster, secretStore: rds.DatabaseSecret, options?: appsync.RdsDataSourceV2Options) {
    return new appsync.RdsDataSourceV2(this, id, {
      api: this.api as any,
      cluster,
      secretStore,
      ...options,
    });
  }

  public addBedrockDataSource(id: string, bedrockModel: bedrock.IBedrockModel, options?: appsync.BedrockDataSourceOptions) {
    return new appsync.BedrockDataSource(this, id, {
      api: this.api as any,
      model: bedrockModel,
      ...options,
    });
  }
}

[mazyu36]

It seems that the PR has already been submitted.　#34248

[garysassano]

@mazyu36 That's great, I hadn't noticed that.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.