class AppSyncEventBridgeDataSource (construct)
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppSync.AppSyncEventBridgeDataSource |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#AppSyncEventBridgeDataSource |
 Java | software.amazon.awscdk.services.appsync.AppSyncEventBridgeDataSource |
 Python | aws_cdk.aws_appsync.AppSyncEventBridgeDataSource |
 TypeScript (source) | aws-cdk-lib » aws_appsync » AppSyncEventBridgeDataSource |
Implements
IConstruct, IDependable, IGrantable
An AppSync datasource backed by EventBridge.
Example
import * as events from 'aws-cdk-lib/aws-events';
const api = new appsync.EventApi(this, 'EventApiEventBridge', {
apiName: 'EventBridgeEventApi',
});
const eventBus = new events.EventBus(this, 'test-bus');
const dataSource = api.addEventBridgeDataSource('eventbridgeds', eventBus);
Initializer
new AppSyncEventBridgeDataSource(scope: Construct, id: string, props: AppSyncEventBridgeDataSourceProps)
Parameters
- scope
Construct - id
string - props
AppSync Event Bridge Data Source Props
Construct Props
| Name | Type | Description |
|---|---|---|
| api | IApi | 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:
IApi
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.
The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.
serviceRole?
Type:
IRole
(optional, default: Create a new role)
The IAM service role to be assumed by AppSync to interact with the data source.
Properties
| Name | Type | Description |
|---|---|---|
| grant | IPrincipal | The principal of the data source to be IGrantable. |
| name | string | The name of the data source. |
| node | Node | The tree node. |
| resource | Cfn | The underlying CFN data source resource. |
grantPrincipal
Type:
IPrincipal
The principal of the data source to be IGrantable.
name
Type:
string
The name of the data source.
node
Type:
Node
The tree node.
resource
Type:
Cfn
The underlying CFN data source resource.
Methods
| Name | Description |
|---|---|
| to | Returns a string representation of this construct. |
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.