Amplify Graphql API Construct

This package vends an L3 CDK Construct wrapping the behavior of the Amplify GraphQL Transformer. This enables quick development and interation of AppSync APIs which support the Amplify GraphQL Directives. For more information on schema modeling in GraphQL, please refer to the amplify developer docs.

The primary way to use this construct is to invoke it with a provided schema (either as an inline graphql string, or as one or more appsync.SchemaFile) objects, and with authorization config provided. There are 5 supported methods for authorization of an AppSync API, all of which are supported by this construct. For more information on authorization rule definitions in Amplify, refer to the authorization docs. Note: currently at least one authorization rule is required, and if multiple are specified, a defaultAuthorizationMode must be specified on the api as well. Specified authorization modes must be a superset of those configured in the graphql schema.

Examples

Simple Todo List With Cognito Userpool-based Owner Authorization

In this example, we create a single model, which will use user pool auth in order to allow logged in users to create and manage their own todos privately.

We create a cdk App and Stack, though you may be deploying this to a custom stack, this is purely illustrative for a concise demo.

We then wire this through to import a user pool which was already deployed (creating and deploying is out of scope for this example).

import { App, Stack } from 'aws-cdk-lib';
import { UserPool } from 'aws-cdk-lib/aws-cognito';
import { AmplifyGraphqlApi, AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';

const app = new App();
const stack = new Stack(app, 'TodoStack');

new AmplifyGraphqlApi(stack, 'TodoApp', {
  definition: AmplifyGraphqlDefinition.fromString(/* GraphQL */ `
    type Todo @model @auth(rules: [{ allow: owner }]) {
      description: String!
      completed: Boolean
    }
  `),
  authorizationModes: {
    userPoolConfig: {
      userPool: UserPool.fromUserPoolId(stack, 'ImportedUserPool', '<YOUR_USER_POOL_ID>'),
    },
  },
});

Multiple related models, with public read access, and admin read/write access

In this example, we create a two related models, which will use which logged in users in the 'Author' and 'Admin' user groups will have full access to, and customers requesting with api key will only have read permissions on.

import { App, Stack } from 'aws-cdk-lib';
import { UserPool } from 'aws-cdk-lib/aws-cognito';
import { AmplifyGraphqlApi, AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';

const app = new App();
const stack = new Stack(app, 'BlogStack');

new AmplifyGraphqlApi(stack, 'BlogApp', {
  definition: AmplifyGraphqlDefinition.fromString(/* GraphQL */ `
    type Blog @model @auth(rules: [{ allow: public, operations: [read] }, { allow: groups, groups: ["Author", "Admin"] }]) {
      title: String!
      description: String
      posts: [Post] @hasMany
    }

    type Post @model @auth(rules: [{ allow: public, operations: [read] }, { allow: groups, groups: ["Author", "Admin"] }]) {
      title: String!
      content: [String]
      blog: Blog @belongsTo
    }
  `),
  authorizationModes: {
    defaultAuthorizationMode: 'API_KEY',
    apiKeyConfig: {
      description: 'Api Key for public access',
      expires: cdk.Duration.days(7),
    },
    userPoolConfig: {
      userPool: UserPool.fromUserPoolId(stack, 'ImportedUserPool', '<YOUR_USER_POOL_ID>'),
    },
  },
});

Import GraphQL Schema from files, instead of inline

In this example, we import the schema definition itself from one or more local files, rather than an inline graphql string.

# todo.graphql
type Todo @model @auth(rules: [{ allow: owner }]) {
  content: String!
  done: Boolean
}

# blog.graphql
type Blog @model @auth(rules: [{ allow: owner }, { allow: public, operations: [read] }]) {
  title: String!
  description: String
  posts: [Post] @hasMany
}

type Post @model @auth(rules: [{ allow: owner }, { allow: public, operations: [read] }]) {
  title: String!
  content: [String]
  blog: Blog @belongsTo
}

// app.ts
import { App, Stack } from 'aws-cdk-lib';
import { UserPool } from 'aws-cdk-lib/aws-cognito';
import { AmplifyGraphqlApi, AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct';

const app = new App();
const stack = new Stack(app, 'MultiFileStack');

new AmplifyGraphqlApi(stack, 'MultiFileDefinition', {
  definition: AmplifyGraphqlDefinition.fromFiles(path.join(__dirname, 'todo.graphql'), path.join(__dirname, 'blog.graphql')),
  authorizationModes: {
    defaultAuthorizationMode: 'API_KEY',
    apiKeyConfig: {
      description: 'Api Key for public access',
      expires: cdk.Duration.days(7),
    },
    userPoolConfig: {
      userPool: UserPool.fromUserPoolId(stack, 'ImportedUserPool', '<YOUR_USER_POOL_ID>'),
    },
  },
});

API Reference

Constructs

AmplifyGraphqlApi

L3 Construct which invokes the Amplify Transformer Pattern over an input Graphql Schema.

This can be used to quickly define appsync apis which support full CRUD+List and Subscriptions, relationships, auth, search over data, the ability to inject custom business logic and query/mutation operations, and connect to ML services.

For more information, refer to the docs links below: Data Modeling - https://docs.amplify.aws/cli/graphql/data-modeling/ Authorization - https://docs.amplify.aws/cli/graphql/authorization-rules/ Custom Business Logic - https://docs.amplify.aws/cli/graphql/custom-business-logic/ Search - https://docs.amplify.aws/cli/graphql/search-and-result-aggregations/ ML Services - https://docs.amplify.aws/cli/graphql/connect-to-machine-learning-services/

For a full reference of the supported custom graphql directives - https://docs.amplify.aws/cli/graphql/directives-reference/

The output of this construct is a mapping of L2 or L1 resources generated by the transformer, which generally follow the access pattern

  const api = new AmplifyGraphQlApi(this, 'api', { <params> });
  // Access L2 resources under `.resources`
  api.resources.tables["Todo"].tableArn;

  // Access L1 resources under `.resources.cfnResources`
  api.resources.cfnResources.cfnGraphqlApi.xrayEnabled = true;
  Object.values(api.resources.cfnResources.cfnTables).forEach(table => {
    table.pointInTimeRecoverySpecification = { pointInTimeRecoveryEnabled: false };
  });

resources.<ResourceType>.<ResourceName> - you can then perform any CDK action on these resulting resoureces.

Initializers

import { AmplifyGraphqlApi } from '@aws-amplify/graphql-api-construct'

new AmplifyGraphqlApi(scope: Construct, id: string, props: AmplifyGraphqlApiProps)

scope^Required

• Type: constructs.Construct

the scope to create this construct within.

id^Required

• Type: string

the id to use for this api.

props^Required

• Type: AmplifyGraphqlApiProps

the properties used to configure the generated api.

Methods

toString

public toString(): string

Returns a string representation of this construct.

addDynamoDbDataSource

public addDynamoDbDataSource(id: string, table: ITable, options?: DataSourceOptions): DynamoDbDataSource

Add a new DynamoDB data source to this API.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

table^Required

• Type: aws-cdk-lib.aws_dynamodb.ITable

The DynamoDB table backing this data source.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addElasticsearchDataSource

public addElasticsearchDataSource(id: string, domain: IDomain, options?: DataSourceOptions): ElasticsearchDataSource

Add a new elasticsearch data source to this API.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

domain^Required

• Type: aws-cdk-lib.aws_elasticsearch.IDomain

The elasticsearch domain for this data source.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addEventBridgeDataSource

public addEventBridgeDataSource(id: string, eventBus: IEventBus, options?: DataSourceOptions): EventBridgeDataSource

Add an EventBridge data source to this api.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

eventBus^Required

• Type: aws-cdk-lib.aws_events.IEventBus

The EventBridge EventBus on which to put events.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addFunction

public addFunction(id: string, props: AddFunctionProps): AppsyncFunction

Add an appsync function to the api.

id^Required

• Type: string

the function's id.

props^Required

• Type: AddFunctionProps

addHttpDataSource

public addHttpDataSource(id: string, endpoint: string, options?: HttpDataSourceOptions): HttpDataSource

Add a new http data source to this API.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

endpoint^Required

• Type: string

The http endpoint.

options^Optional

• Type: aws-cdk-lib.aws_appsync.HttpDataSourceOptions

The optional configuration for this data source.

addLambdaDataSource

public addLambdaDataSource(id: string, lambdaFunction: IFunction, options?: DataSourceOptions): LambdaDataSource

Add a new Lambda data source to this API.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

lambdaFunction^Required

• Type: aws-cdk-lib.aws_lambda.IFunction

The Lambda function to call to interact with this data source.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addNoneDataSource

public addNoneDataSource(id: string, options?: DataSourceOptions): NoneDataSource

Add a new dummy data source to this API.

This is a proxy method to the L2 GraphqlApi Construct. Useful for pipeline resolvers and for backend changes that don't require a data source.

id^Required

• Type: string

The data source's id.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addOpenSearchDataSource

public addOpenSearchDataSource(id: string, domain: IDomain, options?: DataSourceOptions): OpenSearchDataSource

dd a new OpenSearch data source to this API.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

domain^Required

• Type: aws-cdk-lib.aws_opensearchservice.IDomain

The OpenSearch domain for this data source.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addRdsDataSource

public addRdsDataSource(id: string, serverlessCluster: IServerlessCluster, secretStore: ISecret, databaseName?: string, options?: DataSourceOptions): RdsDataSource

Add a new Rds data source to this API.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The data source's id.

serverlessCluster^Required

• Type: aws-cdk-lib.aws_rds.IServerlessCluster

The serverless cluster to interact with this data source.

secretStore^Required

• Type: aws-cdk-lib.aws_secretsmanager.ISecret

The secret store that contains the username and password for the serverless cluster.

databaseName^Optional

• Type: string

The optional name of the database to use within the cluster.

options^Optional

• Type: aws-cdk-lib.aws_appsync.DataSourceOptions

The optional configuration for this data source.

addResolver

public addResolver(id: string, props: ExtendedResolverProps): Resolver

Add a resolver to the api.

This is a proxy method to the L2 GraphqlApi Construct.

id^Required

• Type: string

The resolver's id.

props^Required

• Type: aws-cdk-lib.aws_appsync.ExtendedResolverProps

the resolver properties.

Static Functions

isConstruct

import { AmplifyGraphqlApi } from '@aws-amplify/graphql-api-construct'

AmplifyGraphqlApi.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

Properties

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

apiId^Required

public readonly apiId: string;

• Type: string

Generated Api Id.

May be a CDK Token.

generatedFunctionSlots^Required

public readonly generatedFunctionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];

• Type: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[]

Resolvers generated by the transform process, persisted on the side in order to facilitate pulling a manifest for the purposes of inspecting and producing overrides.

graphqlUrl^Required

public readonly graphqlUrl: string;

• Type: string

Graphql URL For the generated API.

May be a CDK Token.

realtimeUrl^Required

public readonly realtimeUrl: string;

• Type: string

Realtime URL For the generated API.

May be a CDK Token.

resources^Required

public readonly resources: AmplifyGraphqlApiResources;

• Type: AmplifyGraphqlApiResources

Generated L1 and L2 CDK resources.

apiKey^Optional

public readonly apiKey: string;

• Type: string

Generated Api Key if generated.

May be a CDK Token.

Structs

AddFunctionProps

Input type properties when adding a new appsync.AppsyncFunction to the generated API. This is equivalent to the Omit<appsync.AppsyncFunctionProps, 'api'>.

Initializer

import { AddFunctionProps } from '@aws-amplify/graphql-api-construct'

const addFunctionProps: AddFunctionProps = { ... }

Properties

dataSource^Required

public readonly dataSource: BaseDataSource;

• Type: aws-cdk-lib.aws_appsync.BaseDataSource

the data source linked to this AppSync Function.

name^Required

public readonly name: string;

• Type: string

the name of the AppSync Function.

code^Optional

public readonly code: Code;

• Type: aws-cdk-lib.aws_appsync.Code
• Default: no code is used

The function code.

description^Optional

public readonly description: string;

• Type: string
• Default: no description

the description for this AppSync Function.

requestMappingTemplate^Optional

public readonly requestMappingTemplate: MappingTemplate;

• Type: aws-cdk-lib.aws_appsync.MappingTemplate
• Default: no request mapping template

the request mapping template for the AppSync Function.

responseMappingTemplate^Optional

public readonly responseMappingTemplate: MappingTemplate;

• Type: aws-cdk-lib.aws_appsync.MappingTemplate
• Default: no response mapping template

the response mapping template for the AppSync Function.

runtime^Optional

public readonly runtime: FunctionRuntime;

• Type: aws-cdk-lib.aws_appsync.FunctionRuntime
• Default: no function runtime, VTL mapping templates used

The functions runtime.

AmplifyDynamoDbModelDataSourceStrategy

Use custom resource type 'Custom::AmplifyDynamoDBTable' to provision table.

Initializer

import { AmplifyDynamoDbModelDataSourceStrategy } from '@aws-amplify/graphql-api-construct'

const amplifyDynamoDbModelDataSourceStrategy: AmplifyDynamoDbModelDataSourceStrategy = { ... }

Properties

dbType^Required

public readonly dbType: string;

• Type: string

provisionStrategy^Required

public readonly provisionStrategy: string;

• Type: string

AmplifyGraphqlApiCfnResources

L1 CDK resources from the Api which were generated as part of the transform.

These are potentially stored under nested stacks, but presented organized by type instead.

Initializer

import { AmplifyGraphqlApiCfnResources } from '@aws-amplify/graphql-api-construct'

const amplifyGraphqlApiCfnResources: AmplifyGraphqlApiCfnResources = { ... }

Properties

additionalCfnResources^Required

public readonly additionalCfnResources: {[ key: string ]: CfnResource};

• Type: {[ key: string ]: aws-cdk-lib.CfnResource}

Remaining L1 resources generated, keyed by logicalId.

amplifyDynamoDbTables^Required

public readonly amplifyDynamoDbTables: {[ key: string ]: AmplifyDynamoDbTableWrapper};

• Type: {[ key: string ]: AmplifyDynamoDbTableWrapper}

The Generated Amplify DynamoDb Table L1 resource wrapper, keyed by model type name.

cfnDataSources^Required

public readonly cfnDataSources: {[ key: string ]: CfnDataSource};

• Type: {[ key: string ]: aws-cdk-lib.aws_appsync.CfnDataSource}

The Generated AppSync DataSource L1 Resources, keyed by logicalId.

cfnFunctionConfigurations^Required

public readonly cfnFunctionConfigurations: {[ key: string ]: CfnFunctionConfiguration};

• Type: {[ key: string ]: aws-cdk-lib.aws_appsync.CfnFunctionConfiguration}

The Generated AppSync Function L1 Resources, keyed by logicalId.

cfnFunctions^Required

public readonly cfnFunctions: {[ key: string ]: CfnFunction};

• Type: {[ key: string ]: aws-cdk-lib.aws_lambda.CfnFunction}

The Generated Lambda Function L1 Resources, keyed by function name.

cfnGraphqlApi^Required

public readonly cfnGraphqlApi: CfnGraphQLApi;

• Type: aws-cdk-lib.aws_appsync.CfnGraphQLApi

The Generated AppSync Api L1 Resource.

cfnGraphqlSchema^Required

public readonly cfnGraphqlSchema: CfnGraphQLSchema;

• Type: aws-cdk-lib.aws_appsync.CfnGraphQLSchema

The Generated AppSync Schema L1 Resource.

cfnResolvers^Required

public readonly cfnResolvers: {[ key: string ]: CfnResolver};

• Type: {[ key: string ]: aws-cdk-lib.aws_appsync.CfnResolver}

The Generated AppSync Resolver L1 Resources, keyed by logicalId.

cfnRoles^Required

public readonly cfnRoles: {[ key: string ]: CfnRole};

• Type: {[ key: string ]: aws-cdk-lib.aws_iam.CfnRole}

The Generated IAM Role L1 Resources, keyed by logicalId.

cfnTables^Required

public readonly cfnTables: {[ key: string ]: CfnTable};

• Type: {[ key: string ]: aws-cdk-lib.aws_dynamodb.CfnTable}

The Generated DynamoDB Table L1 Resources, keyed by logicalId.

cfnApiKey^Optional

public readonly cfnApiKey: CfnApiKey;

• Type: aws-cdk-lib.aws_appsync.CfnApiKey

The Generated AppSync Api Key L1 Resource.

AmplifyGraphqlApiProps

Input props for the AmplifyGraphqlApi construct.

Specifies what the input to transform into an Api, and configurations for the transformation process.

Initializer

import { AmplifyGraphqlApiProps } from '@aws-amplify/graphql-api-construct'

const amplifyGraphqlApiProps: AmplifyGraphqlApiProps = { ... }

Properties

authorizationModes^Required

public readonly authorizationModes: AuthorizationModes;

• Type: AuthorizationModes

Required auth modes for the Api.

This object must be a superset of the configured auth providers in the Api definition. For more information, refer to https://docs.amplify.aws/cli/graphql/authorization-rules/

definition^Required

public readonly definition: IAmplifyGraphqlDefinition;

• Type: IAmplifyGraphqlDefinition

The definition to transform in a full Api.

Can be constructed via the AmplifyGraphqlDefinition class.

apiName^Optional

public readonly apiName: string;

• Type: string

Name to be used for the AppSync Api.

Default: construct id.

conflictResolution^Optional

• Deprecated: use dataStoreConfiguration instead.

public readonly conflictResolution: ConflictResolution;

• Type: ConflictResolution

Configure conflict resolution on the Api, which is required to enable DataStore Api functionality.

For more information, refer to https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js/

dataStoreConfiguration^Optional

public readonly dataStoreConfiguration: DataStoreConfiguration;

• Type: DataStoreConfiguration

Configure DataStore conflict resolution on the Api.

Conflict resolution is required to enable DataStore Api functionality. For more information, refer to https://docs.amplify.aws/lib/datastore/getting-started/q/platform/js/

disableOutputStorage^Optional

public readonly disableOutputStorage: boolean;

• Type: boolean

Disables storing construct output.

Output storage should be disabled when creating multiple GraphQL APIs in a single CDK synthesis. outputStorageStrategy will be ignored if this is set to true.

functionNameMap^Optional

public readonly functionNameMap: {[ key: string ]: IFunction};

• Type: {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}

Lambda functions referenced in the definitions's.

functionSlots^Optional

public readonly functionSlots: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[];

• Type: MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot[]

Overrides for a given slot in the generated resolver pipelines.

For more information about what slots are available, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#override-amplify-generated-resolvers.

outputStorageStrategy^Optional

public readonly outputStorageStrategy: IBackendOutputStorageStrategy;

• Type: IBackendOutputStorageStrategy

Strategy to store construct outputs.

If no outputStorageStrategey is provided a default strategy will be used.

predictionsBucket^Optional

public readonly predictionsBucket: IBucket;

• Type: aws-cdk-lib.aws_s3.IBucket

If using predictions, a bucket must be provided which will be used to search for assets.

stackMappings^Optional

public readonly stackMappings: {[ key: string ]: string};

• Type: {[ key: string ]: string}

StackMappings override the assigned nested stack on a per-resource basis.

Only applies to resolvers, and takes the form { : } It is not recommended to use this parameter unless you are encountering stack resource count limits, and worth noting that after initial deployment AppSync resolvers cannot be moved between nested stacks, they will need to be removed from the app, then re-added from a new stack.

transformerPlugins^Optional

public readonly transformerPlugins: any[];

• Type: any[]

Provide a list of additional custom transformers which are injected into the transform process.

These custom transformers must be implemented with aws-cdk-lib >=2.80.0, and

translationBehavior^Optional

public readonly translationBehavior: PartialTranslationBehavior;

• Type: PartialTranslationBehavior

This replaces feature flags from the Api construct, for general information on what these parameters do, refer to https://docs.amplify.aws/cli/reference/feature-flags/#graphQLTransformer.

AmplifyGraphqlApiResources

Accessible resources from the Api which were generated as part of the transform.

These are potentially stored under nested stacks, but presented organized by type instead.

Initializer

import { AmplifyGraphqlApiResources } from '@aws-amplify/graphql-api-construct'

const amplifyGraphqlApiResources: AmplifyGraphqlApiResources = { ... }

Properties

cfnResources^Required

public readonly cfnResources: AmplifyGraphqlApiCfnResources;

• Type: AmplifyGraphqlApiCfnResources

L1 Cfn Resources, for when dipping down a level of abstraction is desirable.

functions^Required

public readonly functions: {[ key: string ]: IFunction};

• Type: {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}

The Generated Lambda Function L1 Resources, keyed by function name.

graphqlApi^Required

public readonly graphqlApi: IGraphqlApi;

• Type: aws-cdk-lib.aws_appsync.IGraphqlApi

The Generated AppSync Api L2 Resource, includes the Schema.

nestedStacks^Required

public readonly nestedStacks: {[ key: string ]: NestedStack};

• Type: {[ key: string ]: aws-cdk-lib.NestedStack}

Nested Stacks generated by the Api Construct.

roles^Required

public readonly roles: {[ key: string ]: IRole};

• Type: {[ key: string ]: aws-cdk-lib.aws_iam.IRole}

The Generated IAM Role L2 Resources, keyed by logicalId.

tables^Required

public readonly tables: {[ key: string ]: ITable};

• Type: {[ key: string ]: aws-cdk-lib.aws_dynamodb.ITable}

The Generated DynamoDB Table L2 Resources, keyed by logicalId.

ApiKeyAuthorizationConfig

Configuration for Api Keys on the Graphql Api.

Initializer

import { ApiKeyAuthorizationConfig } from '@aws-amplify/graphql-api-construct'

const apiKeyAuthorizationConfig: ApiKeyAuthorizationConfig = { ... }

Properties

expires^Required

public readonly expires: Duration;

• Type: aws-cdk-lib.Duration

A duration representing the time from Cloudformation deploy until expiry.

description^Optional

public readonly description: string;

• Type: string

Optional description for the Api Key to attach to the Api.

AuthorizationModes

Authorization Modes to apply to the Api.

At least one modes must be provided, and if more than one are provided a defaultAuthorizationMode must be specified. For more information on Amplify Api auth, refer to https://docs.amplify.aws/cli/graphql/authorization-rules/#authorization-strategies

Initializer

import { AuthorizationModes } from '@aws-amplify/graphql-api-construct'

const authorizationModes: AuthorizationModes = { ... }

Properties

adminRoles^Optional

• Deprecated: , use iamConfig.allowListedRoles instead.

public readonly adminRoles: IRole[];

• Type: aws-cdk-lib.aws_iam.IRole[]

A list of roles granted full R/W access to the Api.

apiKeyConfig^Optional

public readonly apiKeyConfig: ApiKeyAuthorizationConfig;

• Type: ApiKeyAuthorizationConfig

AppSync Api Key config, required if a 'apiKey' auth provider is specified in the Api.

Applies to 'public' auth strategy.

defaultAuthorizationMode^Optional

public readonly defaultAuthorizationMode: string;

• Type: string

Default auth mode to provide to the Api, required if more than one config type is specified.

iamConfig^Optional

public readonly iamConfig: IAMAuthorizationConfig;

• Type: IAMAuthorizationConfig

IAM Auth config, required if an 'iam' auth provider is specified in the Api.

Applies to 'public' and 'private' auth strategies.

lambdaConfig^Optional

public readonly lambdaConfig: LambdaAuthorizationConfig;

• Type: LambdaAuthorizationConfig

Lambda config, required if a 'function' auth provider is specified in the Api.

Applies to 'custom' auth strategy.

oidcConfig^Optional

public readonly oidcConfig: OIDCAuthorizationConfig;

• Type: OIDCAuthorizationConfig

Cognito OIDC config, required if a 'oidc' auth provider is specified in the Api.

Applies to 'owner', 'private', and 'group' auth strategies.

userPoolConfig^Optional

public readonly userPoolConfig: UserPoolAuthorizationConfig;

• Type: UserPoolAuthorizationConfig

Cognito UserPool config, required if a 'userPools' auth provider is specified in the Api.

Applies to 'owner', 'private', and 'group' auth strategies.

AutomergeConflictResolutionStrategy

Enable optimistic concurrency on the project.

Initializer

import { AutomergeConflictResolutionStrategy } from '@aws-amplify/graphql-api-construct'

const automergeConflictResolutionStrategy: AutomergeConflictResolutionStrategy = { ... }

Properties

detectionType^Required

public readonly detectionType: string;

• Type: string

The conflict detection type used for resolution.

handlerType^Required

public readonly handlerType: string;

• Type: string

This conflict resolution strategy executes an auto-merge.

For more information, refer to https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html#conflict-detection-and-resolution

ConflictResolution

Project level configuration for conflict resolution.

Initializer

import { ConflictResolution } from '@aws-amplify/graphql-api-construct'

const conflictResolution: ConflictResolution = { ... }

Properties

models^Optional

• Deprecated: use DataStoreConfiguration instead.

public readonly models: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy};

• Type: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy}

