@aws-amplify/graphql-transformer-interfaces - npm Package Compare versions

Comparing version 3.4.1-iam-auth-with-identityPool-provider-1.0 to 3.5.0-cors-rule.0

API.md

@@ -226,2 +226,11 @@ ## API Report File for "@aws-amplify/graphql-transformer-interfaces"
 // @public (undocumented)
+export const isSqlModelDataSourceDbConnectionConfig: (obj: any) => obj is SqlModelDataSourceDbConnectionConfig;
+
+// @public (undocumented)
+export const isSqlModelDataSourceSecretsManagerDbConnectionConfig: (obj: any) => obj is SqlModelDataSourceSecretsManagerDbConnectionConfig;
+
+// @public (undocumented)
+export const isSqlModelDataSourceSsmDbConnectionConfig: (obj: any) => obj is SqlModelDataSourceSsmDbConnectionConfig;
+
+// @public (undocumented)
 export type MappingTemplateProvider = InlineMappingTemplateProvider | S3MappingTemplateProvider;
@@ -376,4 +385,21 @@
 // @public (undocumented)
-export interface SqlModelDataSourceDbConnectionConfig {
+export type SqlModelDataSourceDbConnectionConfig = SqlModelDataSourceSecretsManagerDbConnectionConfig | SqlModelDataSourceSsmDbConnectionConfig;
+
+// @public (undocumented)
+export interface SqlModelDataSourceSecretsManagerDbConnectionConfig {
     // (undocumented)
+    readonly databaseName: string;
+    // (undocumented)
+    readonly hostname: string;
+    // (undocumented)
+    readonly keyArn?: string;
+    // (undocumented)
+    readonly port: number;
+    // (undocumented)
+    readonly secretArn: string;
+}
+
+// @public (undocumented)
+export interface SqlModelDataSourceSsmDbConnectionConfig {
+    // (undocumented)
     readonly databaseNameSsmPath: string;
@@ -435,3 +461,2 @@ // (undocumented)
     adminRoles?: string[];
-    enableIamAccess?: boolean;
 };
@@ -438,0 +463,0 @@

CHANGELOG.md

@@ -6,6 +6,8 @@ # Change Log
 
-## [3.4.1-iam-auth-with-identityPool-provider-1.0](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@3.4.0...@aws-amplify/graphql-transformer-interfaces@3.4.1-iam-auth-with-identityPool-provider-1.0) (2024-03-15)
+# [3.5.0-cors-rule.0](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@3.4.0...@aws-amplify/graphql-transformer-interfaces@3.5.0-cors-rule.0) (2024-03-20)
 
-**Note:** Version bump only for package @aws-amplify/graphql-transformer-interfaces
+### Features
 
+- add secrets manager as credential store for sql lambda ([#2289](https://github.com/aws-amplify/amplify-category-api/issues/2289)) ([affdb98](https://github.com/aws-amplify/amplify-category-api/commit/affdb988b499591c3a96608f772b637ddd8c3a0c))
+
 # [3.4.0](https://github.com/aws-amplify/amplify-category-api/compare/@aws-amplify/graphql-transformer-interfaces@3.3.3...@aws-amplify/graphql-transformer-interfaces@3.4.0) (2024-02-28)
@@ -12,0 +14,0 @@

lib/model-datasource/types.d.ts

@@ -34,3 +34,11 @@ export type ModelDataSourceStrategy = DefaultDynamoDbModelDataSourceStrategy | AmplifyDynamoDbModelDataSourceStrategy | SQLLambdaModelDataSourceStrategy;
 }
-export interface SqlModelDataSourceDbConnectionConfig {
+export type SqlModelDataSourceDbConnectionConfig = SqlModelDataSourceSecretsManagerDbConnectionConfig | SqlModelDataSourceSsmDbConnectionConfig;
+export interface SqlModelDataSourceSecretsManagerDbConnectionConfig {
+    readonly secretArn: string;
+    readonly keyArn?: string;
+    readonly port: number;
+    readonly databaseName: string;
+    readonly hostname: string;
+}
+export interface SqlModelDataSourceSsmDbConnectionConfig {
     readonly hostnameSsmPath: string;
@@ -60,2 +68,5 @@ readonly portSsmPath: string;
 }
+export declare const isSqlModelDataSourceDbConnectionConfig: (obj: any) => obj is SqlModelDataSourceDbConnectionConfig;
+export declare const isSqlModelDataSourceSsmDbConnectionConfig: (obj: any) => obj is SqlModelDataSourceSsmDbConnectionConfig;
+export declare const isSqlModelDataSourceSecretsManagerDbConnectionConfig: (obj: any) => obj is SqlModelDataSourceSecretsManagerDbConnectionConfig;
 //# sourceMappingURL=types.d.ts.map

lib/model-datasource/types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSqlModelDataSourceSecretsManagerDbConnectionConfig = exports.isSqlModelDataSourceSsmDbConnectionConfig = exports.isSqlModelDataSourceDbConnectionConfig = void 0;
+const isSqlModelDataSourceDbConnectionConfig = (obj) => {
+    return (0, exports.isSqlModelDataSourceSsmDbConnectionConfig)(obj) || (0, exports.isSqlModelDataSourceSecretsManagerDbConnectionConfig)(obj);
+};
+exports.isSqlModelDataSourceDbConnectionConfig = isSqlModelDataSourceDbConnectionConfig;
+const isSqlModelDataSourceSsmDbConnectionConfig = (obj) => {
+    return ((typeof obj === 'object' || typeof obj === 'function') &&
+        typeof obj.hostnameSsmPath === 'string' &&
+        typeof obj.portSsmPath === 'string' &&
+        typeof obj.usernameSsmPath === 'string' &&
+        typeof obj.passwordSsmPath === 'string' &&
+        typeof obj.databaseNameSsmPath === 'string');
+};
+exports.isSqlModelDataSourceSsmDbConnectionConfig = isSqlModelDataSourceSsmDbConnectionConfig;
+const isSqlModelDataSourceSecretsManagerDbConnectionConfig = (obj) => {
+    return ((typeof obj === 'object' || typeof obj === 'function') &&
+        typeof obj.secretArn === 'string' &&
+        typeof obj.port === 'number' &&
+        typeof obj.databaseName === 'string' &&
+        typeof obj.hostname === 'string');
+};
+exports.isSqlModelDataSourceSecretsManagerDbConnectionConfig = isSqlModelDataSourceSecretsManagerDbConnectionConfig;
 //# sourceMappingURL=types.js.map

lib/transformer-context/synth-parameters.d.ts

@@ -9,4 +9,3 @@ export type SynthParameters = {
     adminRoles?: string[];
-    enableIamAccess?: boolean;
 };
 //# sourceMappingURL=synth-parameters.d.ts.map

package.json

 {
   "name": "@aws-amplify/graphql-transformer-interfaces",
-  "version": "3.4.1-iam-auth-with-identityPool-provider-1.0",
+  "version": "3.5.0-cors-rule.0",
   "description": "Amplify GraphQL transformer interface definitions",
@@ -63,3 +63,3 @@ "repository": {
   },
-  "gitHead": "dafa4bb5ea5cec5dc90b722bf138064897f4f24a"
+  "gitHead": "8a673ad53fc3116a79c6ce1d52a1113eb0160e9b"
 }

src/model-datasource/types.ts

@@ -117,2 +117,34 @@ // #########################################################################################################################################
 
+/*
+ * The credentials the lambda data source will use to connect to the database.
+ *
+ * @experimental
+ */
+export type SqlModelDataSourceDbConnectionConfig =
+  | SqlModelDataSourceSecretsManagerDbConnectionConfig
+  | SqlModelDataSourceSsmDbConnectionConfig;
+
+/*
+ * 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.
+ * @experimental
+ */
+export interface SqlModelDataSourceSecretsManagerDbConnectionConfig {
+  /** The arn of the managed secret with username, password, and hostname to use when connecting to the database. **/
+  readonly secretArn: 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. **/
+  readonly keyArn?: string;
+
+  /** port number of the database proxy, cluster, or instance. */
+  readonly port: number;
+
+  /** database name. */
+  readonly databaseName: string;
+
+  /** The hostname of the database. */
+  readonly hostname: string;
+}
+
 /**
@@ -122,4 +154,5 @@ * 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.
+ * @experimental
  */
-export interface SqlModelDataSourceDbConnectionConfig {
+export interface SqlModelDataSourceSsmDbConnectionConfig {
   /** The Secure Systems Manager parameter containing the hostname of the database. For RDS-based SQL data sources, this can be the hostname
@@ -198,1 +231,43 @@ * of a database proxy, cluster, or instance.
 }
+
+/**
+ * Type predicate that returns true if the object is a SqlModelDataSourceDbConnectionConfig.
+ * @param obj the object to inspect
+ * @returns true if the object is shaped like a SqlModelDataSourceDbConnectionConfig
+ */
+export const isSqlModelDataSourceDbConnectionConfig = (obj: any): obj is SqlModelDataSourceDbConnectionConfig => {
+  return isSqlModelDataSourceSsmDbConnectionConfig(obj) || isSqlModelDataSourceSecretsManagerDbConnectionConfig(obj);
+};
+
+/**
+ * Type predicate that returns true if the object is a SqlModelDataSourceSsmDbConnectionConfig.
+ * @param obj the object to inspect
+ * @returns true if the object is shaped like a SqlModelDataSourceDbConnectionConfig
+ */
+export const isSqlModelDataSourceSsmDbConnectionConfig = (obj: any): obj is SqlModelDataSourceSsmDbConnectionConfig => {
+  return (
+    (typeof obj === 'object' || typeof obj === 'function') &&
+    typeof obj.hostnameSsmPath === 'string' &&
+    typeof obj.portSsmPath === 'string' &&
+    typeof obj.usernameSsmPath === 'string' &&
+    typeof obj.passwordSsmPath === 'string' &&
+    typeof obj.databaseNameSsmPath === 'string'
+  );
+};
+
+/**
+ * Type predicate that returns true if the object is a SqlModelDataSourceSecretsManagerDbConnectionConfig.
+ * @param obj the object to inspect
+ * @returns true if the object is shaped like a SqlModelDataSourceDbConnectionConfig
+ */
+export const isSqlModelDataSourceSecretsManagerDbConnectionConfig = (
+  obj: any,
+): obj is SqlModelDataSourceSecretsManagerDbConnectionConfig => {
+  return (
+    (typeof obj === 'object' || typeof obj === 'function') &&
+    typeof obj.secretArn === 'string' &&
+    typeof obj.port === 'number' &&
+    typeof obj.databaseName === 'string' &&
+    typeof obj.hostname === 'string'
+  );
+};

src/transformer-context/synth-parameters.ts

@@ -9,3 +9,2 @@ export type SynthParameters = {
   adminRoles?: string[];
-  enableIamAccess?: boolean;
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

561360

increased by1.3%

Lines of code

1976

increased by5.16%

No dependency changes