@aws-amplify/graphql-api-construct 1.3.0 → 1.4.0-nov-14-cut.0

package/API.md

@@ -6,6 +6,7 @@
 
 import { AppsyncFunction } from 'aws-cdk-lib/aws-appsync';
 import { BaseDataSource } from 'aws-cdk-lib/aws-appsync';
+import { BillingMode } from 'aws-cdk-lib/aws-dynamodb';
 import { CfnApiKey } from 'aws-cdk-lib/aws-appsync';
 import { CfnDataSource } from 'aws-cdk-lib/aws-appsync';
 import { CfnFunction } from 'aws-cdk-lib/aws-lambda';
@@ -45,6 +46,7 @@ import { NoneDataSource } from 'aws-cdk-lib/aws-appsync';
 import { OpenSearchDataSource } from 'aws-cdk-lib/aws-appsync';
 import { RdsDataSource } from 'aws-cdk-lib/aws-appsync';
 import { Resolver } from 'aws-cdk-lib/aws-appsync';
+import { StreamViewType } from 'aws-cdk-lib/aws-dynamodb';
 
 // @public
 export interface AddFunctionProps {
@@ -57,6 +59,28 @@ export interface AddFunctionProps {
     readonly runtime?: FunctionRuntime;
 }
 
+// @public
+export interface AmplifyDynamoDbModelDataSourceStrategy {
+    // (undocumented)
+    readonly dbType: 'DYNAMODB';
+    // (undocumented)
+    readonly provisionStrategy: 'AMPLIFY_TABLE';
+}
+
+// @public
+export class AmplifyDynamoDbTableWrapper {
+    constructor(resource: CfnResource);
+    set billingMode(billingMode: BillingMode);
+    set deletionProtectionEnabled(deletionProtectionEnabled: boolean);
+    static isAmplifyDynamoDbTableResource(x: any): x is CfnResource;
+    set pointInTimeRecoveryEnabled(pointInTimeRecoveryEnabled: boolean);
+    set provisionedThroughput(provisionedThroughput: ProvisionedThroughput);
+    setGlobalSecondaryIndexProvisionedThroughput(indexName: string, provisionedThroughput: ProvisionedThroughput): void;
+    set sseSpecification(sseSpecification: SSESpecification);
+    set streamSpecification(streamSpecification: StreamSpecification);
+    set timeToLiveAttribute(timeToLiveSpecification: TimeToLiveSpecification);
+}
+
 // @public
 export class AmplifyGraphqlApi extends Construct {
     constructor(scope: Construct, id: string, props: AmplifyGraphqlApiProps);
@@ -110,6 +134,7 @@ export interface AmplifyGraphqlApiProps {
 
 // @public
 export interface AmplifyGraphqlApiResources {
+    readonly amplifyDynamoDbTables: Record<string, AmplifyDynamoDbTableWrapper>;
     readonly cfnResources: AmplifyGraphqlApiCfnResources;
     readonly functions: Record<string, IFunction>;
     readonly graphqlApi: IGraphqlApi;
@@ -120,8 +145,10 @@ export interface AmplifyGraphqlApiResources {
 
 // @public
 export class AmplifyGraphqlDefinition {
+    static combine(definitions: IAmplifyGraphqlDefinition[]): IAmplifyGraphqlDefinition;
     static fromFiles(...filePaths: string[]): IAmplifyGraphqlDefinition;
-    static fromString(schema: string): IAmplifyGraphqlDefinition;
+    static fromFilesAndStrategy(filePaths: string | string[], dataSourceStrategy?: ModelDataSourceStrategy): IAmplifyGraphqlDefinition;
+    static fromString(schema: string, dataSourceStrategy?: ModelDataSourceStrategy): IAmplifyGraphqlDefinition;
 }
 
 // @public
@@ -169,6 +196,14 @@ export interface CustomConflictResolutionStrategy extends ConflictResolutionStra
     readonly handlerType: 'LAMBDA';
 }
 
+// @public
+export interface DefaultDynamoDbModelDataSourceStrategy {
+    // (undocumented)
+    readonly dbType: 'DYNAMODB';
+    // (undocumented)
+    readonly provisionStrategy: 'DEFAULT';
+}
+
 // @public
 export type FunctionSlot = MutationFunctionSlot | QueryFunctionSlot | SubscriptionFunctionSlot;
 
@@ -195,7 +230,9 @@ export interface IAMAuthorizationConfig {
 
 // @public
 export interface IAmplifyGraphqlDefinition {
+    readonly dataSourceStrategies: Record<string, ModelDataSourceStrategy>;
     readonly functionSlots: FunctionSlot[];
+    readonly referencedLambdaFunctions?: Record<string, IFunction>;
     readonly schema: string;
 }
 
@@ -216,6 +253,12 @@ export interface LambdaAuthorizationConfig {
     readonly ttl: Duration;
 }
 
+// @public
+export type ModelDataSourceStrategy = DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy;
+
+// @public (undocumented)
+export type ModelDataSourceStrategyDbType = 'DYNAMODB';
+
 // @public
 export interface MutationFunctionSlot extends FunctionSlotBase {
     readonly slotName: 'init' | 'preAuth' | 'auth' | 'postAuth' | 'preUpdate' | 'postUpdate' | 'finish';
@@ -238,6 +281,7 @@ export interface OptimisticConflictResolutionStrategy extends ConflictResolution
 
 // @public
 export interface PartialTranslationBehavior {
+    readonly allowDestructiveGraphqlSchemaUpdates?: boolean;
     readonly disableResolverDeduping?: boolean;
     readonly enableAutoIndexQueryNames?: boolean;
     readonly enableSearchNodeToNodeEncryption?: boolean;
@@ -251,22 +295,88 @@ export interface PartialTranslationBehavior {
     readonly useSubUsernameForDefaultIdentityClaim?: boolean;
 }
 
+// @public
+export interface ProvisionedConcurrencyConfig {
+    readonly provisionedConcurrentExecutions: number;
+}
+
+// @public
+export interface ProvisionedThroughput {
+    readonly readCapacityUnits: number;
+    readonly writeCapacityUnits: number;
+}
+
 // @public
 export interface QueryFunctionSlot extends FunctionSlotBase {
     readonly slotName: 'init' | 'preAuth' | 'auth' | 'postAuth' | 'preDataLoad' | 'postDataLoad' | 'finish';
     readonly typeName: 'Query';
 }
 
+// @public
+export type SQLLambdaLayerMapping = Record<string, string>;
+
+// @public
+export interface SQLLambdaModelDataSourceStrategy {
+    readonly customSqlStatements?: Record<string, string>;
+    readonly dbConnectionConfig: SqlModelDataSourceDbConnectionConfig;
+    readonly dbType: 'MYSQL' | 'POSTGRES';
+    readonly name: string;
+    readonly sqlLambdaLayerMapping?: SQLLambdaLayerMapping;
+    readonly sqlLambdaProvisionedConcurrencyConfig?: ProvisionedConcurrencyConfig;
+    readonly vpcConfiguration?: VpcConfig;
+}
+
+// @public
+export interface SqlModelDataSourceDbConnectionConfig {
+    readonly databaseNameSsmPath: string;
+    readonly hostnameSsmPath: string;
+    readonly passwordSsmPath: string;
+    readonly portSsmPath: string;
+    readonly usernameSsmPath: string;
+}
+
+// @public
+export interface SSESpecification {
+    readonly kmsMasterKeyId?: string;
+    readonly sseEnabled: boolean;
+    readonly sseType?: SSEType;
+}
+
+// @public
+export enum SSEType {
+    // (undocumented)
+    KMS = "KMS"
+}
+
+// @public
+export interface StreamSpecification {
+    readonly streamViewType: StreamViewType;
+}
+
+// @public
+export interface SubnetAvailabilityZone {
+    readonly availabilityZone: string;
+    readonly subnetId: string;
+}
+
 // @public
 export interface SubscriptionFunctionSlot extends FunctionSlotBase {
     readonly slotName: 'init' | 'preAuth' | 'auth' | 'postAuth' | 'preSubscribe';
     readonly typeName: 'Subscription';
 }
 
+// @public
+export interface TimeToLiveSpecification {
+    readonly attributeName?: string;
+    readonly enabled: boolean;
+}
+
 // @public
 export interface TranslationBehavior {
+    readonly allowDestructiveGraphqlSchemaUpdates: boolean;
     readonly disableResolverDeduping: boolean;
     readonly enableAutoIndexQueryNames: boolean;
+    // (undocumented)
     readonly enableSearchNodeToNodeEncryption: boolean;
     readonly enableTransformerCfnOutputs: boolean;
     readonly populateOwnerFieldForStaticGroupAuth: boolean;
@@ -283,6 +393,13 @@ export interface UserPoolAuthorizationConfig {
     readonly userPool: IUserPool;
 }
 
+// @public
+export interface VpcConfig {
+    readonly securityGroupIds: string[];
+    readonly subnetAvailabilityZoneConfig: SubnetAvailabilityZone[];
+    readonly vpcId: string;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.4.0-nov-14-cut.0](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-api-construct@1.3.0...@aws-amplify/graphql-api-construct@1.4.0-nov-14-cut.0) (2023-11-14)
+
+### Bug Fixes
+
+- address managed table QA feedbacks ([#2059](https://github.com/aws-amplify/amplify-category-api/issues/2059)) ([82a5cd6](https://github.com/aws-amplify/amplify-category-api/commit/82a5cd677fdf183e81590d120a8f494a2ff611ec))
+- construct hub link image ([dbc8ea3](https://github.com/aws-amplify/amplify-category-api/commit/dbc8ea3f2861c4a4e7cd81f70bf8840773b5e5e3))
+- fix api extract ([1f5aa54](https://github.com/aws-amplify/amplify-category-api/commit/1f5aa542150d62df0bd71df7c4586df44cfc3349))
+- Make VPC configuration optional ([#2021](https://github.com/aws-amplify/amplify-category-api/issues/2021)) ([698d816](https://github.com/aws-amplify/amplify-category-api/commit/698d8163b99e962ea6cb43fa28d1fea3d87b9bc3))
+
+### Features
+
+- add managed table support in API construct ([#2024](https://github.com/aws-amplify/amplify-category-api/issues/2024)) ([96a0d94](https://github.com/aws-amplify/amplify-category-api/commit/96a0d94fa872a5329da120f53be139833449b815)), closes [#1849](https://github.com/aws-amplify/amplify-category-api/issues/1849) [#1903](https://github.com/aws-amplify/amplify-category-api/issues/1903) [#1940](https://github.com/aws-amplify/amplify-category-api/issues/1940) [#1971](https://github.com/aws-amplify/amplify-category-api/issues/1971) [#1973](https://github.com/aws-amplify/amplify-category-api/issues/1973)
+- add postgres engine and update types as needed ([#1979](https://github.com/aws-amplify/amplify-category-api/issues/1979)) ([5257d53](https://github.com/aws-amplify/amplify-category-api/commit/5257d53f1d4d02be71b34ddf6757f22dd5d74aff))
+- Add SQL database support to AmplifyGraphqlApi construct ([#1986](https://github.com/aws-amplify/amplify-category-api/issues/1986)) ([2ff63a5](https://github.com/aws-amplify/amplify-category-api/commit/2ff63a540387d96cf10d8ae1975858a76d9ba045)), closes [#1917](https://github.com/aws-amplify/amplify-category-api/issues/1917) [#1983](https://github.com/aws-amplify/amplify-category-api/issues/1983)
+- enable api definition to pass in referenced functions ([#2061](https://github.com/aws-amplify/amplify-category-api/issues/2061)) ([d281f5b](https://github.com/aws-amplify/amplify-category-api/commit/d281f5bcff568a71ed266d1f9d5e45af4a73701f))
+- sql lambda provisioned concurrency ([#2055](https://github.com/aws-amplify/amplify-category-api/issues/2055)) ([d8c5bf0](https://github.com/aws-amplify/amplify-category-api/commit/d8c5bf0b7df3cdd1ad499380d24fe49a61acbc7e))
+
 # [1.3.0](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-api-construct@1.2.1...@aws-amplify/graphql-api-construct@1.3.0) (2023-11-06)
 
 ### Features