Model-specific conflict resolution overrides.

project^Optional

• Deprecated: use DataStoreConfiguration instead.

public readonly project: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy;

• Type: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy

Project-wide config for conflict resolution.

Applies to all non-overridden models.

ConflictResolutionStrategyBase

Common parameters for conflict resolution.

Initializer

import { ConflictResolutionStrategyBase } from '@aws-amplify/graphql-api-construct'

const conflictResolutionStrategyBase: ConflictResolutionStrategyBase = { ... }

Properties

detectionType^Required

public readonly detectionType: string;

• Type: string

The conflict detection type used for resolution.

CustomConflictResolutionStrategy

Enable custom sync on the project, powered by a lambda.

Initializer

import { CustomConflictResolutionStrategy } from '@aws-amplify/graphql-api-construct'

const customConflictResolutionStrategy: CustomConflictResolutionStrategy = { ... }

Properties

detectionType^Required

public readonly detectionType: string;

• Type: string

The conflict detection type used for resolution.

conflictHandler^Required

public readonly conflictHandler: IFunction;

• Type: aws-cdk-lib.aws_lambda.IFunction

The function which will be invoked for conflict resolution.

handlerType^Required

public readonly handlerType: string;

• Type: string

This conflict resolution strategy uses a lambda handler type.

For more information, refer to https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html#conflict-detection-and-resolution

