rename ephemeralStorageSize to ephemeralStorageSizeMB

Author: fossamagna

.changeset/nasty-tables-heal.md

@@ -2,4 +2,4 @@
 '@aws-amplify/backend-function': minor
 ---
 
-Add ephemeralStorageSize option to defineFunction
+Add ephemeralStorageSizeMB option to defineFunction

packages/backend-function/API.md

@@ -93,7 +93,7 @@ export type FunctionProps = {
     entry?: string;
     timeoutSeconds?: number;
     memoryMB?: number;
-    ephemeralStorageSize?: number;
+    ephemeralStorageSizeMB?: number;
     environment?: Record<string, string | BackendSecret>;
     runtime?: NodeVersion;
     schedule?: FunctionSchedule | FunctionSchedule[];

packages/backend-function/src/factory.test.ts

@@ -683,11 +683,11 @@ void describe('AmplifyFunctionFactory', () => {
     );
   });
 
-  void describe('ephemeralStorageSize property', () => {
+  void describe('ephemeralStorageSizeMB property', () => {
     void it('sets valid ephemeralStorageSize', () => {
       const lambda = defineFunction({
         entry: './test-assets/default-lambda/handler.ts',
-        ephemeralStorageSize: 1024,
+        ephemeralStorageSizeMB: 1024,
       }).getInstance(getInstanceProps);
       const template = Template.fromStack(lambda.stack);
 
@@ -696,7 +696,7 @@ void describe('AmplifyFunctionFactory', () => {
       });
     });
 
-    void it('sets default ephemeralStorageSize', () => {
+    void it('sets default ephemeralStorageSizeMB', () => {
       const lambda = defineFunction({
         entry: './test-assets/default-lambda/handler.ts',
       }).getInstance(getInstanceProps);
@@ -707,41 +707,41 @@ void describe('AmplifyFunctionFactory', () => {
       });
     });
 
-    void it('throws on ephemeralStorageSize below 512 MB', () => {
+    void it('throws on ephemeralStorageSizeMB below 512 MB', () => {
       assert.throws(
         () =>
           defineFunction({
             entry: './test-assets/default-lambda/handler.ts',
-            ephemeralStorageSize: 511,
+            ephemeralStorageSizeMB: 511,
           }).getInstance(getInstanceProps),
         new Error(
-          'ephemeralStorageSize must be a whole number between 512 and 10240 inclusive'
+          'ephemeralStorageSizeMB must be a whole number between 512 and 10240 inclusive'
         )
       );
     });
 
-    void it('throws on ephemeralStorageSize above 10240 MB', () => {
+    void it('throws on ephemeralStorageSizeMB above 10240 MB', () => {
       assert.throws(
         () =>
           defineFunction({
             entry: './test-assets/default-lambda/handler.ts',
-            ephemeralStorageSize: 10241,
+            ephemeralStorageSizeMB: 10241,
           }).getInstance(getInstanceProps),
         new Error(
-          'ephemeralStorageSize must be a whole number between 512 and 10240 inclusive'
+          'ephemeralStorageSizeMB must be a whole number between 512 and 10240 inclusive'
         )
       );
     });
 
-    void it('throws on fractional ephemeralStorageSize', () => {
+    void it('throws on fractional ephemeralStorageSizeMB', () => {
       assert.throws(
         () =>
           defineFunction({
             entry: './test-assets/default-lambda/handler.ts',
-            ephemeralStorageSize: 512.5,
+            ephemeralStorageSizeMB: 512.5,
           }).getInstance(getInstanceProps),
         new Error(
-          'ephemeralStorageSize must be a whole number between 512 and 10240 inclusive'
+          'ephemeralStorageSizeMB must be a whole number between 512 and 10240 inclusive'
         )
       );
     });

packages/backend-function/src/factory.ts

@@ -116,11 +116,11 @@ export type FunctionProps = {
   memoryMB?: number;
 
   /**
-   * The size of the function's /tmp directory in MiB.
+   * The size of the function's /tmp directory in MB.
    * Must be a whole number.
    * @default 512
    */
-  ephemeralStorageSize?: number;
+  ephemeralStorageSizeMB?: number;
 
   /**
    * Environment variables that will be available during function execution
@@ -243,7 +243,7 @@ class FunctionFactory implements ConstructFactory<AmplifyFunction> {
       entry: this.resolveEntry(),
       timeoutSeconds: this.resolveTimeout(),
       memoryMB: this.resolveMemory(),
-      ephemeralStorageSize: this.resolveEphemeralStorageSize(),
+      ephemeralStorageSizeMB: this.resolveEphemeralStorageSize(),
       environment: this.resolveEnvironment(),
       runtime: this.resolveRuntime(),
       schedule: this.resolveSchedule(),
@@ -336,21 +336,21 @@ class FunctionFactory implements ConstructFactory<AmplifyFunction> {
     const ephemeralStorageSizeMin = 512;
     const ephemeralStorageSizeMax = 10240;
     const ephemeralStorageSizeDefault = 512;
-    if (this.props.ephemeralStorageSize === undefined) {
+    if (this.props.ephemeralStorageSizeMB === undefined) {
       return ephemeralStorageSizeDefault;
     }
     if (
       !isWholeNumberBetweenInclusive(
-        this.props.ephemeralStorageSize,
+        this.props.ephemeralStorageSizeMB,
         ephemeralStorageSizeMin,
         ephemeralStorageSizeMax
       )
     ) {
       throw new Error(
-        `ephemeralStorageSize must be a whole number between ${ephemeralStorageSizeMin} and ${ephemeralStorageSizeMax} inclusive`
+        `ephemeralStorageSizeMB must be a whole number between ${ephemeralStorageSizeMin} and ${ephemeralStorageSizeMax} inclusive`
       );
     }
-    return this.props.ephemeralStorageSize;
+    return this.props.ephemeralStorageSizeMB;
   };
 
   private resolveEnvironment = () => {
@@ -538,7 +538,7 @@ class AmplifyFunction
         entry: props.entry,
         timeout: Duration.seconds(props.timeoutSeconds),
         memorySize: props.memoryMB,
-        ephemeralStorageSize: Size.mebibytes(props.ephemeralStorageSize),
+        ephemeralStorageSize: Size.mebibytes(props.ephemeralStorageSizeMB),
         runtime: nodeVersionMap[props.runtime],
         layers: props.resolvedLayers,
         bundling: {