interface IEventApi

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.IEventApi
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#IEventApi
Java	software.amazon.awscdk.services.appsync.IEventApi
Python	aws_cdk.aws_appsync.IEventApi
TypeScript (source)	aws-cdk-lib » aws_appsync » IEventApi

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IApiRef, IApi

Implemented by EventApi

Obtainable from EventApi.fromEventApiAttributes()

Interface for Event API.

Properties

Name	Type	Description
apiArn	string	The ARN of the AWS AppSync Api.
apiId	string	The unique identifier for the AWS AppSync Api generated by the service.
apiRef🔹	ApiReference	A reference to a Api resource.
authProviderTypes	AppSyncAuthorizationType[]	The Authorization Types for this Event Api.
env	ResourceEnvironment	The environment this resource belongs to.
httpDns	string	The domain name of the Api's HTTP endpoint.
node	Node	The tree node.
realtimeDns	string	The domain name of the Api's real-time endpoint.
stack	Stack	The stack in which this resource is defined.

---

apiArn

Type: string

The ARN of the AWS AppSync Api.

---

apiId

Type: string

The unique identifier for the AWS AppSync Api generated by the service.

---

apiRef🔹

Type: ApiReference

A reference to a Api resource.

---

authProviderTypes

Type: AppSyncAuthorizationType[]

The Authorization Types for this Event Api.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

httpDns

Type: string

The domain name of the Api's HTTP endpoint.

---

node

Type: Node

The tree node.

---

realtimeDns

Type: string

The domain name of the Api's real-time endpoint.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addChannelNamespace(id, options?)	add a new channel namespace.
addDynamoDbDataSource(id, table, options?)	Add a new DynamoDB data source to this API.
addEventBridgeDataSource(id, eventBus, options?)	Add an EventBridge data source to this api.
addHttpDataSource(id, endpoint, options?)	add a new http data source to this API.
addLambdaDataSource(id, lambdaFunction, options?)	add a new Lambda data source to this API.
addOpenSearchDataSource(id, domain, options?)	Add a new OpenSearch data source to this API.
addRdsDataSource(id, serverlessCluster, secretStore, databaseName?, options?)	add a new Rds data source to this API.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(grantee, resources, ...actions)	Adds an IAM policy statement associated with this Event API to an IAM principal's policy.
grantConnect(grantee)	Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal's policy.
grantPublish(grantee)	Adds an IAM policy statement for EventPublish access to this EventApi to an IAM principal's policy.
grantPublishAndSubscribe(grantee)	Adds an IAM policy statement to publish and subscribe to this API for an IAM principal's policy.
grantSubscribe(grantee)	Adds an IAM policy statement for EventSubscribe access to this EventApi to an IAM principal's policy.

---

addChannelNamespace(id, options?)

public addChannelNamespace(id: string, options?: ChannelNamespaceOptions): ChannelNamespace

Parameters

• id string — the id of the channel namespace.
• options ChannelNamespaceOptions — the options for the channel namespace.

Returns

• ChannelNamespace

add a new channel namespace.

---

addDynamoDbDataSource(id, table, options?)

public addDynamoDbDataSource(id: string, table: ITable, options?: AppSyncDataSourceOptions): AppSyncDynamoDbDataSource

Parameters

• id string — The data source's id.
• table ITable — The DynamoDB table backing this data source.
• options AppSyncDataSourceOptions — The optional configuration for this data source.

Returns

• AppSyncDynamoDbDataSource

Add a new DynamoDB data source to this API.

---

addEventBridgeDataSource(id, eventBus, options?)

public addEventBridgeDataSource(id: string, eventBus: IEventBus, options?: AppSyncDataSourceOptions): AppSyncEventBridgeDataSource

Parameters

• id string — The data source's id.
• eventBus IEventBus — The EventBridge EventBus on which to put events.
• options AppSyncDataSourceOptions — The optional configuration for this data source.

Returns

• AppSyncEventBridgeDataSource

Add an EventBridge data source to this api.

---

addHttpDataSource(id, endpoint, options?)

public addHttpDataSource(id: string, endpoint: string, options?: AppSyncHttpDataSourceOptions): AppSyncHttpDataSource

Parameters

• id string — The data source's id.
• endpoint string — The http endpoint.
• options AppSyncHttpDataSourceOptions — The optional configuration for this data source.

Returns

• AppSyncHttpDataSource

add a new http data source to this API.

---

addLambdaDataSource(id, lambdaFunction, options?)

public addLambdaDataSource(id: string, lambdaFunction: IFunction, options?: AppSyncDataSourceOptions): AppSyncLambdaDataSource

Parameters

• id string — The data source's id.
• lambdaFunction IFunction — The Lambda function to call to interact with this data source.
• options AppSyncDataSourceOptions — The optional configuration for this data source.

Returns

• AppSyncLambdaDataSource

add a new Lambda data source to this API.

---

addOpenSearchDataSource(id, domain, options?)

public addOpenSearchDataSource(id: string, domain: IDomain, options?: AppSyncDataSourceOptions): AppSyncOpenSearchDataSource

Parameters

• id string — The data source's id.
• domain IDomain — The OpenSearch domain for this data source.
• options AppSyncDataSourceOptions — The optional configuration for this data source.

Returns

• AppSyncOpenSearchDataSource

Add a new OpenSearch data source to this API.

---

addRdsDataSource(id, serverlessCluster, secretStore, databaseName?, options?)

public addRdsDataSource(id: string, serverlessCluster: IDatabaseCluster | IServerlessCluster, secretStore: ISecret, databaseName?: string, options?: AppSyncDataSourceOptions): AppSyncRdsDataSource

Parameters

• id string — The data source's id.
• serverlessCluster IDatabaseCluster | IServerlessCluster — The database cluster to interact with this data source.
• secretStore ISecret — The secret store that contains the username and password for the database cluster.
• databaseName string — The optional name of the database to use within the cluster.
• options AppSyncDataSourceOptions — The optional configuration for this data source.

Returns

• AppSyncRdsDataSource

add a new Rds data source to this API.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, resources, ...actions)

public grant(grantee: IGrantable, resources: AppSyncEventResource, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• resources AppSyncEventResource — The set of resources to allow (i.e. ...:[region]:[accountId]:apis/EventApiId/...).
• actions string — The actions that should be granted to the principal (i.e. appsync:EventPublish ).

Returns

• Grant

Adds an IAM policy statement associated with this Event API to an IAM principal's policy.

---

grantConnect(grantee)

public grantConnect(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Adds an IAM policy statement for EventConnect access to this EventApi to an IAM principal's policy.

---

grantPublish(grantee)

public grantPublish(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Adds an IAM policy statement for EventPublish access to this EventApi to an IAM principal's policy.

---

grantPublishAndSubscribe(grantee)

public grantPublishAndSubscribe(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Adds an IAM policy statement to publish and subscribe to this API for an IAM principal's policy.

---

grantSubscribe(grantee)

public grantSubscribe(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Adds an IAM policy statement for EventSubscribe access to this EventApi to an IAM principal's policy.