@aws-amplify/graphql-api-construct 1.4.1 → 1.4.3

package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/model-datasource/types.ts

@@ -0,0 +1,163 @@
+import { DataSourceType } from '../transformer-context/transformer-datasource-provider';
+
+// #########################################################################################################################################
+// If you change types in this file (the internal implementation), be sure to make corresponding necessary changes to
+// amplify-graphql-api-construct/src/model-datasource-strategy.ts (the customer-facing interface) and the adapter functions in this file.
+// #########################################################################################################################################
+
+/**
+ * All known ModelDataSourceStrategies. Concrete strategies vary widely in their requirements and implementations.
+ */
+export type ModelDataSourceStrategy =
+  | DefaultDynamoDbModelDataSourceStrategy
+  | AmplifyDynamoDbModelDataSourceStrategy
+  | SQLLambdaModelDataSourceStrategy;
+
+export interface ModelDataSourceStrategyBase {
+  dbType: ModelDataSourceStrategyDbType;
+}
+
+// TODO: Make this the source of truth for database type definitions used throughout the construct & transformer
+export type ModelDataSourceStrategyDbType = 'DYNAMODB' | 'MYSQL' | 'POSTGRES';
+
+/**
+ * Use default CloudFormation type 'AWS::DynamoDB::Table' to provision table.
+ */
+export interface DefaultDynamoDbModelDataSourceStrategy extends ModelDataSourceStrategyBase {
+  readonly dbType: 'DYNAMODB';
+  readonly provisionStrategy: 'DEFAULT';
+}
+
+/**
+ * Use custom resource type 'Custom::AmplifyDynamoDBTable' to provision table.
+ */
+export interface AmplifyDynamoDbModelDataSourceStrategy extends ModelDataSourceStrategyBase {
+  readonly dbType: 'DYNAMODB';
+  readonly provisionStrategy: 'AMPLIFY_TABLE';
+}
+
+/**
+ * A strategy that creates a Lambda to connect to a pre-existing SQL table to resolve model data.
+ *
+ */
+export interface SQLLambdaModelDataSourceStrategy extends ModelDataSourceStrategyBase {
+  /**
+   * 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.
+   */
+  readonly name: string;
+
+  /**
+   * The type of the SQL database used to process model operations for this definition.
+   */
+  readonly dbType: 'MYSQL' | 'POSTGRES';
+
+  /**
+   * The parameters the Lambda data source will use to connect to the database.
+   */
+  readonly dbConnectionConfig: SqlModelDataSourceDbConnectionConfig;
+
+  /**
+   * The configuration of the VPC into which to install the Lambda.
+   */
+  readonly vpcConfiguration?: VpcConfig;
+
+  /**
+   * 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.
+   */
+  readonly customSqlStatements?: Record<string, string>;
+
+  /**
+   * The configuration for the provisioned concurrency of the Lambda.
+   */
+  readonly sqlLambdaProvisionedConcurrencyConfig?: ProvisionedConcurrencyConfig;
+}
+
+/**
+ * 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.
+ */
+export interface VpcConfig {
+  /** The VPC to install the Lambda data source in. */
+  readonly vpcId: string;
+
+  /** The security groups to install the Lambda data source in. */
+  readonly securityGroupIds: string[];
+
+  /** The subnets to install the Lambda data source in, one per availability zone. */
+  readonly subnetAvailabilityZoneConfig: SubnetAvailabilityZone[];
+}
+
+/**
+ * The configuration for the provisioned concurrency of the Lambda.
+ */
+export interface ProvisionedConcurrencyConfig {
+  /** The amount of provisioned concurrency to allocate. **/
+  readonly provisionedConcurrentExecutions: number;
+}
+
+/**
+ * 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.
+ */
+export interface SubnetAvailabilityZone {
+  /** The subnet ID to install the Lambda data source in. */
+  readonly subnetId: string;
+
+  /** The availability zone of the subnet. */
+  readonly availabilityZone: string;
+}
+
+/**
+ * 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.
+ */
+export interface SqlModelDataSourceDbConnectionConfig {
+  /** 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.
+   */
+  readonly hostnameSsmPath: string;
+
+  /** The Secure Systems Manager parameter containing the port number of the database proxy, cluster, or instance. */
+  readonly portSsmPath: string;
+
+  /** The Secure Systems Manager parameter containing the username to use when connecting to the database. */
+  readonly usernameSsmPath: string;
+
+  /** The Secure Systems Manager parameter containing the password to use when connecting to the database. */
+  readonly passwordSsmPath: string;
+
+  /** The Secure Systems Manager parameter containing the database name. */
+  readonly databaseNameSsmPath: string;
+}
+
+export interface CustomSqlDataSourceStrategy {
+  readonly typeName: 'Query' | 'Mutation';
+  readonly fieldName: string;
+  // TODO: Replace this when we support heterogeneous SQL data sources in a single API
+  readonly dataSourceType: DataSourceType;
+}
+
+export interface DataSourceStrategiesProvider {
+  /** Maps GraphQL model names to the ModelDataSourceStrategy used to resolve it. The key of the record is the GraphQL type name. */
+  // TODO: Add this back during combine feature
+  // dataSourceStrategies: Record<string, ModelDataSourceStrategy>;
+
+  /** Maps custom Query and Mutation fields to the ModelDataSourceStrategy used to resolve them. */
+  customSqlDataSourceStrategies: CustomSqlDataSourceStrategy[];
+}
+
+/**
+ * Maps a given AWS region to the SQL Lambda layer version ARN for that region. TODO: Rename to SQLLambdaLayerMapping
+ */
+export interface RDSLayerMapping {
+  readonly [key: string]: {
+    layerRegion: string;
+  };
+}

