feat: Multi bucket support

.changeset/yellow-bats-cheer.md

@@ -0,0 +1,10 @@
+---
+'@aws-amplify/deployed-backend-client': minor
+'@aws-amplify/backend-output-schemas': minor
+'@aws-amplify/backend-output-storage': minor
+'@aws-amplify/backend-storage': minor
+'@aws-amplify/client-config': minor
+'@aws-amplify/plugin-types': minor
+---
+
+add support for multi-buckets

packages/backend-output-schemas/API.md

@@ -275,24 +275,29 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
         payload: z.ZodObject<{
             bucketName: z.ZodString;
             storageRegion: z.ZodString;
+            buckets: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>, "many">>;
         }, "strip", z.ZodTypeAny, {
             bucketName: string;
             storageRegion: string;
+            buckets?: Record<string, string>[] | undefined;
         }, {
             bucketName: string;
             storageRegion: string;
+            buckets?: Record<string, string>[] | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
         version: "1";
         payload: {
             bucketName: string;
             storageRegion: string;
+            buckets?: Record<string, string>[] | undefined;
         };
     }, {
         version: "1";
         payload: {
             bucketName: string;
             storageRegion: string;
+            buckets?: Record<string, string>[] | undefined;
         };
     }>]>>;
     "AWS::Amplify::Custom": z.ZodOptional<z.ZodDiscriminatedUnion<"version", [z.ZodObject<{
@@ -391,6 +396,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
         payload: {
             bucketName: string;
             storageRegion: string;
+            buckets?: Record<string, string>[] | undefined;
         };
     } | undefined;
     "AWS::Amplify::Function"?: {
@@ -455,6 +461,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
         payload: {
             bucketName: string;
             storageRegion: string;
+            buckets?: Record<string, string>[] | undefined;
         };
     } | undefined;
     "AWS::Amplify::Function"?: {
@@ -684,24 +691,29 @@ export const versionedStorageOutputSchema: z.ZodDiscriminatedUnion<"version", [z
     payload: z.ZodObject<{
         bucketName: z.ZodString;
         storageRegion: z.ZodString;
+        buckets: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodString>, "many">>;
     }, "strip", z.ZodTypeAny, {
         bucketName: string;
         storageRegion: string;
+        buckets?: Record<string, string>[] | undefined;
     }, {
         bucketName: string;
         storageRegion: string;
+        buckets?: Record<string, string>[] | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     version: "1";
     payload: {
         bucketName: string;
         storageRegion: string;
+        buckets?: Record<string, string>[] | undefined;
     };
 }, {
     version: "1";
     payload: {
         bucketName: string;
         storageRegion: string;
+        buckets?: Record<string, string>[] | undefined;
     };
 }>]>;
 

packages/backend-output-schemas/src/storage/v1.ts

@@ -1,9 +1,12 @@
 import { z } from 'zod';
 
+const bucketSchema = z.record(z.string(), z.string());
+
 export const storageOutputSchema = z.object({
   version: z.literal('1'),
   payload: z.object({
     bucketName: z.string(),
     storageRegion: z.string(),
+    buckets: z.array(bucketSchema).optional(),
   }),
 });

packages/backend-output-storage/src/stack_metadata_output_storage_strategy.ts

@@ -36,9 +36,19 @@ export class StackMetadataBackendOutputStorageStrategy
       new CfnOutput(this.stack, key, { value });
     });
 
+    const metadataValue =
+      this.stack.templateOptions.metadata &&
+      this.stack.templateOptions.metadata[keyName]
+        ? this.stack.templateOptions.metadata[keyName]
+        : { stackOutputs: [] };
+
     this.stack.addMetadata(keyName, {
+      ...metadataValue,
       version: backendOutputEntry.version,
-      stackOutputs: Object.keys(backendOutputEntry.payload),
+      stackOutputs: [
+        ...metadataValue.stackOutputs,
+        ...Object.keys(backendOutputEntry.payload),
+      ],
     });
   };
 

packages/backend-storage/API.md

@@ -14,7 +14,6 @@ import { IBucket } from 'aws-cdk-lib/aws-s3';
 import { ResourceAccessAcceptor } from '@aws-amplify/plugin-types';
 import { ResourceAccessAcceptorFactory } from '@aws-amplify/plugin-types';
 import { ResourceProvider } from '@aws-amplify/plugin-types';
