@aws-amplify/graphql-api-construct 1.1.4 → 1.2.0-amplify-table-preview.0

package/.jsii

@@ -8,26 +8,26 @@
   "bundled": {
     "@aws-amplify/backend-output-schemas": "^0.2.0-alpha.6",
     "@aws-amplify/backend-output-storage": "^0.1.1-alpha.2",
-    "@aws-amplify/graphql-auth-transformer": "3.1.8",
-    "@aws-amplify/graphql-default-value-transformer": "2.1.7",
-    "@aws-amplify/graphql-function-transformer": "2.1.6",
-    "@aws-amplify/graphql-http-transformer": "2.1.6",
-    "@aws-amplify/graphql-index-transformer": "2.1.7",
-    "@aws-amplify/graphql-maps-to-transformer": "3.2.4",
-    "@aws-amplify/graphql-model-transformer": "2.2.3",
-    "@aws-amplify/graphql-predictions-transformer": "2.1.6",
-    "@aws-amplify/graphql-relational-transformer": "2.1.7",
-    "@aws-amplify/graphql-searchable-transformer": "2.2.3",
-    "@aws-amplify/graphql-transformer": "1.2.4",
-    "@aws-amplify/graphql-transformer-core": "2.2.3",
-    "@aws-amplify/graphql-transformer-interfaces": "3.2.1",
+    "@aws-amplify/graphql-auth-transformer": "3.1.9-amplify-table-preview.0",
+    "@aws-amplify/graphql-default-value-transformer": "2.1.8-amplify-table-preview.0",
+    "@aws-amplify/graphql-function-transformer": "2.1.7-amplify-table-preview.0",
+    "@aws-amplify/graphql-http-transformer": "2.1.7-amplify-table-preview.0",
+    "@aws-amplify/graphql-index-transformer": "2.2.0-amplify-table-preview.0",
+    "@aws-amplify/graphql-maps-to-transformer": "3.2.5-amplify-table-preview.0",
+    "@aws-amplify/graphql-model-transformer": "2.3.0-amplify-table-preview.0",
+    "@aws-amplify/graphql-predictions-transformer": "2.1.7-amplify-table-preview.0",
+    "@aws-amplify/graphql-relational-transformer": "2.2.0-amplify-table-preview.0",
+    "@aws-amplify/graphql-searchable-transformer": "2.2.4-amplify-table-preview.0",
+    "@aws-amplify/graphql-transformer": "1.3.0-amplify-table-preview.0",
+    "@aws-amplify/graphql-transformer-core": "2.3.0-amplify-table-preview.0",
+    "@aws-amplify/graphql-transformer-interfaces": "3.3.0-amplify-table-preview.0",
     "charenc": "^0.0.2",
     "crypt": "^0.0.2",
     "fs-extra": "^8.1.0",
     "graceful-fs": "^4.2.11",
     "graphql": "^15.5.0",
     "graphql-mapping-template": "4.20.12",
-    "graphql-transformer-common": "4.25.1",
+    "graphql-transformer-common": "4.26.0-amplify-table-preview.0",
     "hjson": "^3.2.2",
     "immer": "^9.0.12",
     "is-buffer": "^2.0.5",
@@ -3533,7 +3533,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 706
+        "line": 720
       },
       "name": "AddFunctionProps",
       "properties": [
@@ -3546,7 +3546,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 710
+            "line": 724
           },
           "name": "dataSource",
           "type": {
@@ -3562,7 +3562,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 715
+            "line": 729
           },
           "name": "name",
           "type": {
@@ -3579,7 +3579,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 750
+            "line": 764
           },
           "name": "code",
           "optional": true,
@@ -3597,7 +3597,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 722
+            "line": 736
           },
           "name": "description",
           "optional": true,
@@ -3615,7 +3615,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 729
+            "line": 743
           },
           "name": "requestMappingTemplate",
           "optional": true,
@@ -3633,7 +3633,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 736
+            "line": 750
           },
           "name": "responseMappingTemplate",
           "optional": true,
@@ -3651,7 +3651,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 743
+            "line": 757
           },
           "name": "runtime",
           "optional": true,