CustomSqlDataSourceStrategy

The input type for defining a ModelDataSourceStrategy used to resolve a field annotated with a @sql directive.

Although this is a public type, you should rarely need to use this. The AmplifyGraphqlDefinition factory methods (e.g., fromString, fromFilesAndStrategy) will automatically construct this structure for you.

Initializer

import { CustomSqlDataSourceStrategy } from '@aws-amplify/graphql-api-construct'

const customSqlDataSourceStrategy: CustomSqlDataSourceStrategy = { ... }

Properties

fieldName^Required

public readonly fieldName: string;

• Type: string

The field name with which the custom SQL is associated.

strategy^Required

public readonly strategy: SQLLambdaModelDataSourceStrategy;

• Type: SQLLambdaModelDataSourceStrategy

The strategy used to create the datasource that will resolve the custom SQL statement.

typeName^Required

public readonly typeName: string;

• Type: string

The built-in type (either "Query" or "Mutation") with which the custom SQL is associated.

DataStoreConfiguration

Project level configuration for DataStore.

Initializer

import { DataStoreConfiguration } from '@aws-amplify/graphql-api-construct'

const dataStoreConfiguration: DataStoreConfiguration = { ... }

Properties

models^Optional

public readonly models: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy};

• Type: {[ key: string ]: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy}

