[POC] Introduce and enforce new stack structure

packages/backend-ai/src/conversation/factory.ts

@@ -16,6 +16,7 @@ import {
 import path from 'path';
 import { CallerDirectoryExtractor } from '@aws-amplify/platform-core';
 import { AiModel } from '@aws-amplify/data-schema-types';
+import { Stack } from 'aws-cdk-lib';
 
 class ConversationHandlerFunctionGenerator
   implements ConstructContainerEntryGenerator
@@ -72,11 +73,14 @@ class DefaultConversationHandlerFunctionFactory
     private readonly callerStack: string | undefined
   ) {}
 
-  getInstance = ({
-    constructContainer,
-    outputStorageStrategy,
-    resourceNameValidator,
-  }: ConstructFactoryGetInstanceProps): ConversationHandlerFunction => {
+  getInstance = (
+    {
+      constructContainer,
+      outputStorageStrategy,
+      resourceNameValidator,
+    }: ConstructFactoryGetInstanceProps,
+    stack?: Stack
+  ): ConversationHandlerFunction => {
     resourceNameValidator?.validate(this.props.name);
     if (!this.generator) {
       const props = { ...this.props };
@@ -87,7 +91,8 @@ class DefaultConversationHandlerFunctionFactory
       );
     }
     return constructContainer.getOrCompute(
-      this.generator
+      this.generator,
+      stack
     ) as ConversationHandlerFunction;
   };
 

packages/backend-auth/src/factory.ts

@@ -98,7 +98,8 @@ export class AmplifyAuthFactory implements ConstructFactory<BackendAuth> {
    * Get a singleton instance of AmplifyAuth
    */
   getInstance = (
-    getInstanceProps: ConstructFactoryGetInstanceProps
+    getInstanceProps: ConstructFactoryGetInstanceProps,
+    stack?: Stack
   ): BackendAuth => {
     const { constructContainer, importPathVerifier, resourceNameValidator } =
       getInstanceProps;
@@ -111,9 +112,16 @@ export class AmplifyAuthFactory implements ConstructFactory<BackendAuth> {
       resourceNameValidator?.validate(this.props.name);
     }
     if (!this.generator) {
-      this.generator = new AmplifyAuthGenerator(this.props, getInstanceProps);
+      this.generator = new AmplifyAuthGenerator(
+        this.props,
+        getInstanceProps,
+        stack
+      );
     }
-    return constructContainer.getOrCompute(this.generator) as BackendAuth;
+    return constructContainer.getOrCompute(
+      this.generator,
+      stack
+    ) as BackendAuth;
   };
 }
 