@@ -4296,7 +4296,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 614
+        "line": 623
       },
       "name": "AmplifyGraphqlApiCfnResources",
       "properties": [
@@ -4309,7 +4309,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 663
+            "line": 677
           },
           "name": "additionalCfnResources",
           "type": {
@@ -4321,6 +4321,27 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The Generated Amplify DynamoDB Table L1 Resources, keyed by model name."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 662
+          },
+          "name": "cfnAmplifyTables",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.CfnResource"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4330,7 +4351,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 643
+            "line": 652
           },
           "name": "cfnDataSources",
           "type": {
@@ -4351,7 +4372,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 638
+            "line": 647
           },
           "name": "cfnFunctionConfigurations",
           "type": {
@@ -4372,7 +4393,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 658
+            "line": 672
           },
           "name": "cfnFunctions",
           "type": {
@@ -4393,7 +4414,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 618
+            "line": 627
           },
           "name": "cfnGraphqlApi",
           "type": {
@@ -4409,7 +4430,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 623
+            "line": 632
           },
           "name": "cfnGraphqlSchema",
           "type": {
@@ -4425,7 +4446,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 633
+            "line": 642
           },
           "name": "cfnResolvers",
           "type": {
@@ -4446,7 +4467,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 653
+            "line": 667
           },
           "name": "cfnRoles",
           "type": {
@@ -4467,7 +4488,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 648
+            "line": 657
           },
           "name": "cfnTables",
           "type": {
@@ -4488,7 +4509,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 628
+            "line": 637
           },
           "name": "cfnApiKey",
           "optional": true,
@@ -4511,7 +4532,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 538
+        "line": 547
       },
       "name": "AmplifyGraphqlApiProps",
       "properties": [
@@ -4525,7 +4546,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 555
+            "line": 564
           },
           "name": "authorizationModes",
           "type": {
@@ -4542,7 +4563,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 543
+            "line": 552
           },
           "name": "definition",
           "type": {
@@ -4559,7 +4580,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 549
+            "line": 558
           },
           "name": "apiName",
           "optional": true,
@@ -4577,7 +4598,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 569
+            "line": 578
           },
           "name": "conflictResolution",
           "optional": true,
@@ -4597,7 +4618,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 563
+            "line": 572
           },
           "name": "functionNameMap",
           "optional": true,
@@ -4620,7 +4641,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 584
+            "line": 593
           },
           "name": "functionSlots",
           "optional": true,
@@ -4655,7 +4676,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 607
+            "line": 616
           },
           "name": "outputStorageStrategy",
           "optional": true,
@@ -4672,7 +4693,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 596
+            "line": 605
           },
           "name": "predictionsBucket",
           "optional": true,
@@ -4690,7 +4711,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 578
+            "line": 587
           },
           "name": "stackMappings",
           "optional": true,
@@ -4716,7 +4737,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 591
+            "line": 600
           },
           "name": "transformerPlugins",
           "optional": true,
@@ -4738,7 +4759,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 602
+            "line": 611
           },
           "name": "translationBehavior",
           "optional": true,
@@ -4761,7 +4782,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 670
+        "line": 684
       },
       "name": "AmplifyGraphqlApiResources",
       "properties": [
@@ -4774,7 +4795,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 694
+            "line": 708
           },
           "name": "cfnResources",
           "type": {
@@ -4790,7 +4811,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 689
+            "line": 703
           },
           "name": "functions",
           "type": {
@@ -4811,7 +4832,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 674
+            "line": 688
           },
           "name": "graphqlApi",
           "type": {
@@ -4827,7 +4848,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 699
+            "line": 713
           },
           "name": "nestedStacks",
           "type": {
@@ -4848,7 +4869,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 684
+            "line": 698
           },
           "name": "roles",
           "type": {
@@ -4869,7 +4890,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 679
+            "line": 693
           },
           "name": "tables",
           "type": {
@@ -5572,7 +5593,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 492
+        "line": 501
       },
       "name": "IAmplifyGraphqlDefinition",
       "properties": [
@@ -5586,7 +5607,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 503
+            "line": 512
           },
           "name": "functionSlots",
           "type": {
@@ -5620,7 +5641,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 497
+            "line": 506
           },
           "name": "schema",
           "type": {
@@ -5640,7 +5661,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 509
+        "line": 518
       },
       "name": "IBackendOutputEntry",
       "properties": [
@@ -5653,7 +5674,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 518
+            "line": 527
           },
           "name": "payload",
           "type": {
@@ -5674,7 +5695,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 513
+            "line": 522
           },
           "name": "version",
           "type": {
@@ -5694,7 +5715,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 524
+        "line": 533
       },
       "methods": [
         {
@@ -5705,7 +5726,7 @@
           },
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 531
+            "line": 540
           },
           "name": "addBackendOutputEntry",
           "parameters": [
@@ -5988,7 +6009,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 414
+        "line": 416
       },
       "name": "PartialTranslationBehavior",
       "properties": [
@@ -6002,7 +6023,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 426
+            "line": 428
           },
           "name": "disableResolverDeduping",
           "optional": true,
@@ -6024,7 +6045,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 465
+            "line": 467
           },
           "name": "enableAutoIndexQueryNames",
           "optional": true,
@@ -6043,7 +6064,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 480
+            "line": 482
           },
           "name": "enableSearchNodeToNodeEncryption",
           "optional": true,