Model-specific conflict resolution overrides.

project^Optional

public readonly project: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy;

• Type: AutomergeConflictResolutionStrategy | OptimisticConflictResolutionStrategy | CustomConflictResolutionStrategy

Project-wide config for conflict resolution.

Applies to all non-overridden models.

DefaultDynamoDbModelDataSourceStrategy

Use default CloudFormation type 'AWS::DynamoDB::Table' to provision table.

Initializer

import { DefaultDynamoDbModelDataSourceStrategy } from '@aws-amplify/graphql-api-construct'

const defaultDynamoDbModelDataSourceStrategy: DefaultDynamoDbModelDataSourceStrategy = { ... }

Properties

dbType^Required

public readonly dbType: string;

• Type: string

provisionStrategy^Required

public readonly provisionStrategy: string;

• Type: string

FunctionSlotBase

Common slot parameters.

Initializer

import { FunctionSlotBase } from '@aws-amplify/graphql-api-construct'

const functionSlotBase: FunctionSlotBase = { ... }

Properties

fieldName^Required

public readonly fieldName: string;

• Type: string

The field to attach this function to on the Api definition.

function^Required

public readonly function: FunctionSlotOverride;

• Type: FunctionSlotOverride

The overridden behavior for this slot.

slotIndex^Required

public readonly slotIndex: number;