package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transform-host-provider.ts

@@ -17,8 +17,8 @@ import {
   DataSourceOptions,
   SearchableDataSourceOptions,
   MappingTemplateProvider,
-  VpcConfig,
 } from './graphql-api-provider';
+import { VpcConfig } from './model-datasource';
 
 export interface DynamoDbDataSourceOptions extends DataSourceOptions {
   /**

package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/index.ts

@@ -15,13 +15,14 @@ export { TransformerProviderRegistry } from './transformer-provider-registry';
 export { TransformerResolverProvider, TransformerResolversManagerProvider } from './transformer-resolver-provider';
 export * from './resource-resource-provider';
 export {
-  TransformerContextProvider,
-  TransformerTransformSchemaStepContextProvider,
   TransformerBeforeStepContextProvider,
+  TransformerContextMetadataProvider,
+  TransformerContextProvider,
   TransformerPrepareStepContextProvider,
   TransformerSchemaVisitStepContextProvider,
-  TransformerValidationStepContextProvider,
   TransformerSecrets,
+  TransformerTransformSchemaStepContextProvider,
+  TransformerValidationStepContextProvider,
 } from './transformer-context-provider';
 export { TransformerSchemaHelperProvider } from './schema-helper-provider';
 export { TransformerPreProcessContextProvider } from './transformer-preprocess-context-provider';

package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-context-provider.ts

@@ -1,11 +1,6 @@
 import { DocumentNode } from 'graphql';
-import {
-  AppSyncAuthConfiguration,
-  GraphQLAPIProvider,
-  RDSLayerMapping,
-  VpcConfig,
-  ProvisionedConcurrencyConfig,
-} from '../graphql-api-provider';
+import { AppSyncAuthConfiguration, GraphQLAPIProvider } from '../graphql-api-provider';
+import { CustomSqlDataSourceStrategy, ProvisionedConcurrencyConfig, RDSLayerMapping, VpcConfig } from '../model-datasource';
 import { TransformerDataSourceManagerProvider, DataSourceType } from './transformer-datasource-provider';
 import { TransformerProviderRegistry } from './transformer-provider-registry';
 import { TransformerContextOutputProvider } from './transformer-context-output-provider';
@@ -31,6 +26,7 @@ export interface TransformerContextProvider {
 
   inputDocument: DocumentNode;
   modelToDatasourceMap: Map<string, DataSourceType>;
+  customSqlDataSourceStrategies?: CustomSqlDataSourceStrategy[];
   datasourceSecretParameterLocations: Map<string, TransformerSecrets>;
   output: TransformerContextOutputProvider;
   stackManager: StackManagerProvider;
@@ -52,6 +48,7 @@ export type TransformerBeforeStepContextProvider = Pick<
   TransformerContextProvider,
   | 'inputDocument'
   | 'modelToDatasourceMap'
+  | 'customSqlDataSourceStrategies'
   | 'transformParameters'
   | 'isProjectUsingDataStore'
   | 'getResolverConfig'
@@ -64,6 +61,7 @@ export type TransformerSchemaVisitStepContextProvider = Pick<
   TransformerContextProvider,
   | 'inputDocument'
   | 'modelToDatasourceMap'
+  | 'customSqlDataSourceStrategies'
   | 'output'
   | 'providerRegistry'
   | 'transformParameters'
@@ -78,6 +76,7 @@ export type TransformerValidationStepContextProvider = Pick<
   TransformerContextProvider,
   | 'inputDocument'
   | 'modelToDatasourceMap'
+  | 'customSqlDataSourceStrategies'
   | 'output'
   | 'providerRegistry'
   | 'dataSources'

package/node_modules/@aws-amplify/graphql-transformer-interfaces/src/transformer-context/transformer-datasource-provider.ts

@@ -28,12 +28,12 @@ export interface TransformerDataSourceManagerProvider {
 export interface DataSourceProvider extends BackedDataSource {}
 
 /**
- * Supported transformable database types. TODO: Move this to amplify-graphql-api-construct
+ * Supported transformable database types. TODO: Remove this when we normalize database type handling throughout
  */
 export type DBType = 'DDB' | SQLDBType;
 
 /**
- * Supported transformable SQL database types. TODO: Move this to amplify-graphql-api-construct
+ * Supported transformable SQL database types. TODO: Remove this when we normalize database type handling throughout
  */
 export type SQLDBType = 'MySQL' | 'Postgres';