add resourceGroupName prop to function (#2233)

* add resourceGroupName prop to function and storage

* PR feedback

* update changeset

Author: rtpascual

.changeset/bright-guests-marry.md

@@ -0,0 +1,11 @@
+---
+'@aws-amplify/backend-function': minor
+'@aws-amplify/backend-storage': patch
+'@aws-amplify/plugin-types': minor
+'@aws-amplify/backend': minor
+'@aws-amplify/backend-auth': patch
+'@aws-amplify/backend-data': patch
+'@aws-amplify/backend-ai': patch
+---
+
+add resourceGroupName prop to function

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

@@ -1,5 +1,6 @@
 import { AIConversationOutput } from '@aws-amplify/backend-output-schemas';
 import {
+  AmplifyResourceGroupName,
   BackendOutputStorageStrategy,
   ConstructContainerEntryGenerator,
   ConstructFactory,
@@ -20,7 +21,8 @@ import { AiModel } from '@aws-amplify/data-schema-types';
 class ConversationHandlerFunctionGenerator
   implements ConstructContainerEntryGenerator
 {
-  readonly resourceGroupName = 'conversationHandlerFunction';
+  readonly resourceGroupName: AmplifyResourceGroupName =
+    'conversationHandlerFunction';
 
   constructor(
     private readonly props: DefineConversationHandlerFunctionProps,

packages/backend-auth/src/factory.ts

@@ -12,6 +12,7 @@ import {
   TriggerEvent,
 } from '@aws-amplify/auth-construct';
 import {
+  AmplifyResourceGroupName,
   AuthResources,
   AuthRoleName,
   ConstructContainerEntryGenerator,
@@ -134,7 +135,7 @@ export class AmplifyAuthFactory implements ConstructFactory<BackendAuth> {
 }
 
 class AmplifyAuthGenerator implements ConstructContainerEntryGenerator {
-  readonly resourceGroupName = 'auth';
+  readonly resourceGroupName: AmplifyResourceGroupName = 'auth';
   private readonly name: string;
 
   constructor(

packages/backend-auth/src/reference_factory.ts

@@ -1,4 +1,5 @@
 import {
+  AmplifyResourceGroupName,
   AuthRoleName,
   BackendOutputStorageStrategy,
   ConstructContainerEntryGenerator,
@@ -129,7 +130,7 @@ export class AmplifyReferenceAuthFactory
 class AmplifyReferenceAuthGenerator
   implements ConstructContainerEntryGenerator
 {
-  readonly resourceGroupName = 'auth';
+  readonly resourceGroupName: AmplifyResourceGroupName = 'auth';
   private readonly name: string;
 
   constructor(

packages/backend-data/src/factory.ts

@@ -1,6 +1,7 @@
 import { IConstruct } from 'constructs';
 import {
   AmplifyFunction,
+  AmplifyResourceGroupName,
   AuthResources,
   BackendOutputStorageStrategy,
   ConstructContainerEntryGenerator,
@@ -112,7 +113,7 @@ export class DataFactory implements ConstructFactory<AmplifyData> {
 }
 
 class DataGenerator implements ConstructContainerEntryGenerator {
-  readonly resourceGroupName = 'data';
+  readonly resourceGroupName: AmplifyResourceGroupName = 'data';
   private readonly name: string;
 
   constructor(

packages/backend-function/API.md

@@ -4,6 +4,7 @@
 
 ```ts
 
+import { AmplifyResourceGroupName } from '@aws-amplify/plugin-types';
 import { BackendSecret } from '@aws-amplify/plugin-types';
 import { ConstructFactory } from '@aws-amplify/plugin-types';
 import { FunctionResources } from '@aws-amplify/plugin-types';
@@ -38,6 +39,7 @@ export type FunctionProps = {
     schedule?: FunctionSchedule | FunctionSchedule[];
     layers?: Record<string, string>;
     bundling?: FunctionBundlingOptions;
+    resourceGroupName?: AmplifyResourceGroupName;
 };
 
 // @public (undocumented)

packages/backend-function/src/factory.ts

@@ -9,6 +9,7 @@ import {
   TagName,
 } from '@aws-amplify/platform-core';
 import {
+  AmplifyResourceGroupName,
   BackendOutputStorageStrategy,
   BackendSecret,
   BackendSecretResolver,
@@ -150,6 +151,14 @@ export type FunctionProps = {
    * Options for bundling the function code.
    */
   bundling?: FunctionBundlingOptions;
+
+  /**
+   * Group the function with existing Amplify resources or separate the function into its own group.
+   * @default 'function' // grouping with other Amplify functions
+   * @example
+   * resourceGroupName: 'auth' // to group an auth trigger with an auth resource
+   */
+  resourceGroupName?: AmplifyResourceGroupName;
 };
 
 export type FunctionBundlingOptions = {
@@ -208,6 +217,7 @@ class FunctionFactory implements ConstructFactory<AmplifyFunction> {
       schedule: this.resolveSchedule(),
       bundling: this.resolveBundling(),
       layers,
+      resourceGroupName: this.props.resourceGroupName ?? 'function',
     };
   };
 
@@ -339,12 +349,14 @@ class FunctionFactory implements ConstructFactory<AmplifyFunction> {
 type HydratedFunctionProps = Required<FunctionProps>;
 
 class FunctionGenerator implements ConstructContainerEntryGenerator {
-  readonly resourceGroupName = 'function';
+  readonly resourceGroupName: AmplifyResourceGroupName;
 
   constructor(
     private readonly props: HydratedFunctionProps,
     private readonly outputStorageStrategy: BackendOutputStorageStrategy<FunctionOutput>
-  ) {}
+  ) {
+    this.resourceGroupName = props.resourceGroupName;
+  }
 
   generateContainerEntry = ({
     scope,

packages/backend-storage/src/storage_container_entry_generator.ts

@@ -1,4 +1,5 @@
 import {
+  AmplifyResourceGroupName,
   ConstructContainerEntryGenerator,
   ConstructFactoryGetInstanceProps,
   GenerateContainerEntryProps,
@@ -17,7 +18,7 @@ import { TagName } from '@aws-amplify/platform-core';
 export class StorageContainerEntryGenerator
   implements ConstructContainerEntryGenerator
 {
-  readonly resourceGroupName = 'storage';
+  readonly resourceGroupName: AmplifyResourceGroupName = 'storage';
 
   /**
    * Initialize with context from storage factory

packages/integration-tests/src/test-e2e/deployment/circular_dep_auth_data_func.deployment.test.ts

@@ -0,0 +1,4 @@
+import { CircularDepAuthDataFuncTestProjectCreator } from '../../test-project-setup/circular_dep_auth_data_func.js';
+import { defineDeploymentTest } from './deployment.test.template.js';
+
+defineDeploymentTest(new CircularDepAuthDataFuncTestProjectCreator());

packages/integration-tests/src/test-e2e/deployment/circular_dep_data_func.deployment.test.ts

@@ -0,0 +1,4 @@
+import { CircularDepDataFuncTestProjectCreator } from '../../test-project-setup/circular_dep_data_func.js';
+import { defineDeploymentTest } from './deployment.test.template.js';
+
+defineDeploymentTest(new CircularDepDataFuncTestProjectCreator());