• Type: number

The slot index to use to inject this into the execution pipeline.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

FunctionSlotOverride

Params exposed to support configuring and overriding pipelined slots.

This allows configuration of the underlying function, including the request and response mapping templates.

Initializer

import { FunctionSlotOverride } from '@aws-amplify/graphql-api-construct'

const functionSlotOverride: FunctionSlotOverride = { ... }

Properties

requestMappingTemplate^Optional

public readonly requestMappingTemplate: MappingTemplate;

• Type: aws-cdk-lib.aws_appsync.MappingTemplate

Override request mapping template for the function slot.

Executed before the datasource is invoked.

responseMappingTemplate^Optional

public readonly responseMappingTemplate: MappingTemplate;

• Type: aws-cdk-lib.aws_appsync.MappingTemplate

Override response mapping template for the function slot.

Executed after the datasource is invoked.

IAMAuthorizationConfig

Configuration for IAM Authorization on the Graphql Api.

Initializer

import { IAMAuthorizationConfig } from '@aws-amplify/graphql-api-construct'

const iAMAuthorizationConfig: IAMAuthorizationConfig = { ... }

Properties

authenticatedUserRole^Required

public readonly authenticatedUserRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole

Authenticated user role, applies to { provider: iam, allow: private } access.

identityPoolId^Required

public readonly identityPoolId: string;

• Type: string

ID for the Cognito Identity Pool vending auth and unauth roles.

Format: <region>:<id string>

unauthenticatedUserRole^Required

public readonly unauthenticatedUserRole: IRole;

• Type: aws-cdk-lib.aws_iam.IRole

Unauthenticated user role, applies to { provider: iam, allow: public } access.

allowListedRoles^Optional

public readonly allowListedRoles: string | IRole[];

• Type: string | aws-cdk-lib.aws_iam.IRole[]

A list of IAM roles which will be granted full read/write access to the generated model if IAM auth is enabled.

If an IRole is provided, the role name will be used for matching. If a string is provided, the raw value will be used for matching.

LambdaAuthorizationConfig

Configuration for Custom Lambda authorization on the Graphql Api.

Initializer

import { LambdaAuthorizationConfig } from '@aws-amplify/graphql-api-construct'

const lambdaAuthorizationConfig: LambdaAuthorizationConfig = { ... }

Properties

function^Required

public readonly function: IFunction;

• Type: aws-cdk-lib.aws_lambda.IFunction

The authorizer lambda function.

ttl^Required

public readonly ttl: Duration;

• Type: aws-cdk-lib.Duration

How long the results are cached.

MutationFunctionSlot

Slot types for Mutation Resolvers.

Initializer

import { MutationFunctionSlot } from '@aws-amplify/graphql-api-construct'

const mutationFunctionSlot: MutationFunctionSlot = { ... }

Properties

fieldName^Required

public readonly fieldName: string;

• Type: string

The field to attach this function to on the Api definition.

function^Required

public readonly function: FunctionSlotOverride;

• Type: FunctionSlotOverride

The overridden behavior for this slot.

slotIndex^Required

public readonly slotIndex: number;

• Type: number

The slot index to use to inject this into the execution pipeline.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

slotName^Required

public readonly slotName: string;

• Type: string

The slot name to inject this behavior into.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

typeName^Required

public readonly typeName: string;

• Type: string

This slot type applies to the Mutation type on the Api definition.

OIDCAuthorizationConfig

Configuration for OpenId Connect Authorization on the Graphql Api.

Initializer

import { OIDCAuthorizationConfig } from '@aws-amplify/graphql-api-construct'

const oIDCAuthorizationConfig: OIDCAuthorizationConfig = { ... }

Properties

oidcIssuerUrl^Required

public readonly oidcIssuerUrl: string;

• Type: string

Url for the OIDC token issuer.

oidcProviderName^Required

public readonly oidcProviderName: string;

• Type: string

The issuer for the OIDC configuration.

tokenExpiryFromAuth^Required

public readonly tokenExpiryFromAuth: Duration;

• Type: aws-cdk-lib.Duration

The duration an OIDC token is valid after being authenticated by OIDC provider.

auth_time claim in OIDC token is required for this validation to work.

tokenExpiryFromIssue^Required

public readonly tokenExpiryFromIssue: Duration;

• Type: aws-cdk-lib.Duration

The duration an OIDC token is valid after being issued to a user.

This validation uses iat claim of OIDC token.

clientId^Optional

public readonly clientId: string;

• Type: string

The client identifier of the Relying party at the OpenID identity provider.

A regular expression can be specified so AppSync can validate against multiple client identifiers at a time. Example

OptimisticConflictResolutionStrategy

Enable automerge on the project.

Initializer

import { OptimisticConflictResolutionStrategy } from '@aws-amplify/graphql-api-construct'

const optimisticConflictResolutionStrategy: OptimisticConflictResolutionStrategy = { ... }

Properties

detectionType^Required

public readonly detectionType: string;

• Type: string

The conflict detection type used for resolution.

handlerType^Required

public readonly handlerType: string;

• Type: string

This conflict resolution strategy the _version to perform optimistic concurrency.

For more information, refer to https://docs.aws.amazon.com/appsync/latest/devguide/conflict-detection-and-sync.html#conflict-detection-and-resolution

PartialTranslationBehavior

A utility interface equivalent to Partial.

Initializer

import { PartialTranslationBehavior } from '@aws-amplify/graphql-api-construct'

const partialTranslationBehavior: PartialTranslationBehavior = { ... }

Properties

allowDestructiveGraphqlSchemaUpdates^Optional

public readonly allowDestructiveGraphqlSchemaUpdates: boolean;

• Type: boolean
• Default: false

The following schema updates require replacement of the underlying DynamoDB table:.

Removing or renaming a model

• Modifying the primary key of a model
• Modifying a Local Secondary Index of a model (only applies to projects with secondaryKeyAsGSI turned off)

ALL DATA WILL BE LOST when the table replacement happens. When enabled, destructive updates are allowed. This will only affect DynamoDB tables with provision strategy "AMPLIFY_TABLE".

disableResolverDeduping^Optional

public readonly disableResolverDeduping: boolean;

• Type: boolean
• Default: true

Disable resolver deduping, this can sometimes cause problems because dedupe ordering isn't stable today, which can lead to circular dependencies across stacks if models are reordered.

enableAutoIndexQueryNames^Optional

public readonly enableAutoIndexQueryNames: boolean;

• Type: boolean
• Default: true

Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.

If enabled,

enableSearchNodeToNodeEncryption^Optional

public readonly enableSearchNodeToNodeEncryption: boolean;

• Type: boolean
• Default: false

If enabled, set nodeToNodeEncryption on the searchable domain (if one exists).

Not recommended for use, prefer to use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => { domain.NodeToNodeEncryptionOptions = { Enabled: True }; });

enableTransformerCfnOutputs^Optional

public readonly enableTransformerCfnOutputs: boolean;

• Type: boolean
• Default: false

When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.

populateOwnerFieldForStaticGroupAuth^Optional

public readonly populateOwnerFieldForStaticGroupAuth: boolean;

• Type: boolean
• Default: true

