AWS CDK Reference

Appearance

v2.274.0

EventApiAttributes Struct ​

Attributes for Event API imports.

Source
aws-appsync/lib/eventapi.ts
Type last changed
v2.193.0 · 30 Apr 2025

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';
const eventApiAttributes: appsync.EventApiAttributes = {
  apiId: 'apiId',
  httpDns: 'httpDns',
  realtimeDns: 'realtimeDns',

  // the properties below are optional
  apiArn: 'apiArn',
  apiName: 'apiName',
  authProviderTypes: [appsync.AppSyncAuthorizationType.API_KEY],
};

Properties ​

apiArnoptionalstringapi_arnoptionalstrapiArnoptionalStringApiArnoptionalstringApiArnoptional*string#
the ARN of the Event API.

Default: constructed arn

apiIdstringapi_idstrapiIdStringApiIdstringApiId*stringrequired#
a unique AWS AppSync Event API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
apiNameoptionalstringapi_nameoptionalstrapiNameoptionalStringApiNameoptionalstringApiNameoptional*string#
the name of the Event API.

Default: not needed to import API

authProviderTypesoptionalAppSyncAuthorizationType[]auth_provider_typesoptionaltyping.List[AppSyncAuthorizationType]authProviderTypesoptionalList<AppSyncAuthorizationType>AuthProviderTypesoptionalAppSyncAuthorizationType[]AuthProviderTypesoptional*[]AppSyncAuthorizationType#
The Authorization Types for this Event Api.

Default: none, required to construct event rules from imported APIs

httpDnsstringhttp_dnsstrhttpDnsStringHttpDnsstringHttpDns*stringrequired#
the domain name of the Api's HTTP endpoint.
realtimeDnsstringrealtime_dnsstrrealtimeDnsStringRealtimeDnsstringRealtimeDns*stringrequired#
the domain name of the Api's real-time endpoint.