@aws-amplify/graphql-api-construct 1.4.0-construct-publish-test.0 → 1.4.0-nov-14-cut-1.0

package/README.md

@@ -1,6 +1,6 @@
 # Amplify Graphql API Construct
 
-[![View on Construct Hub](https://constructs.dev/badge?package=%40aws-amplify%2Fgraphql-construct-alpha)](https://constructs.dev/packages/@aws-amplify/graphql-api-construct)
+[![View on Construct Hub](https://constructs.dev/badge?package=%40aws-amplify%2Fgraphql-api-construct)](https://constructs.dev/packages/@aws-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](https://docs.amplify.aws/cli/graphql/overview/).
 
@@ -81,9 +81,9 @@ new AmplifyGraphqlApi(stack, 'BlogApp', {
 });
 ```
 
-### Import GraphQL Schema from files, instead of inline.
+### Import GraphQL Schema from files, instead of inline
 
-In this example, we import the schema definition itself from one or more local file, rather than an inline graphql string.
+In this example, we import the schema definition itself from one or more local files, rather than an inline graphql string.
 
 ```graphql
 # todo.graphql
@@ -132,6 +132,8 @@ new AmplifyGraphqlApi(stack, 'MultiFileDefinition', {
 });
 ```
 
+> **NOTE** The 'dataSourceStrategies' configuration option is in preview and is not recommended to use with production systems.
+
 # API Reference <a name="API Reference" id="api-reference"></a>
 
 ## Constructs <a name="Constructs" id="Constructs"></a>
@@ -812,28 +814,28 @@ The functions runtime.
 
 ---
 
-### AmplifyDynamoDbModelDataSourceDefinitionStrategy <a name="AmplifyDynamoDbModelDataSourceDefinitionStrategy" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy"></a>
+### AmplifyDynamoDbModelDataSourceStrategy <a name="AmplifyDynamoDbModelDataSourceStrategy" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy"></a>
 
 Use custom resource type 'Custom::AmplifyDynamoDBTable' to provision table.
 
-#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.Initializer"></a>
+#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy.Initializer"></a>
 
 ```typescript
-import { AmplifyDynamoDbModelDataSourceDefinitionStrategy } from '@aws-amplify/graphql-api-construct'
+import { AmplifyDynamoDbModelDataSourceStrategy } from '@aws-amplify/graphql-api-construct'
 
-const amplifyDynamoDbModelDataSourceDefinitionStrategy: AmplifyDynamoDbModelDataSourceDefinitionStrategy = { ... }
+const amplifyDynamoDbModelDataSourceStrategy: AmplifyDynamoDbModelDataSourceStrategy = { ... }
 ```
 
 #### Properties <a name="Properties" id="Properties"></a>
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.dbType">dbType</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy">provisionStrategy</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy.property.dbType">dbType</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy.property.provisionStrategy">provisionStrategy</a></code> | <code>string</code> | *No description.* |
 
 ---
 
-##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.dbType"></a>
+##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy.property.dbType"></a>
 
 ```typescript
 public readonly dbType: string;
@@ -843,7 +845,7 @@ public readonly dbType: string;
 
 ---
 
-##### `provisionStrategy`<sup>Required</sup> <a name="provisionStrategy" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy"></a>
+##### `provisionStrategy`<sup>Required</sup> <a name="provisionStrategy" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy.property.provisionStrategy"></a>
 
 ```typescript
 public readonly provisionStrategy: string;
@@ -1659,28 +1661,28 @@ For more information, refer to https://docs.aws.amazon.com/appsync/latest/devgui
 
 ---
 
-### DefaultDynamoDbModelDataSourceDefinitionStrategy <a name="DefaultDynamoDbModelDataSourceDefinitionStrategy" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy"></a>
+### DefaultDynamoDbModelDataSourceStrategy <a name="DefaultDynamoDbModelDataSourceStrategy" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy"></a>
 
 Use default CloudFormation type 'AWS::DynamoDB::Table' to provision table.
 
-#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.Initializer"></a>
+#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy.Initializer"></a>
 
 ```typescript
-import { DefaultDynamoDbModelDataSourceDefinitionStrategy } from '@aws-amplify/graphql-api-construct'
+import { DefaultDynamoDbModelDataSourceStrategy } from '@aws-amplify/graphql-api-construct'
 
-const defaultDynamoDbModelDataSourceDefinitionStrategy: DefaultDynamoDbModelDataSourceDefinitionStrategy = { ... }
+const defaultDynamoDbModelDataSourceStrategy: DefaultDynamoDbModelDataSourceStrategy = { ... }
 ```
 
 #### Properties <a name="Properties" id="Properties"></a>
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.dbType">dbType</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy">provisionStrategy</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy.property.dbType">dbType</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy.property.provisionStrategy">provisionStrategy</a></code> | <code>string</code> | *No description.* |
 
 ---
 
-##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.dbType"></a>
+##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy.property.dbType"></a>
 
 ```typescript
 public readonly dbType: string;
@@ -1690,7 +1692,7 @@ public readonly dbType: string;
 
 ---
 
-##### `provisionStrategy`<sup>Required</sup> <a name="provisionStrategy" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy.property.provisionStrategy"></a>
+##### `provisionStrategy`<sup>Required</sup> <a name="provisionStrategy" id="@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy.property.provisionStrategy"></a>
 
 ```typescript
 public readonly provisionStrategy: string;
@@ -1933,54 +1935,6 @@ How long the results are cached.
 
 ---
 
-### ModelDataSourceDefinition <a name="ModelDataSourceDefinition" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition"></a>
-
-Defines a datasource for resolving GraphQL operations against `@model` types in a GraphQL schema.
-
-#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.Initializer"></a>
-
-```typescript
-import { ModelDataSourceDefinition } from '@aws-amplify/graphql-api-construct'
-
-const modelDataSourceDefinition: ModelDataSourceDefinition = { ... }
-```
-
-#### Properties <a name="Properties" id="Properties"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.name">name</a></code> | <code>string</code> | The name of the ModelDataSource. |
-| <code><a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.strategy">strategy</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy">DefaultDynamoDbModelDataSourceDefinitionStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy">AmplifyDynamoDbModelDataSourceDefinitionStrategy</a></code> | The ModelDataSourceDefinitionStrategy. |
-
----
-
-##### `name`<sup>Required</sup> <a name="name" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.name"></a>
-
-```typescript
-public readonly name: string;
-```
-
-- *Type:* string
-
-The name of the ModelDataSource.
-
-This will be used to name the AppSynce DataSource itself, plus any associated resources like resolver
-Lambdas, custom CDK resources. This name must be unique across all schema definitions in a GraphQL API.
-
----
-
-##### `strategy`<sup>Required</sup> <a name="strategy" id="@aws-amplify/graphql-api-construct.ModelDataSourceDefinition.property.strategy"></a>
-
-```typescript
-public readonly strategy: DefaultDynamoDbModelDataSourceDefinitionStrategy | AmplifyDynamoDbModelDataSourceDefinitionStrategy;
-```
-
-- *Type:* <a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceDefinitionStrategy">DefaultDynamoDbModelDataSourceDefinitionStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceDefinitionStrategy">AmplifyDynamoDbModelDataSourceDefinitionStrategy</a>
-
-The ModelDataSourceDefinitionStrategy.
-
----
-
 ### MutationFunctionSlot <a name="MutationFunctionSlot" id="@aws-amplify/graphql-api-construct.MutationFunctionSlot"></a>
 
 Slot types for Mutation Resolvers.
@@ -2222,6 +2176,7 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.allowDestructiveGraphqlSchemaUpdates">allowDestructiveGraphqlSchemaUpdates</a></code> | <code>boolean</code> | The following schema updates require replacement of the underlying DynamoDB table:. |
 | <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.disableResolverDeduping">disableResolverDeduping</a></code> | <code>boolean</code> | 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. |
 | <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableAutoIndexQueryNames">enableAutoIndexQueryNames</a></code> | <code>boolean</code> | Automate generation of query names, and as a result attaching all indexes as queries to the generated Api. |
 | <code><a href="#@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | If enabled, set nodeToNodeEncryption on the searchable domain (if one exists). |
@@ -2236,6 +2191,26 @@ const partialTranslationBehavior: PartialTranslationBehavior = { ... }
 
 ---
 
+##### `allowDestructiveGraphqlSchemaUpdates`<sup>Optional</sup> <a name="allowDestructiveGraphqlSchemaUpdates" id="@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.allowDestructiveGraphqlSchemaUpdates"></a>
+
+```typescript
+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`<sup>Optional</sup> <a name="disableResolverDeduping" id="@aws-amplify/graphql-api-construct.PartialTranslationBehavior.property.disableResolverDeduping"></a>
 
 ```typescript
@@ -2521,6 +2496,198 @@ This slot type applies to the Query type on the Api definition.
 
 ---
 
+### SQLLambdaModelDataSourceStrategy <a name="SQLLambdaModelDataSourceStrategy" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy"></a>
+
+A strategy that creates a Lambda to connect to a pre-existing SQL table to resolve model data.
+
+#### Initializer <a name="Initializer" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.Initializer"></a>
+
+```typescript
+import { SQLLambdaModelDataSourceStrategy } from '@aws-amplify/graphql-api-construct'
+
+const sQLLambdaModelDataSourceStrategy: SQLLambdaModelDataSourceStrategy = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.dbConnectionConfig">dbConnectionConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig">SqlModelDataSourceDbConnectionConfig</a></code> | The parameters the Lambda data source will use to connect to the database. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.dbType">dbType</a></code> | <code>string</code> | The type of the SQL database used to process model operations for this definition. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.name">name</a></code> | <code>string</code> | The name of the strategy. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.customSqlStatements">customSqlStatements</a></code> | <code>{[ key: string ]: string}</code> | Custom SQL statements. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.sqlLambdaLayerMapping">sqlLambdaLayerMapping</a></code> | <code>{[ key: string ]: string}</code> | An optional override for the default SQL Lambda Layer. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.vpcConfiguration">vpcConfiguration</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.VpcConfig">VpcConfig</a></code> | The configuration of the VPC into which to install the Lambda. |
+
+---
+
+##### `dbConnectionConfig`<sup>Required</sup> <a name="dbConnectionConfig" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.dbConnectionConfig"></a>
+
+```typescript
+public readonly dbConnectionConfig: SqlModelDataSourceDbConnectionConfig;
+```
+
+- *Type:* <a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig">SqlModelDataSourceDbConnectionConfig</a>
+
+The parameters the Lambda data source will use to connect to the database.
+
+---
+
+##### `dbType`<sup>Required</sup> <a name="dbType" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.dbType"></a>
+
+```typescript
+public readonly dbType: string;
+```
+
+- *Type:* string
+
+The type of the SQL database used to process model operations for this definition.
+
+---
+
+##### `name`<sup>Required</sup> <a name="name" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.name"></a>
+
+```typescript
+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`<sup>Optional</sup> <a name="customSqlStatements" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.customSqlStatements"></a>
+
+```typescript
+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.
+
+---
+
+##### `sqlLambdaLayerMapping`<sup>Optional</sup> <a name="sqlLambdaLayerMapping" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.sqlLambdaLayerMapping"></a>
+
+```typescript
+public readonly sqlLambdaLayerMapping: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+
+An optional override for the default SQL Lambda Layer.
+
+---
+
+##### `vpcConfiguration`<sup>Optional</sup> <a name="vpcConfiguration" id="@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy.property.vpcConfiguration"></a>
+
+```typescript
+public readonly vpcConfiguration: VpcConfig;
+```
+
+- *Type:* <a href="#@aws-amplify/graphql-api-construct.VpcConfig">VpcConfig</a>
+
+The configuration of the VPC into which to install the Lambda.
+
+---
+
+### SqlModelDataSourceDbConnectionConfig <a name="SqlModelDataSourceDbConnectionConfig" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig"></a>
+
+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 <a name="Initializer" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.Initializer"></a>
+
+```typescript
+import { SqlModelDataSourceDbConnectionConfig } from '@aws-amplify/graphql-api-construct'
+
+const sqlModelDataSourceDbConnectionConfig: SqlModelDataSourceDbConnectionConfig = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.databaseNameSsmPath">databaseNameSsmPath</a></code> | <code>string</code> | The Secure Systems Manager parameter containing the database name. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.hostnameSsmPath">hostnameSsmPath</a></code> | <code>string</code> | The Secure Systems Manager parameter containing the hostname of the database. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.passwordSsmPath">passwordSsmPath</a></code> | <code>string</code> | The Secure Systems Manager parameter containing the password to use when connecting to the database. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.portSsmPath">portSsmPath</a></code> | <code>string</code> | The Secure Systems Manager parameter containing the port number of the database proxy, cluster, or instance. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.usernameSsmPath">usernameSsmPath</a></code> | <code>string</code> | The Secure Systems Manager parameter containing the username to use when connecting to the database. |
+
+---
+
+##### `databaseNameSsmPath`<sup>Required</sup> <a name="databaseNameSsmPath" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.databaseNameSsmPath"></a>
+
+```typescript
+public readonly databaseNameSsmPath: string;
+```
+
+- *Type:* string
+
+The Secure Systems Manager parameter containing the database name.
+
+---
+
+##### `hostnameSsmPath`<sup>Required</sup> <a name="hostnameSsmPath" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.hostnameSsmPath"></a>
+
+```typescript
+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`<sup>Required</sup> <a name="passwordSsmPath" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.passwordSsmPath"></a>
+
+```typescript
+public readonly passwordSsmPath: string;
+```
+
+- *Type:* string
+
+The Secure Systems Manager parameter containing the password to use when connecting to the database.
+
+---
+
+##### `portSsmPath`<sup>Required</sup> <a name="portSsmPath" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.portSsmPath"></a>
+
+```typescript
+public readonly portSsmPath: string;
+```
+
+- *Type:* string
+
+The Secure Systems Manager parameter containing the port number of the database proxy, cluster, or instance.
+
+---
+
+##### `usernameSsmPath`<sup>Required</sup> <a name="usernameSsmPath" id="@aws-amplify/graphql-api-construct.SqlModelDataSourceDbConnectionConfig.property.usernameSsmPath"></a>
+
+```typescript
+public readonly usernameSsmPath: string;
+```
+
+- *Type:* string
+
+The Secure Systems Manager parameter containing the username to use when connecting to the database.
+
+---
+
 ### SSESpecification <a name="SSESpecification" id="@aws-amplify/graphql-api-construct.SSESpecification"></a>
 
 Represents the settings used to enable server-side encryption.
@@ -2627,6 +2794,55 @@ Valid values for `StreamViewType` are:
 
 ---
 
+### SubnetAvailabilityZone <a name="SubnetAvailabilityZone" id="@aws-amplify/graphql-api-construct.SubnetAvailabilityZone"></a>
+
+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 <a name="Initializer" id="@aws-amplify/graphql-api-construct.SubnetAvailabilityZone.Initializer"></a>
+
+```typescript
+import { SubnetAvailabilityZone } from '@aws-amplify/graphql-api-construct'
+
+const subnetAvailabilityZone: SubnetAvailabilityZone = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@aws-amplify/graphql-api-construct.SubnetAvailabilityZone.property.availabilityZone">availabilityZone</a></code> | <code>string</code> | The availability zone of the subnet. |
+| <code><a href="#@aws-amplify/graphql-api-construct.SubnetAvailabilityZone.property.subnetId">subnetId</a></code> | <code>string</code> | The subnet ID to install the Lambda data source in. |
+
+---
+
+##### `availabilityZone`<sup>Required</sup> <a name="availabilityZone" id="@aws-amplify/graphql-api-construct.SubnetAvailabilityZone.property.availabilityZone"></a>
+
+```typescript
+public readonly availabilityZone: string;
+```
+
+- *Type:* string
+
+The availability zone of the subnet.
+
+---
+
+##### `subnetId`<sup>Required</sup> <a name="subnetId" id="@aws-amplify/graphql-api-construct.SubnetAvailabilityZone.property.subnetId"></a>
+
+```typescript
+public readonly subnetId: string;
+```
+
+- *Type:* string
+
+The subnet ID to install the Lambda data source in.
+
+---
+
 ### SubscriptionFunctionSlot <a name="SubscriptionFunctionSlot" id="@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot"></a>
 
 Slot types for Subscription Resolvers.
@@ -2780,6 +2996,7 @@ const translationBehavior: TranslationBehavior = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.allowDestructiveGraphqlSchemaUpdates">allowDestructiveGraphqlSchemaUpdates</a></code> | <code>boolean</code> | The following schema updates require replacement of the underlying DynamoDB table:. |
 | <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.disableResolverDeduping">disableResolverDeduping</a></code> | <code>boolean</code> | 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. |
 | <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableAutoIndexQueryNames">enableAutoIndexQueryNames</a></code> | <code>boolean</code> | Automate generation of query names, and as a result attaching all indexes as queries to the generated Api. |
 | <code><a href="#@aws-amplify/graphql-api-construct.TranslationBehavior.property.enableSearchNodeToNodeEncryption">enableSearchNodeToNodeEncryption</a></code> | <code>boolean</code> | *No description.* |
@@ -2794,6 +3011,26 @@ const translationBehavior: TranslationBehavior = { ... }
 
 ---
 
+##### `allowDestructiveGraphqlSchemaUpdates`<sup>Required</sup> <a name="allowDestructiveGraphqlSchemaUpdates" id="@aws-amplify/graphql-api-construct.TranslationBehavior.property.allowDestructiveGraphqlSchemaUpdates"></a>
+
+```typescript
+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`<sup>Required</sup> <a name="disableResolverDeduping" id="@aws-amplify/graphql-api-construct.TranslationBehavior.property.disableResolverDeduping"></a>
 
 ```typescript
@@ -2970,6 +3207,70 @@ The Cognito User Pool which is used to authenticated JWT tokens, and vends group
 
 ---
 
+### VpcConfig <a name="VpcConfig" id="@aws-amplify/graphql-api-construct.VpcConfig"></a>
+
+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 <a name="Initializer" id="@aws-amplify/graphql-api-construct.VpcConfig.Initializer"></a>
+
+```typescript
+import { VpcConfig } from '@aws-amplify/graphql-api-construct'
+
+const vpcConfig: VpcConfig = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@aws-amplify/graphql-api-construct.VpcConfig.property.securityGroupIds">securityGroupIds</a></code> | <code>string[]</code> | The security groups to install the Lambda data source in. |
+| <code><a href="#@aws-amplify/graphql-api-construct.VpcConfig.property.subnetAvailabilityZoneConfig">subnetAvailabilityZoneConfig</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.SubnetAvailabilityZone">SubnetAvailabilityZone</a>[]</code> | The subnets to install the Lambda data source in, one per availability zone. |
+| <code><a href="#@aws-amplify/graphql-api-construct.VpcConfig.property.vpcId">vpcId</a></code> | <code>string</code> | The VPC to install the Lambda data source in. |
+
+---
+
+##### `securityGroupIds`<sup>Required</sup> <a name="securityGroupIds" id="@aws-amplify/graphql-api-construct.VpcConfig.property.securityGroupIds"></a>
+
+```typescript
+public readonly securityGroupIds: string[];
+```
+
+- *Type:* string[]
+
+The security groups to install the Lambda data source in.
+
+---
+
+##### `subnetAvailabilityZoneConfig`<sup>Required</sup> <a name="subnetAvailabilityZoneConfig" id="@aws-amplify/graphql-api-construct.VpcConfig.property.subnetAvailabilityZoneConfig"></a>
+
+```typescript
+public readonly subnetAvailabilityZoneConfig: SubnetAvailabilityZone[];
+```
+
+- *Type:* <a href="#@aws-amplify/graphql-api-construct.SubnetAvailabilityZone">SubnetAvailabilityZone</a>[]
+
+The subnets to install the Lambda data source in, one per availability zone.
+
+---
+
+##### `vpcId`<sup>Required</sup> <a name="vpcId" id="@aws-amplify/graphql-api-construct.VpcConfig.property.vpcId"></a>
+
+```typescript
+public readonly vpcId: string;
+```
+
+- *Type:* string
+
+The VPC to install the Lambda data source in.
+
+---
+
 ## Classes <a name="Classes" id="Classes"></a>
 
 ### AmplifyDynamoDbTableWrapper <a name="AmplifyDynamoDbTableWrapper" id="@aws-amplify/graphql-api-construct.AmplifyDynamoDbTableWrapper"></a>
@@ -3184,8 +3485,8 @@ new AmplifyGraphqlDefinition()
 | **Name** | **Description** |
 | --- | --- |
 | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.combine">combine</a></code> | Combines multiple IAmplifyGraphqlDefinitions into a single definition. |
-| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles">fromFiles</a></code> | Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema. |
-| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition">fromFilesAndDefinition</a></code> | Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema. |
+| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles">fromFiles</a></code> | Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema, binding them to a DynamoDB data source. |
+| <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndStrategy">fromFilesAndStrategy</a></code> | Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema. |
 | <code><a href="#@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString">fromString</a></code> | Produce a schema definition from a string input. |
 
 ---
@@ -3200,6 +3501,8 @@ AmplifyGraphqlDefinition.combine(definitions: IAmplifyGraphqlDefinition[])
 
 Combines multiple IAmplifyGraphqlDefinitions into a single definition.
 
+**NOTE** This API is in preview and is not recommended to use with production systems.
+
 ###### `definitions`<sup>Required</sup> <a name="definitions" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.combine.parameter.definitions"></a>
 
 - *Type:* <a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition">IAmplifyGraphqlDefinition</a>[]
@@ -3216,7 +3519,7 @@ import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
 AmplifyGraphqlDefinition.fromFiles(filePaths: string)
 ```
 
-Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.
+Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema, binding them to a DynamoDB data source.
 
 ###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFiles.parameter.filePaths"></a>
 
@@ -3226,17 +3529,19 @@ one or more paths to the graphql files to process.
 
 ---
 
-##### `fromFilesAndDefinition` <a name="fromFilesAndDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition"></a>
+##### `fromFilesAndStrategy` <a name="fromFilesAndStrategy" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndStrategy"></a>
 
 ```typescript
 import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
 
-AmplifyGraphqlDefinition.fromFilesAndDefinition(filePaths: string | string[], modelDataSourceDefinition?: ModelDataSourceDefinition)
+AmplifyGraphqlDefinition.fromFilesAndStrategy(filePaths: string | string[], dataSourceStrategy?: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy)
 ```
 
 Convert one or more appsync SchemaFile objects into an Amplify Graphql Schema.
 
-###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition.parameter.filePaths"></a>
+**NOTE** This API is in preview and is not recommended to use with production systems.
+
+###### `filePaths`<sup>Required</sup> <a name="filePaths" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndStrategy.parameter.filePaths"></a>
 
 - *Type:* string | string[]
 
@@ -3244,13 +3549,14 @@ one or more paths to the graphql files to process.
 
 ---
 
-###### `modelDataSourceDefinition`<sup>Optional</sup> <a name="modelDataSourceDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndDefinition.parameter.modelDataSourceDefinition"></a>
+###### `dataSourceStrategy`<sup>Optional</sup> <a name="dataSourceStrategy" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromFilesAndStrategy.parameter.dataSourceStrategy"></a>
 
-- *Type:* <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>
+- *Type:* <a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy">DefaultDynamoDbModelDataSourceStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy">AmplifyDynamoDbModelDataSourceStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy">SQLLambdaModelDataSourceStrategy</a>
 
-the provision definition for `@model` datasource.
+the provisioning definition for datasources that resolve `@model`s in this schema.
 
-The DynamoDB from CloudFormation will be used by default.
+The DynamoDB from
+CloudFormation will be used by default.
 
 ---
 
@@ -3259,11 +3565,13 @@ The DynamoDB from CloudFormation will be used by default.
 ```typescript
 import { AmplifyGraphqlDefinition } from '@aws-amplify/graphql-api-construct'
 
-AmplifyGraphqlDefinition.fromString(schema: string, modelDataSourceDefinition?: ModelDataSourceDefinition)
+AmplifyGraphqlDefinition.fromString(schema: string, dataSourceStrategy?: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy)
 ```
 
 Produce a schema definition from a string input.
 
+**NOTE** The 'dataSourceStrategy' configuration option is in preview and is not recommended to use with production systems.
+
 ###### `schema`<sup>Required</sup> <a name="schema" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.schema"></a>
 
 - *Type:* string
@@ -3272,13 +3580,14 @@ the graphql input as a string.
 
 ---
 
-###### `modelDataSourceDefinition`<sup>Optional</sup> <a name="modelDataSourceDefinition" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.modelDataSourceDefinition"></a>
+###### `dataSourceStrategy`<sup>Optional</sup> <a name="dataSourceStrategy" id="@aws-amplify/graphql-api-construct.AmplifyGraphqlDefinition.fromString.parameter.dataSourceStrategy"></a>
 
-- *Type:* <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>
+- *Type:* <a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy">DefaultDynamoDbModelDataSourceStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy">AmplifyDynamoDbModelDataSourceStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy">SQLLambdaModelDataSourceStrategy</a>
 
-the provision definition for `@model` datasource.
+the provisioning definition for datasources that resolve `@model`s in this schema.
 
-The DynamoDB from CloudFormation will be used by default.
+The DynamoDB from
+CloudFormation will be used by default.
 
 ---
 
@@ -3297,23 +3606,25 @@ Graphql Api definition, which can be implemented in multiple ways.
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.dataSourceDefinition">dataSourceDefinition</a></code> | <code>{[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>}</code> | Retrieve the datasource definition mapping. |
+| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.dataSourceStrategies">dataSourceStrategies</a></code> | <code>{[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy">DefaultDynamoDbModelDataSourceStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy">AmplifyDynamoDbModelDataSourceStrategy</a> \| <a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy">SQLLambdaModelDataSourceStrategy</a>}</code> | Retrieve the datasource strategy mapping. The default strategy is to use DynamoDB from CloudFormation. |
 | <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.functionSlots">functionSlots</a></code> | <code><a href="#@aws-amplify/graphql-api-construct.MutationFunctionSlot">MutationFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.QueryFunctionSlot">QueryFunctionSlot</a> \| <a href="#@aws-amplify/graphql-api-construct.SubscriptionFunctionSlot">SubscriptionFunctionSlot</a>[]</code> | Retrieve any function slots defined explicitly in the Api definition. |
 | <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.schema">schema</a></code> | <code>string</code> | Return the schema definition as a graphql string, with amplify directives allowed. |
+| <code><a href="#@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.referencedLambdaFunctions">referencedLambdaFunctions</a></code> | <code>{[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}</code> | Retrieve the references to any lambda functions used in the definition. |
 
 ---
 
-##### `dataSourceDefinition`<sup>Required</sup> <a name="dataSourceDefinition" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.dataSourceDefinition"></a>
+##### `dataSourceStrategies`<sup>Required</sup> <a name="dataSourceStrategies" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.dataSourceStrategies"></a>
 
 ```typescript
-public readonly dataSourceDefinition: {[ key: string ]: ModelDataSourceDefinition};
+public readonly dataSourceStrategies: {[ key: string ]: DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy};
 ```
 
-- *Type:* {[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.ModelDataSourceDefinition">ModelDataSourceDefinition</a>}
+- *Type:* {[ key: string ]: <a href="#@aws-amplify/graphql-api-construct.DefaultDynamoDbModelDataSourceStrategy">DefaultDynamoDbModelDataSourceStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.AmplifyDynamoDbModelDataSourceStrategy">AmplifyDynamoDbModelDataSourceStrategy</a> | <a href="#@aws-amplify/graphql-api-construct.SQLLambdaModelDataSourceStrategy">SQLLambdaModelDataSourceStrategy</a>}
 
-Retrieve the datasource definition mapping.
+Retrieve the datasource strategy mapping. The default strategy is to use DynamoDB from CloudFormation.
 
-The default strategy is to use DynamoDB from CloudFormation.
+**NOTE** Explicitly specifying the 'dataSourceStrategies' configuration option is in preview and is not recommended to use with
+production systems. For production, use the static factory methods `fromString` or `fromFiles`.
 
 ---
 
@@ -3341,6 +3652,21 @@ Return the schema definition as a graphql string, with amplify directives allowe
 
 ---
 
+##### `referencedLambdaFunctions`<sup>Optional</sup> <a name="referencedLambdaFunctions" id="@aws-amplify/graphql-api-construct.IAmplifyGraphqlDefinition.property.referencedLambdaFunctions"></a>
+
+```typescript
+public readonly referencedLambdaFunctions: {[ key: string ]: IFunction};
+```
+
+- *Type:* {[ key: string ]: aws-cdk-lib.aws_lambda.IFunction}
+
+Retrieve the references to any lambda functions used in the definition.
+
+Useful for wiring through aws_lambda.Function constructs into the definition directly,
+and generated references to invoke them.
+
+---
+
 ### IBackendOutputEntry <a name="IBackendOutputEntry" id="@aws-amplify/graphql-api-construct.IBackendOutputEntry"></a>
 
 - *Implemented By:* <a href="#@aws-amplify/graphql-api-construct.IBackendOutputEntry">IBackendOutputEntry</a>