Ensure that the owner field is still populated even if a static iam or group authorization applies.

replaceTableUponGsiUpdate^Optional

public readonly replaceTableUponGsiUpdate: boolean;

• Type: boolean
• Default: false

This behavior will only come into effect when both "allowDestructiveGraphqlSchemaUpdates" and this value are set to true.

When enabled, any global secondary index update operation will replace the table instead of iterative deployment, which will WIPE ALL EXISTING DATA but cost much less time for deployment This will only affect DynamoDB tables with provision strategy "AMPLIFY_TABLE".

respectPrimaryKeyAttributesOnConnectionField^Optional

public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;

• Type: boolean
• Default: true

Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.

sandboxModeEnabled^Optional

public readonly sandboxModeEnabled: boolean;

• Type: boolean
• Default: false

Enabling sandbox mode will enable api key auth on all models in the transformed schema.

secondaryKeyAsGSI^Optional

public readonly secondaryKeyAsGSI: boolean;

• Type: boolean
• Default: true

If disabled, generated.

shouldDeepMergeDirectiveConfigDefaults^Optional

public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;

• Type: boolean
• Default: true

Restore parity w/ GQLv1.

suppressApiKeyGeneration^Optional

public readonly suppressApiKeyGeneration: boolean;

• Type: boolean
• Default: false

If enabled, disable api key resource generation even if specified as an auth rule on the construct.

This is a legacy parameter from the Graphql Transformer existing in Amplify CLI, not recommended to change.

useSubUsernameForDefaultIdentityClaim^Optional

public readonly useSubUsernameForDefaultIdentityClaim: boolean;

• Type: boolean
• Default: true

Ensure that oidc and userPool auth use the sub field in the for the username field, which disallows new users with the same id to access data from a deleted user in the pool.

ProvisionedConcurrencyConfig

The configuration for the provisioned concurrency of the Lambda.

Initializer

import { ProvisionedConcurrencyConfig } from '@aws-amplify/graphql-api-construct'

const provisionedConcurrencyConfig: ProvisionedConcurrencyConfig = { ... }

Properties

provisionedConcurrentExecutions^Required

public readonly provisionedConcurrentExecutions: number;

• Type: number

The amount of provisioned concurrency to allocate.

ProvisionedThroughput

Wrapper for provisioned throughput config in DDB.

Initializer

import { ProvisionedThroughput } from '@aws-amplify/graphql-api-construct'

const provisionedThroughput: ProvisionedThroughput = { ... }

Properties

readCapacityUnits^Required

public readonly readCapacityUnits: number;

• Type: number

The read capacity units on the table or index.

writeCapacityUnits^Required

public readonly writeCapacityUnits: number;

• Type: number

The write capacity units on the table or index.

QueryFunctionSlot

Slot types for Query Resolvers.

Initializer

import { QueryFunctionSlot } from '@aws-amplify/graphql-api-construct'

const queryFunctionSlot: QueryFunctionSlot = { ... }

Properties

fieldName^Required

public readonly fieldName: string;

• Type: string

The field to attach this function to on the Api definition.

function^Required

public readonly function: FunctionSlotOverride;

• Type: FunctionSlotOverride

The overridden behavior for this slot.

slotIndex^Required

public readonly slotIndex: number;

• Type: number

The slot index to use to inject this into the execution pipeline.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

slotName^Required

public readonly slotName: string;

• Type: string

The slot name to inject this behavior into.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

typeName^Required

public readonly typeName: string;

• Type: string

This slot type applies to the Query type on the Api definition.

SQLLambdaModelDataSourceStrategy

A strategy that creates a Lambda to connect to a pre-existing SQL table to resolve model data.

Initializer

import { SQLLambdaModelDataSourceStrategy } from '@aws-amplify/graphql-api-construct'

const sQLLambdaModelDataSourceStrategy: SQLLambdaModelDataSourceStrategy = { ... }

Properties

dbConnectionConfig^Required

public readonly dbConnectionConfig: SqlModelDataSourceSecretsManagerDbConnectionConfig | SqlModelDataSourceSsmDbConnectionConfig;

• Type: SqlModelDataSourceSecretsManagerDbConnectionConfig | SqlModelDataSourceSsmDbConnectionConfig

The parameters the Lambda data source will use to connect to the database.

dbType^Required

public readonly dbType: string;

• Type: string

The type of the SQL database used to process model operations for this definition.

name^Required

public readonly name: string;

• Type: string

The name of the strategy.

This will be used to name the AppSync DataSource itself, plus any associated resources like resolver Lambdas. This name must be unique across all schema definitions in a GraphQL API.

customSqlStatements^Optional

public readonly customSqlStatements: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Custom SQL statements.

The key is the value of the references attribute of the @sql directive in the schema; the value is the SQL to be executed.

sqlLambdaProvisionedConcurrencyConfig^Optional

public readonly sqlLambdaProvisionedConcurrencyConfig: ProvisionedConcurrencyConfig;

• Type: ProvisionedConcurrencyConfig

The configuration for the provisioned concurrency of the Lambda.

vpcConfiguration^Optional

public readonly vpcConfiguration: VpcConfig;

• Type: VpcConfig

The configuration of the VPC into which to install the Lambda.

SqlModelDataSourceSecretsManagerDbConnectionConfig

The credentials stored in Secrets Manager that the lambda data source will use to connect to the database.

The managed secret should be in the same region as the lambda.

Initializer

import { SqlModelDataSourceSecretsManagerDbConnectionConfig } from '@aws-amplify/graphql-api-construct'

const sqlModelDataSourceSecretsManagerDbConnectionConfig: SqlModelDataSourceSecretsManagerDbConnectionConfig = { ... }

Properties

databaseName^Required

public readonly databaseName: string;

• Type: string

The database name.

hostname^Required

public readonly hostname: string;

• Type: string

The hostame of the database.

port^Required

public readonly port: number;

• Type: number

The port number of the database proxy, cluster, or instance.

secretArn^Required

public readonly secretArn: string;

• Type: string

The ARN of the managed secret with username, password, and hostname to use when connecting to the database.

keyArn^Optional

public readonly keyArn: string;

• Type: string

The ARN of the customer managed encryption key for the secret.

If not supplied, the secret is expected to be encrypted with the default AWS-managed key. *

SqlModelDataSourceSsmDbConnectionConfig

The Secure Systems Manager parameter paths the Lambda data source will use to connect to the database.

These parameters are retrieved from Secure Systems Manager in the same region as the Lambda.

Initializer

import { SqlModelDataSourceSsmDbConnectionConfig } from '@aws-amplify/graphql-api-construct'

const sqlModelDataSourceSsmDbConnectionConfig: SqlModelDataSourceSsmDbConnectionConfig = { ... }

Properties

databaseNameSsmPath^Required

public readonly databaseNameSsmPath: string;

• Type: string

The Secure Systems Manager parameter containing the database name.

hostnameSsmPath^Required

public readonly hostnameSsmPath: string;

• Type: string

The Secure Systems Manager parameter containing the hostname of the database.

For RDS-based SQL data sources, this can be the hostname of a database proxy, cluster, or instance.

passwordSsmPath^Required

public readonly passwordSsmPath: string;

• Type: string

The Secure Systems Manager parameter containing the password to use when connecting to the database.

portSsmPath^Required

