Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

interface EventApiProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.EventApiProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#EventApiProps
Javasoftware.amazon.awscdk.services.appsync.EventApiProps
Pythonaws_cdk.aws_appsync.EventApiProps
TypeScript (source)aws-cdk-lib » aws_appsync » EventApiProps

Properties for an AppSync Event API.

Example

import * as logs from 'aws-cdk-lib/aws-logs';

const apiKeyProvider: appsync.AppSyncAuthProvider = {
  authorizationType: appsync.AppSyncAuthorizationType.API_KEY,
};

const api = new appsync.EventApi(this, 'api', {
  apiName: 'Api',
  ownerContact: 'OwnerContact',
  authorizationConfig: {
    authProviders: [
      apiKeyProvider,
    ],
    connectionAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultPublishAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultSubscribeAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
  },
  logConfig: {
    fieldLogLevel: appsync.AppSyncFieldLogLevel.INFO,
    retention: logs.RetentionDays.ONE_WEEK,
  },
});

Properties

NameTypeDescription
apiNamestringthe name of the Event API.
authorizationConfig?EventApiAuthConfigOptional authorization configuration.
domainName?AppSyncDomainOptionsThe domain name configuration for the Event API.
logConfig?AppSyncLogConfigLogging configuration for this api.
ownerContact?stringThe owner contact information for an API resource.

apiName

Type: string

the name of the Event API.

authorizationConfig?

Type: EventApiAuthConfig (optional, default: API Key authorization)

Optional authorization configuration.

domainName?

Type: AppSyncDomainOptions (optional, default: no domain name)

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

logConfig?

Type: AppSyncLogConfig (optional, default: None)

Logging configuration for this api.

ownerContact?

Type: string (optional, default: No owner contact.)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

← PreviousNext →