Skip to content
v2.274.0

AppSyncEventBridgeDataSourceProps Struct ​

Properties for an AppSync EventBridge datasource.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
import { aws_events as events } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';

declare const apiRef: interfaces_appsync.IApiRef;
declare const eventBus: events.EventBus;
declare const role: iam.Role;
const appSyncEventBridgeDataSourceProps: appsync.AppSyncEventBridgeDataSourceProps = {
  api: apiRef,
  eventBus: eventBus,

  // the properties below are optional
  description: 'description',
  name: 'name',
  serviceRole: role,
};

Properties ​

The API to attach this data source to.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#
The description of the data source.
eventBusIEventBusevent_busIEventBuseventBusIEventBusEventBusIEventBusEventBusIEventBusrequired#
The EventBridge EventBus.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the data source.

Default: id of data source

The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.

serviceRoleoptionalIRoleservice_roleoptionalIRoleserviceRoleoptionalIRoleServiceRoleoptionalIRoleServiceRoleoptionalIRole#
The IAM service role to be assumed by AppSync to interact with the data source.

Default: Create a new role