public readonly portSsmPath: string;

• Type: string

The Secure Systems Manager parameter containing the port number of the database proxy, cluster, or instance.

usernameSsmPath^Required

public readonly usernameSsmPath: string;

• Type: string

The Secure Systems Manager parameter containing the username to use when connecting to the database.

SSESpecification

Represents the settings used to enable server-side encryption.

Initializer

import { SSESpecification } from '@aws-amplify/graphql-api-construct'

const sSESpecification: SSESpecification = { ... }

Properties

sseEnabled^Required

public readonly sseEnabled: boolean;

• Type: boolean

Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key.

If enabled (true), server-side encryption type is set to KMS and an AWS managed key is used ( AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.

kmsMasterKeyId^Optional

public readonly kmsMasterKeyId: string;

• Type: string

The AWS KMS key that should be used for the AWS KMS encryption.

To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb .

sseType^Optional

public readonly sseType: SSEType;

• Type: SSEType

Server-side encryption type.

The only supported value is: KMS Server-side encryption that uses AWS Key Management Service. The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).

StreamSpecification

Represents the DynamoDB Streams configuration for a table in DynamoDB.

Initializer

import { StreamSpecification } from '@aws-amplify/graphql-api-construct'

const streamSpecification: StreamSpecification = { ... }

Properties

streamViewType^Required

public readonly streamViewType: StreamViewType;

• Type: aws-cdk-lib.aws_dynamodb.StreamViewType

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Valid values for StreamViewType are:

• KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
• NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
• OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
• NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

SubnetAvailabilityZone

Subnet configuration for VPC endpoints used by a Lambda resolver for a SQL-based data source.

Although it is possible to create multiple subnets in a single availability zone, VPC service endpoints may only be deployed to a single subnet in a given availability zone. This structure ensures that the Lambda function and VPC service endpoints are mutually consistent.

Initializer

import { SubnetAvailabilityZone } from '@aws-amplify/graphql-api-construct'

const subnetAvailabilityZone: SubnetAvailabilityZone = { ... }

Properties

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

The availability zone of the subnet.

subnetId^Required

public readonly subnetId: string;

• Type: string

The subnet ID to install the Lambda data source in.

SubscriptionFunctionSlot

Slot types for Subscription Resolvers.

Initializer

import { SubscriptionFunctionSlot } from '@aws-amplify/graphql-api-construct'

const subscriptionFunctionSlot: SubscriptionFunctionSlot = { ... }

Properties

fieldName^Required

public readonly fieldName: string;

• Type: string

The field to attach this function to on the Api definition.

function^Required

public readonly function: FunctionSlotOverride;

• Type: FunctionSlotOverride

The overridden behavior for this slot.

slotIndex^Required

public readonly slotIndex: number;

• Type: number

The slot index to use to inject this into the execution pipeline.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

slotName^Required

public readonly slotName: string;

• Type: string

The slot name to inject this behavior into.

For more information on slotting, refer to https://docs.amplify.aws/cli/graphql/custom-business-logic/#extend-amplify-generated-resolvers

typeName^Required

public readonly typeName: string;

• Type: string

This slot type applies to the Subscription type on the Api definition.

TimeToLiveSpecification

Shape for TTL config.

Initializer

import { TimeToLiveSpecification } from '@aws-amplify/graphql-api-construct'

const timeToLiveSpecification: TimeToLiveSpecification = { ... }

Properties

enabled^Required

public readonly enabled: boolean;

• Type: boolean

Boolean determining if the ttl is enabled or not.

attributeName^Optional

public readonly attributeName: string;

• Type: string

Attribute name to apply to the ttl spec.

TranslationBehavior

Strongly typed set of shared parameters for all transformers, and core layer.

This is intended to replace feature flags, to ensure param coercion happens in a single location, and isn't spread around the transformers, where they can have different default behaviors.

Initializer

import { TranslationBehavior } from '@aws-amplify/graphql-api-construct'

const translationBehavior: TranslationBehavior = { ... }

Properties

allowDestructiveGraphqlSchemaUpdates^Required

public readonly allowDestructiveGraphqlSchemaUpdates: boolean;

• Type: boolean
• Default: false

The following schema updates require replacement of the underlying DynamoDB table:.

Removing or renaming a model

• Modifying the primary key of a model
• Modifying a Local Secondary Index of a model (only applies to projects with secondaryKeyAsGSI turned off)

ALL DATA WILL BE LOST when the table replacement happens. When enabled, destructive updates are allowed. This will only affect DynamoDB tables with provision strategy "AMPLIFY_TABLE".

disableResolverDeduping^Required

public readonly disableResolverDeduping: boolean;

• Type: boolean
• Default: true

Disable resolver deduping, this can sometimes cause problems because dedupe ordering isn't stable today, which can lead to circular dependencies across stacks if models are reordered.

enableAutoIndexQueryNames^Required

public readonly enableAutoIndexQueryNames: boolean;

• Type: boolean
• Default: true

Automate generation of query names, and as a result attaching all indexes as queries to the generated Api.

If enabled,

enableSearchNodeToNodeEncryption^Required

public readonly enableSearchNodeToNodeEncryption: boolean;

• Type: boolean

enableTransformerCfnOutputs^Required

public readonly enableTransformerCfnOutputs: boolean;

• Type: boolean
• Default: false

When enabled, internal cfn outputs which existed in Amplify-generated apps will continue to be emitted.

populateOwnerFieldForStaticGroupAuth^Required

public readonly populateOwnerFieldForStaticGroupAuth: boolean;

• Type: boolean
• Default: true

Ensure that the owner field is still populated even if a static iam or group authorization applies.

replaceTableUponGsiUpdate^Required

public readonly replaceTableUponGsiUpdate: boolean;

• Type: boolean
• Default: false

This behavior will only come into effect when both "allowDestructiveGraphqlSchemaUpdates" and this value are set to true.

When enabled, any GSI update operation will replace the table instead of iterative deployment, which will WIPE ALL EXISTING DATA but cost much less time for deployment This will only affect DynamoDB tables with provision strategy "AMPLIFY_TABLE".

respectPrimaryKeyAttributesOnConnectionField^Required

public readonly respectPrimaryKeyAttributesOnConnectionField: boolean;

• Type: boolean
• Default: true

Enable custom primary key support, there's no good reason to disable this unless trying not to update a legacy app.

sandboxModeEnabled^Required

public readonly sandboxModeEnabled: boolean;

• Type: boolean
• Default: false

Enabling sandbox mode will enable api key auth on all models in the transformed schema.

secondaryKeyAsGSI^Required

public readonly secondaryKeyAsGSI: boolean;

• Type: boolean
• Default: true

If disabled, generated.

shouldDeepMergeDirectiveConfigDefaults^Required

public readonly shouldDeepMergeDirectiveConfigDefaults: boolean;

• Type: boolean
• Default: true

Restore parity w/ GQLv1.

suppressApiKeyGeneration^Required

public readonly suppressApiKeyGeneration: boolean;

• Type: boolean
• Default: false

If enabled, disable api key resource generation even if specified as an auth rule on the construct.

This is a legacy parameter from the Graphql Transformer existing in Amplify CLI, not recommended to change.

useSubUsernameForDefaultIdentityClaim^Required

public readonly useSubUsernameForDefaultIdentityClaim: boolean;

