class Definition

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

AppSync definition.

Specify how you want to define your AppSync API.

Example

const sourceApi = new appsync.GraphqlApi(this, 'FirstSourceAPI', {
  name: 'FirstSourceAPI',
  definition: appsync.Definition.fromFile(path.join(__dirname, 'appsync.merged-api-1.graphql')),
});

const importedMergedApi = appsync.GraphqlApi.fromGraphqlApiAttributes(this, 'ImportedMergedApi', {
  graphqlApiId: 'MyApiId',
  graphqlApiArn: 'MyApiArn',
});

const importedExecutionRole = iam.Role.fromRoleArn(this, 'ExecutionRole', 'arn:aws:iam::ACCOUNT:role/MyExistingRole');
new appsync.SourceApiAssociation(this, 'SourceApiAssociation2', {
   sourceApi: sourceApi,
   mergedApi: importedMergedApi,
   mergeType: appsync.MergeType.MANUAL_MERGE,
   mergedApiExecutionRole: importedExecutionRole,
});

Initializer

new Definition()

Properties

Name	Type	Description
schema?	ISchema	Schema, when AppSync API is created from schema file.
sourceApiOptions?	SourceApiOptions	Source APIs for Merged API.

---

schema?

Type: ISchema (optional)

Schema, when AppSync API is created from schema file.

---

sourceApiOptions?

Type: SourceApiOptions (optional)

Source APIs for Merged API.

Methods

Name	Description
static fromFile(filePath)	Schema from file, allows schema definition through schema.graphql file.
static fromSchema(schema)	Schema from schema object.
static fromSourceApis(sourceApiOptions)	Schema from existing AppSync APIs - used for creating a AppSync Merged API.

---

static fromFile(filePath)

public static fromFile(filePath: string): Definition

Parameters

• filePath string — the file path of the schema file.

Returns

• Definition

Schema from file, allows schema definition through schema.graphql file.

---

static fromSchema(schema)

public static fromSchema(schema: ISchema): Definition

Parameters

• schema ISchema — SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file.

Returns

• Definition

Schema from schema object.

---

static fromSourceApis(sourceApiOptions)

public static fromSourceApis(sourceApiOptions: SourceApiOptions): Definition

Parameters

• sourceApiOptions SourceApiOptions — Configuration for AppSync Merged API.

Returns

• Definition

Schema from existing AppSync APIs - used for creating a AppSync Merged API.