interface EventApiAttributes

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

Attributes for Event API imports.

Example

// 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

Name	Type	Description
apiId	string	an unique AWS AppSync Event API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.
httpDns	string	the domain name of the Api's HTTP endpoint.
realtimeDns	string	the domain name of the Api's real-time endpoint.
apiArn?	string	the ARN of the Event API.
apiName?	string	the name of the Event API.
authProviderTypes?	AppSyncAuthorizationType[]	The Authorization Types for this Event Api.

---

apiId

Type: string

an unique AWS AppSync Event API identifier i.e. 'lxz775lwdrgcndgz3nurvac7oa'.

---

httpDns

Type: string

the domain name of the Api's HTTP endpoint.

---

realtimeDns

Type: string

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

---

apiArn?

Type: string (optional, default: constructed arn)

the ARN of the Event API.

---

apiName?

Type: string (optional, default: not needed to import API)

the name of the Event API.

---

authProviderTypes?

Type: AppSyncAuthorizationType[] (optional, default: none, required to construct event rules from imported APIs)

The Authorization Types for this Event Api.