• Type: boolean
• Default: true

Ensure that oidc and userPool auth use the sub field in the for the username field, which disallows new users with the same id to access data from a deleted user in the pool.

UserPoolAuthorizationConfig

Configuration for Cognito UserPool Authorization on the Graphql Api.

Initializer

import { UserPoolAuthorizationConfig } from '@aws-amplify/graphql-api-construct'

const userPoolAuthorizationConfig: UserPoolAuthorizationConfig = { ... }

Properties

userPool^Required

public readonly userPool: IUserPool;

• Type: aws-cdk-lib.aws_cognito.IUserPool

The Cognito User Pool which is used to authenticated JWT tokens, and vends group and user information.

VpcConfig

Configuration of the VPC in which to install a Lambda to resolve queries against a SQL-based data source.

The SQL Lambda will be deployed into the specified VPC, subnets, and security groups. The specified subnets and security groups must be in the same VPC. The VPC must have at least one subnet. The construct will also create VPC service endpoints in the specified subnets, as well as inbound security rules, to allow traffic on port 443 within each security group. This allows the Lambda to read database connection information from Secure Systems Manager.

Initializer

import { VpcConfig } from '@aws-amplify/graphql-api-construct'

const vpcConfig: VpcConfig = { ... }

Properties

securityGroupIds^Required

public readonly securityGroupIds: string[];

• Type: string[]

The security groups to install the Lambda data source in.

subnetAvailabilityZoneConfig^Required

public readonly subnetAvailabilityZoneConfig: SubnetAvailabilityZone[];

• Type: SubnetAvailabilityZone[]

The subnets to install the Lambda data source in, one per availability zone.

vpcId^Required

public readonly vpcId: string;

• Type: string

The VPC to install the Lambda data source in.

Classes

AmplifyDynamoDbTableWrapper

Wrapper class around Custom::AmplifyDynamoDBTable custom resource, to simplify the override experience a bit.

This is NOT a construct, just an easier way to access the generated construct. This is a wrapper intended to mimic the aws_cdk_lib.aws_dynamodb.Table functionality more-or-less. Notable differences is the addition of TKTK properties, to account for the fact that they're constructor props in the CDK construct, as well as the removal of all from*, grant*, and metric* methods implemented by Table.

Initializers

import { AmplifyDynamoDbTableWrapper } from '@aws-amplify/graphql-api-construct'

new AmplifyDynamoDbTableWrapper(resource: CfnResource)

resource^Required

• Type: aws-cdk-lib.CfnResource

the Cfn resource.

Methods

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

Set the deletion policy of the resource based on the removal policy specified.

policy^Required

• Type: aws-cdk-lib.RemovalPolicy

removal policy to set.

setGlobalSecondaryIndexProvisionedThroughput

public setGlobalSecondaryIndexProvisionedThroughput(indexName: string, provisionedThroughput: ProvisionedThroughput): void

Set the provisionedThroughtput for a specified GSI by name.

indexName^Required

• Type: string

the index to specify a provisionedThroughput config for.

provisionedThroughput^Required

• Type: ProvisionedThroughput

the config to set.

Static Functions

isAmplifyDynamoDbTableResource

import { AmplifyDynamoDbTableWrapper } from '@aws-amplify/graphql-api-construct'

AmplifyDynamoDbTableWrapper.isAmplifyDynamoDbTableResource(x: any)

Return true and perform type narrowing if a given input appears to be capable of.

x^Required

• Type: any

the object to check.

Properties

billingMode^Required

public readonly billingMode: BillingMode;

• Type: aws-cdk-lib.aws_dynamodb.BillingMode

Specify how you are charged for read and write throughput and how you manage capacity.

deletionProtectionEnabled^Required

public readonly deletionProtectionEnabled: boolean;

• Type: boolean

Set table deletion protection.

pointInTimeRecoveryEnabled^Required

public readonly pointInTimeRecoveryEnabled: boolean;

• Type: boolean

Whether point-in-time recovery is enabled.

provisionedThroughput^Required

public readonly provisionedThroughput: ProvisionedThroughput;

• Type: ProvisionedThroughput

Update the provisioned throughput for the base table.

sseSpecification^Required

public readonly sseSpecification: SSESpecification;

• Type: SSESpecification

Set the ddb server-side encryption specification on the table.

streamSpecification^Required

public readonly streamSpecification: StreamSpecification;

• Type: StreamSpecification

Set the ddb stream specification on the table.

timeToLiveAttribute^Required

public readonly timeToLiveAttribute: TimeToLiveSpecification;

• Type: TimeToLiveSpecification

The name of TTL attribute.

AmplifyGraphqlDefinition

Class exposing utilities to produce IAmplifyGraphqlDefinition objects given various inputs.

Initializers

import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'

new AmplifyGraphqlDefinition()

Static Functions

combine

import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'

AmplifyGraphqlDefinition.combine(definitions: IAmplifyGraphqlDefinition[])

Combines multiple IAmplifyGraphqlDefinitions into a single definition.

definitions^Required

• Type: IAmplifyGraphqlDefinition[]

the definitions to combine.

fromFiles

import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'

AmplifyGraphqlDefinition.fromFiles(filePaths: string)

Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema, binding them to a DynamoDB data source.

filePaths^Required

• Type: string

one or more paths to the graphql files to process.

fromFilesAndStrategy

import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'

AmplifyGraphqlDefinition.fromFilesAndStrategy(filePaths: string | string[], dataSourceStrategy?: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy)

Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.

filePaths^Required

• Type: string | string[]

one or more paths to the graphql files to process.

dataSourceStrategy^Optional

• Type: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy

the provisioning definition for datasources that resolve @models in this schema.

The DynamoDB from CloudFormation will be used by default.

fromString

import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'

AmplifyGraphqlDefinition.fromString(schema: string, dataSourceStrategy?: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy)

Produce a schema definition from a string input.

schema^Required

• Type: string

the graphql input as a string.

dataSourceStrategy^Optional

• Type: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy

the provisioning definition for datasources that resolve @models and custom SQL statements in this schema.

The DynamoDB from CloudFormation will be used by default.

SQLLambdaModelDataSourceStrategyFactory

Class exposing utilities to produce SQLLambdaModelDataSourceStrategy objects given various inputs.

Initializers

import { SQLLambdaModelDataSourceStrategyFactory } from '@aws-amplify/graphql-api-construct'

new SQLLambdaModelDataSourceStrategyFactory()

Static Functions

fromCustomSqlFiles

import { SQLLambdaModelDataSourceStrategyFactory } from '@aws-amplify/graphql-api-construct'

SQLLambdaModelDataSourceStrategyFactory.fromCustomSqlFiles(sqlFiles: string[], options: SQLLambdaModelDataSourceStrategy)

Creates a SQLLambdaModelDataSourceStrategy where the binding's customSqlStatements are populated from sqlFiles.

The key of the customSqlStatements record is the file's base name (that is, the name of the file minus the directory and extension).

sqlFiles^Required

• Type: string[]

the list of files to load SQL statements from.

options^Required

• Type: SQLLambdaModelDataSourceStrategy

the remaining SQLLambdaModelDataSourceStrategy options.

Protocols

IAmplifyGraphqlDefinition

• Implemented By: IAmplifyGraphqlDefinition

Graphql Api definition, which can be implemented in multiple ways.

Properties