AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

EventApi

An AppSync Event API.

Import

import { EventApi } from 'aws-cdk-lib/aws-appsync';

Or use the module namespace:

import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.EventApi

Properties

Configuration passed to the constructor as EventApiProps.

apiNameRequired
string

the name of the Event API.

authorizationConfigOptional
EventApiAuthConfig

Optional authorization configuration.

Default: - API Key authorization

domainNameOptional
AppSyncDomainOptions

The domain name configuration for the Event API. The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to enable custom domain URL

Default: - no domain name

logConfigOptional
AppSyncLogConfig

Logging configuration for this api.

Default: - None

ownerContactOptional
string

The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.

Default: - No owner contact.

Get the AWS AppSync Cheat Sheet

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-appsync
Properties5

Related Constructs

Explore This Service

External Links