-import { StorageOutput } from '@aws-amplify/backend-output-schemas';
 
 // @public (undocumented)
 export type AmplifyStorageFactoryProps = Omit<AmplifyStorageProps, 'outputStorageStrategy'> & {
@@ -23,9 +22,13 @@ export type AmplifyStorageFactoryProps = Omit<AmplifyStorageProps, 'outputStorag
 
 // @public (undocumented)
 export type AmplifyStorageProps = {
+    isDefault?: boolean;
     name: string;
     versioned?: boolean;
-    outputStorageStrategy?: BackendOutputStorageStrategy<StorageOutput>;
+    outputStorageStrategy?: BackendOutputStorageStrategy<{
+        version: '1';
+        payload: Record<string, string>;
+    }>;
     triggers?: Partial<Record<AmplifyStorageTriggerEvent, ConstructFactory<ResourceProvider<FunctionResources>>>>;
 };
 

packages/backend-storage/src/construct.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, mock } from 'node:test';
 import { AmplifyStorage } from './construct.js';
 import { App, Stack } from 'aws-cdk-lib';
-import { Capture, Template } from 'aws-cdk-lib/assertions';
+import { Capture, Match, Template } from 'aws-cdk-lib/assertions';
 import {
   BackendOutputEntry,
   BackendOutputStorageStrategy,
@@ -131,14 +131,22 @@ void describe('AmplifyStorage', () => {
 
       const storeOutputArgs = storeOutputMock.mock.calls[0].arguments;
       assert.strictEqual(storeOutputArgs.length, 2);
+      const bucketName = Object.entries(storeOutputArgs[1].payload).filter(
+        ([key]) => key.includes('bucketName')
+      )[0][0];
+      const storageRegion = Object.entries(storeOutputArgs[1].payload).filter(
+        ([key]) => key.includes('storageRegion')
+      )[0][0];
+      assert.equal(storeOutputArgs[0], storageOutputKey);
+      assert.equal(storeOutputArgs[1].version, '1');
 
       assert.deepStrictEqual(storeOutputArgs, [
         storageOutputKey,
         {
           version: '1',
           payload: {
-            bucketName: expectedBucketName,
-            storageRegion: expectedRegion,
+            [bucketName]: expectedBucketName,
+            [storageRegion]: expectedRegion,
           },
         },
       ]);
@@ -153,7 +161,10 @@ void describe('AmplifyStorage', () => {
         Metadata: {
           [storageOutputKey]: {
             version: '1',
-            stackOutputs: ['storageRegion', 'bucketName'],
+            stackOutputs: [
+              Match.stringLikeRegexp('storageRegion*'),
+              Match.stringLikeRegexp('bucketName*'),
+            ],
           },
         },
       });

packages/backend-storage/src/construct.ts

@@ -13,10 +13,7 @@ import {
   FunctionResources,
   ResourceProvider,
 } from '@aws-amplify/plugin-types';
-import {
-  StorageOutput,
-  storageOutputKey,
-} from '@aws-amplify/backend-output-schemas';
+import { storageOutputKey } from '@aws-amplify/backend-output-schemas';
 import { RemovalPolicy, Stack } from 'aws-cdk-lib';
 import {
   AttributionMetadataStorage,
@@ -32,6 +29,11 @@ const storageStackType = 'storage-S3';
 export type AmplifyStorageTriggerEvent = 'onDelete' | 'onUpload';
 
 export type AmplifyStorageProps = {
+  /**
+   * Whether this storage resource is the default storage resource for the backend
+   * @default false
+   */
+  isDefault?: boolean;
   /**
    * Friendly name that will be used to derive the S3 Bucket name
    */
@@ -42,7 +44,10 @@ export type AmplifyStorageProps = {
    * @default false
    */
   versioned?: boolean;
-  outputStorageStrategy?: BackendOutputStorageStrategy<StorageOutput>;
+  outputStorageStrategy?: BackendOutputStorageStrategy<{
+    version: '1';
+    payload: Record<string, string>;
+  }>;
   /**
    * S3 event trigger configuration
    * @see https://docs.amplify.aws/gen2/build-a-backend/storage/#configure-storage-triggers
@@ -122,7 +127,7 @@ export class AmplifyStorage
       },
     };
 
-    this.storeOutput(props.outputStorageStrategy);
+    this.storeOutput(props.outputStorageStrategy, props.isDefault || false);
 
     new AttributionMetadataStorage().storeAttributionMetadata(
       Stack.of(this),
@@ -146,15 +151,22 @@ export class AmplifyStorage
    * Store storage outputs using provided strategy
    */
   private storeOutput = (
-    outputStorageStrategy: BackendOutputStorageStrategy<StorageOutput> = new StackMetadataBackendOutputStorageStrategy(
-      Stack.of(this)
-    )
+    outputStorageStrategy: BackendOutputStorageStrategy<{
+      version: '1';
+      payload: Record<string, string>;
+    }> = new StackMetadataBackendOutputStorageStrategy(Stack.of(this)),
+    isDefault: boolean = false
   ): void => {
+    /* The following code can guarantee there's only one `isDefault`
+     * because if we can only create one construct with the same `storageRegion` and `bucketName` name.
+     * The default bucket takes the `storageRegion` and `bucketName` name without a number post-fix.
+     */
+    const num = isDefault ? '' : Math.floor(Math.random() * 100);
     outputStorageStrategy.addBackendOutputEntry(storageOutputKey, {
       version: '1',
       payload: {
-        storageRegion: Stack.of(this).region,
-        bucketName: this.resources.bucket.bucketName,
+        [`storageRegion${num}`]: Stack.of(this).region,
+        [`bucketName${num}`]: this.resources.bucket.bucketName,
       },
     });
   };

packages/backend-storage/src/storage_access_policy_factory.ts

@@ -63,9 +63,15 @@ export class StorageAccessPolicyFactory {
       });
     }
 
-    return new Policy(this.stack, `${this.namePrefix}${this.policyCount++}`, {
-      statements,
-    });
+    return new Policy(
+      this.stack,
+      `${this.bucket.bucketName.slice(0, 6)}${Math.floor(
+        Math.random() * 1000
+      )}`,
+      {
+        statements,
+      }
+    );
   };
 
   private getStatement = (

packages/client-config/API.md

@@ -22,6 +22,16 @@ interface AmazonLocationServiceConfig {
 // @public
 type AmazonPinpointChannels = 'IN_APP_MESSAGING' | 'FCM' | 'APNS' | 'EMAIL' | 'SMS';
 
+// @public (undocumented)
+interface AmplifyStorageBucket {
+    // (undocumented)
+    aws_region: string;
+    // (undocumented)
+    bucket_name: string;
+    // (undocumented)
+    name: string;
+}
+
 // @public (undocumented)
 export type AnalyticsClientConfig = {
     aws_mobile_analytics_app_id?: string;
@@ -135,6 +145,7 @@ interface AWSAmplifyBackendOutputs {
     storage?: {
         aws_region: AwsRegion;
         bucket_name: string;
+        buckets?: AmplifyStorageBucket[];
     };
     version: '1';
 }
@@ -180,7 +191,8 @@ declare namespace clientConfigTypesV1 {
         AwsAppsyncAuthorizationType,
         AmazonPinpointChannels,
         AWSAmplifyBackendOutputs,
-        AmazonLocationServiceConfig
+        AmazonLocationServiceConfig,
+        AmplifyStorageBucket
     }
 }
 export { clientConfigTypesV1 }

packages/client-config/src/client-config-contributor/client_config_contributor_v1.ts

@@ -12,7 +12,10 @@ import {
   clientConfigTypesV1,
 } from '../client-config-types/client_config.js';
 import { ModelIntrospectionSchemaAdapter } from '../model_introspection_schema_adapter.js';
-import { AwsAppsyncAuthorizationType } from '../client-config-schema/client_config_v1.js';
+import {
+  AmplifyStorageBucket,
+  AwsAppsyncAuthorizationType,
+} from '../client-config-schema/client_config_v1.1.js';
 
 // All categories client config contributors are included here to mildly enforce them using
 // the same schema (version and other types)
@@ -254,6 +257,8 @@ export class StorageClientConfigContributor implements ClientConfigContributor {
     config.storage = {
       aws_region: storageOutput.payload.storageRegion,
       bucket_name: storageOutput.payload.bucketName,
+      buckets: storageOutput.payload
+        .buckets as unknown as AmplifyStorageBucket[],
     };
 
     return config;

packages/client-config/src/client-config-schema/client_config_v1.ts → packages/client-config/src/client-config-schema/client_config_v1.1.ts

@@ -216,6 +216,7 @@ export interface AWSAmplifyBackendOutputs {
   storage?: {
     aws_region: AwsRegion;
     bucket_name: string;
+    buckets?: AmplifyStorageBucket[];
   };
   /**
    * Outputs generated from backend.addOutput({ custom: <config> })
@@ -238,3 +239,8 @@ export interface AmazonLocationServiceConfig {
    */
   style?: string;
 }
+export interface AmplifyStorageBucket {
+  name: string;
+  bucket_name: string;
+  aws_region: string;
+}