@@ -124,6 +132,7 @@ class AmplifyAuthGenerator implements ConstructContainerEntryGenerator {
   constructor(
     private readonly props: AmplifyAuthProps,
     private readonly getInstanceProps: ConstructFactoryGetInstanceProps,
+    private readonly stack?: Stack,
     private readonly authAccessBuilder = _authAccessBuilder,
     private readonly authAccessPolicyArbiterFactory = new AuthAccessPolicyArbiterFactory()
   ) {
@@ -169,7 +178,8 @@ class AmplifyAuthGenerator implements ConstructContainerEntryGenerator {
       ([triggerEvent, handlerFactory]) => {
         (authConstruct.resources.userPool as UserPool).addTrigger(
           UserPoolOperation.of(triggerEvent),
-          handlerFactory.getInstance(this.getInstanceProps).resources.lambda
+          handlerFactory.getInstance(this.getInstanceProps, this.stack)
+            .resources.lambda
         );
       }
     );

packages/backend-data/src/factory.ts

@@ -38,7 +38,7 @@ import {
   CDKContextKey,
   TagName,
 } from '@aws-amplify/platform-core';
-import { Aspects, IAspect, Tags } from 'aws-cdk-lib';
+import { Aspects, IAspect, Stack, Tags } from 'aws-cdk-lib';
 import { convertJsResolverDefinition } from './convert_js_resolvers.js';
 import { AppSyncPolicyGenerator } from './app_sync_policy_generator.js';
 import {
@@ -77,7 +77,10 @@ export class DataFactory implements ConstructFactory<AmplifyData> {
   /**
    * Gets an instance of the Data construct
    */
-  getInstance = (props: ConstructFactoryGetInstanceProps): AmplifyData => {
+  getInstance = (
+    props: ConstructFactoryGetInstanceProps,
+    stack?: Stack
+  ): AmplifyData => {
     const {
       constructContainer,
       outputStorageStrategy,
@@ -106,7 +109,10 @@ export class DataFactory implements ConstructFactory<AmplifyData> {
         outputStorageStrategy
       );
     }
-    return constructContainer.getOrCompute(this.generator) as AmplifyData;
+    return constructContainer.getOrCompute(
+      this.generator,
+      stack
+    ) as AmplifyData;
   };
 }
 

packages/backend-function/src/factory.ts

@@ -177,18 +177,24 @@ class FunctionFactory implements ConstructFactory<AmplifyFunction> {
   /**
    * Creates an instance of AmplifyFunction within the provided Amplify context
    */
-  getInstance = ({
-    constructContainer,
-    outputStorageStrategy,
-    resourceNameValidator,
-  }: ConstructFactoryGetInstanceProps): AmplifyFunction => {
+  getInstance = (
+    {
+      constructContainer,
+      outputStorageStrategy,
+      resourceNameValidator,
+    }: ConstructFactoryGetInstanceProps,
+    stack?: Stack
+  ): AmplifyFunction => {
     if (!this.generator) {
       this.generator = new FunctionGenerator(
         this.hydrateDefaults(resourceNameValidator),
         outputStorageStrategy
       );
     }
-    return constructContainer.getOrCompute(this.generator) as AmplifyFunction;
+    return constructContainer.getOrCompute(
+      this.generator,
+      stack
+    ) as AmplifyFunction;
   };
 
   private hydrateDefaults = (

packages/backend-storage/src/factory.ts

@@ -32,7 +32,8 @@ export class AmplifyStorageFactory
    * Get a singleton instance of the Bucket
    */
   getInstance = (
-    getInstanceProps: ConstructFactoryGetInstanceProps
+    getInstanceProps: ConstructFactoryGetInstanceProps,
+    stack?: Stack
   ): AmplifyStorage => {
     const { constructContainer, importPathVerifier, resourceNameValidator } =
       getInstanceProps;
@@ -50,7 +51,8 @@ export class AmplifyStorageFactory
       );
     }
     const amplifyStorage = constructContainer.getOrCompute(
-      this.generator
+      this.generator,
+      stack
     ) as AmplifyStorage;
 
     /*

packages/backend/API.md

@@ -34,6 +34,16 @@ import { Stack } from 'aws-cdk-lib';
 
 export { a }
 
+// @public (undocumented)
+export type AmplifyStackBase = {
+    readonly stack: Stack;
+};
+
+// @public (undocumented)
+export type AmplifyStackResources = AmplifyStackBase & {
+    [K in keyof DefineStackProps]: Omit<ReturnType<DefineStackProps[K]['getInstance']>, keyof ResourceAccessAcceptorFactory>;
+};
+
 export { AuthCfnResources }
 
 export { AuthResources }
@@ -47,7 +57,6 @@ export type Backend<T extends DefineBackendProps> = BackendBase & {
 
 // @public (undocumented)
 export type BackendBase = {
-    createStack: (name: string) => Stack;
     addOutput: (clientConfigPart: DeepPartialAmplifyGeneratedConfigs<ClientConfig>) => void;
     stack: Stack;
 };
@@ -74,14 +83,22 @@ export { defineAuth }
 export const defineBackend: <T extends DefineBackendProps>(constructFactories: T) => Backend<T>;
 
 // @public (undocumented)
-export type DefineBackendProps = Record<string, ConstructFactory<ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>>> & {
+export type DefineBackendProps = Record<string, ConstructFactory<ResourceProvider<AmplifyStackResources>>> & {
     [K in keyof BackendBase]?: never;
 };
 
 export { defineData }
 
 export { defineFunction }
 
+// @public
+export const defineStack: (name: string, constructFactories: DefineStackProps) => ConstructFactory<ResourceProvider<AmplifyStackResources>>;
+
+// @public (undocumented)
+export type DefineStackProps = Record<string, ConstructFactory<ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>>> & {
+    [K in keyof AmplifyStackBase]?: never;
+};
+
 export { defineStorage }
 
 export { FunctionResources }

packages/backend/src/backend.ts

@@ -6,9 +6,9 @@
 } from '@aws-amplify/plugin-types';
 import { Stack } from 'aws-cdk-lib';
 import { ClientConfig } from '@aws-amplify/client-config';
+import { AmplifyStackResources } from './stack_factory.js';
 
 export type BackendBase = {
-  createStack: (name: string) => Stack;
   addOutput: (
     clientConfigPart: DeepPartialAmplifyGeneratedConfigs<ClientConfig>
   ) => void;
@@ -18,9 +18,7 @@
 // Type that allows construct factories to be defined using any keys except those used in BackendHelpers
 export type DefineBackendProps = Record<
   string,
-  ConstructFactory<
-    ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>
-  >
+  ConstructFactory<ResourceProvider<AmplifyStackResources>>
 > & { [K in keyof BackendBase]?: never };
 
 /**

packages/backend/src/backend_factory.test.ts

@@ -175,22 +175,6 @@ void describe('Backend', () => {
     rootStackTemplate.resourceCountIs('Custom::AmplifyBranchLinkerResource', 0);
   });
 
-  void describe('createStack', () => {
-    void it('returns nested stack', () => {
-      const backend = new BackendFactory({}, rootStack);
-      const testStack = backend.createStack('testStack');
-      assert.strictEqual(rootStack.node.findChild('testStack'), testStack);
-    });
-
-    void it('throws if stack has already been created with specified name', () => {
-      const backend = new BackendFactory({}, rootStack);
-      backend.createStack('testStack');
-      assert.throws(() => backend.createStack('testStack'), {
-        message: 'Custom stack named testStack has already been created',
-      });
-    });
-  });
-
   void it('can add custom output', () => {
     const rootStack = createStackAndSetContext('sandbox');
     const backend = new BackendFactory({}, rootStack);

packages/backend/src/backend_factory.ts

@@ -127,14 +127,6 @@ export class BackendFactory<
     );
   }
 
-  /**
-   * Returns a CDK stack within the Amplify project that can be used for creating custom resources.
-   * If a stack has already been created with "name" then an error is thrown.
-   */
-  createStack = (name: string): Stack => {
-    return this.stackResolver.createCustomStack(name);
-  };
-
   addOutput = (
     clientConfigPart: DeepPartialAmplifyGeneratedConfigs<ClientConfig>
   ) => {
@@ -157,7 +149,6 @@ export const defineBackend = <T extends DefineBackendProps>(
   const backend = new BackendFactory(constructFactories);
   return {
     ...backend.resources,
-    createStack: backend.createStack,
     addOutput: backend.addOutput,
     stack: backend.stack,
   };

packages/backend/src/engine/singleton_construct_container.ts

@@ -9,6 +9,7 @@ import { getBackendIdentifier } from '../backend_identifier.js';
 import { DefaultBackendSecretResolver } from './backend-secret/backend_secret_resolver.js';
 import { BackendIdScopedSsmEnvironmentEntriesGenerator } from './backend_id_scoped_ssm_environment_entries_generator.js';
 import { BackendIdScopedStableBackendIdentifiers } from '../backend_id_scoped_stable_backend_identifiers.js';
+import { Stack } from 'aws-cdk-lib';
 
 /**
  * Serves as a DI container and shared state store for initializing Amplify constructs
@@ -33,10 +34,13 @@ export class SingletonConstructContainer implements ConstructContainer {
    * Otherwise, the generator is called and the value is cached and returned
    */
   getOrCompute = (
-    generator: ConstructContainerEntryGenerator
+    generator: ConstructContainerEntryGenerator,
+    scope?: Stack
   ): ResourceProvider => {
     if (!this.providerCache.has(generator)) {
-      const scope = this.stackResolver.getStackFor(generator.resourceGroupName);
+      if (!scope) {
+        scope = this.stackResolver.getStackFor(generator.resourceGroupName);
+      }
       const backendId = getBackendIdentifier(scope);
       const ssmEnvironmentEntriesGenerator =
         new BackendIdScopedSsmEnvironmentEntriesGenerator(scope, backendId);

packages/backend/src/index.ts

@@ -24,3 +24,6 @@ export { defineStorage } from '@aws-amplify/backend-storage';
 
 // function
 export { defineFunction } from '@aws-amplify/backend-function';
+
+// stack
+export * from './stack_factory.js';