interface EventBridgeDataSourceProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppSync.EventBridgeDataSourceProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#EventBridgeDataSourceProps |
 Java | software.amazon.awscdk.services.appsync.EventBridgeDataSourceProps |
 Python | aws_cdk.aws_appsync.EventBridgeDataSourceProps |
 TypeScript (source) | aws-cdk-lib » aws_appsync » EventBridgeDataSourceProps |
Properties for an AppSync EventBridge datasource.
Example
// 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';
declare const eventBus: events.EventBus;
declare const graphqlApi: appsync.GraphqlApi;
declare const role: iam.Role;
const eventBridgeDataSourceProps: appsync.EventBridgeDataSourceProps = {
api: graphqlApi,
eventBus: eventBus,
// the properties below are optional
description: 'description',
name: 'name',
serviceRole: role,
};
Properties
| Name | Type | Description |
|---|---|---|
| api | IGraphql | The API to attach this data source to. |
| event | IEvent | The EventBridge EventBus. |
| description? | string | the description of the data source. |
| name? | string | The name of the data source. |
| service | IRole | The IAM service role to be assumed by AppSync to interact with the data source. |
api
Type:
IGraphql
The API to attach this data source to.
eventBus
Type:
IEvent
The EventBridge EventBus.
description?
Type:
string
(optional, default: None)
the description of the data source.
name?
Type:
string
(optional, default: id of data source)
The name of the data source.
serviceRole?
Type:
IRole
(optional, default: Create a new role)
The IAM service role to be assumed by AppSync to interact with the data source.