@@ -6061,7 +6082,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 486
+            "line": 488
           },
           "name": "enableTransformerCfnOutputs",
           "optional": true,
@@ -6079,7 +6100,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 445
+            "line": 447
           },
           "name": "populateOwnerFieldForStaticGroupAuth",
           "optional": true,
@@ -6097,7 +6118,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 471
+            "line": 473
           },
           "name": "respectPrimaryKeyAttributesOnConnectionField",
           "optional": true,
@@ -6115,7 +6136,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 432
+            "line": 434
           },
           "name": "sandboxModeEnabled",
           "optional": true,
@@ -6136,7 +6157,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 458
+            "line": 460
           },
           "name": "secondaryKeyAsGSI",
           "optional": true,
@@ -6157,7 +6178,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 419
+            "line": 421
           },
           "name": "shouldDeepMergeDirectiveConfigDefaults",
           "optional": true,
@@ -6176,7 +6197,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 452
+            "line": 454
           },
           "name": "suppressApiKeyGeneration",
           "optional": true,
@@ -6184,6 +6205,24 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "experimental",
+            "summary": "When enabled, amplify DynamoDB table will be generated instead of CFN pre-defined DynamoDB table."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 495
+          },
+          "name": "useAmplifyManagedTableResources",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -6194,7 +6233,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 439
+            "line": 441
           },
           "name": "useSubUsernameForDefaultIdentityClaim",
           "optional": true,
@@ -6370,15 +6409,12 @@
         {
           "abstract": true,
           "docs": {
-            "default": "false",
-            "remarks": "Not recommended for use, prefer\nto use `Object.values(resources.additionalResources['AWS::Elasticsearch::Domain']).forEach((domain: CfnDomain) => {\n  domain.NodeToNodeEncryptionOptions = { Enabled: True };\n});",
-            "stability": "stable",
-            "summary": "If enabled, set nodeToNodeEncryption on the searchable domain (if one exists)."
+            "stability": "stable"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 402
+            "line": 404
           },
           "name": "enableSearchNodeToNodeEncryption",
           "type": {
@@ -6395,7 +6431,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 408
+            "line": 410
           },
           "name": "enableTransformerCfnOutputs",
           "type": {
@@ -6511,6 +6547,23 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "experimental",
+            "summary": "Used for AmplifyGrapqhlApi construct ONLY If enabled, the table resources will be generated under custom resource provider, which enables the multiple GSI updates within one deployment phase."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 402
+          },
+          "name": "useAmplifyManagedTableResources",
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -6566,6 +6619,6 @@
       "symbolId": "src/types:UserPoolAuthorizationConfig"
     }
   },
-  "version": "1.1.4",
-  "fingerprint": "ERcBJN73VGWmexHYYt3E3MePH4zTMeQE69TKkCpbYaA="
+  "version": "1.2.0-amplify-table-preview.0",
+  "fingerprint": "N8FG+0daJzBLzghMHeHzJejIxNCp+rdCSRDdw8A/z9c="
 }

package/API.md

@@ -81,6 +81,7 @@ export class AmplifyGraphqlApi extends Construct {
 // @public
 export interface AmplifyGraphqlApiCfnResources {
     readonly additionalCfnResources: Record<string, CfnResource>;
+    readonly cfnAmplifyTables: Record<string, CfnResource>;
     readonly cfnApiKey?: CfnApiKey;
     readonly cfnDataSources: Record<string, CfnDataSource>;
     readonly cfnFunctionConfigurations: Record<string, CfnFunctionConfiguration>;
@@ -246,6 +247,7 @@ export interface PartialTranslationBehavior {
     readonly secondaryKeyAsGSI?: boolean;
     readonly shouldDeepMergeDirectiveConfigDefaults?: boolean;
     readonly suppressApiKeyGeneration?: boolean;
+    readonly useAmplifyManagedTableResources?: boolean;
     readonly useSubUsernameForDefaultIdentityClaim?: boolean;
 }
 
@@ -265,6 +267,7 @@ export interface SubscriptionFunctionSlot extends FunctionSlotBase {
 export interface TranslationBehavior {
     readonly disableResolverDeduping: boolean;
     readonly enableAutoIndexQueryNames: boolean;
+    // (undocumented)
     readonly enableSearchNodeToNodeEncryption: boolean;
     readonly enableTransformerCfnOutputs: boolean;
     readonly populateOwnerFieldForStaticGroupAuth: boolean;
@@ -273,6 +276,7 @@ export interface TranslationBehavior {
     readonly secondaryKeyAsGSI: boolean;
     readonly shouldDeepMergeDirectiveConfigDefaults: boolean;
     readonly suppressApiKeyGeneration: boolean;
+    readonly useAmplifyManagedTableResources: boolean;
     readonly useSubUsernameForDefaultIdentityClaim: boolean;
 }