1016780: Need to include new UG section on how to deploy spreadsheet server to AWS Lambda #2456
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| layout: post | ||
| title: Deploy Spreadsheet Server to AWS Lambda | ||
| description: Learn how to deploy the Syncfusion Spreadsheet Server to AWS Lamda | ||
| control: How to deploy eploy the Syncfusion Spreadsheet Server to AWS Lamda | ||
| platform: document-processing | ||
| documentation: ug | ||
| --- | ||
|
|
||
| # Publish Spreadsheet Server to AWS Lambda Visual Studio | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| * [`AWS account`](https://aws.amazon.com/lambda/) with `IAM credentials` | ||
| * The Spreadsheet [`Web API`](https://github.com/SyncfusionExamples/EJ2-Spreadsheet-WebServices/tree/main/WebAPI) project (Check out our detailed [`blog`](https://www.syncfusion.com/blogs/post/host-spreadsheet-open-and-save-services) to set up the web service locally). | ||
|
|
||
| ## Publish to AWS Lambda Service | ||
| **Step 1:** Server-Side changes | ||
|
|
||
| * Opening the file: | ||
| The client converts the Excel file to base64 and sends it to the hosted Open endpoint - then simply loads the response into the Syncfusion React Spreadsheet. The AWS Lambda backend decodes the file, processes it with Workbook.Open, and returns spreadsheet-ready JSON for instant rendering on the frontend. You can refer to this [documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/react/open-excel-files#open-excel-files-with-aws-lambda) to know about the opening the file with AWS Lambda service. | ||
|
Contributor
There was a problem hiding this comment. Before mentioning the configuration details, we need to update the details that why we need to add these configurations. |
||
|
|
||
| * Saving the file: | ||
| The client converts the spreadsheet to JSON using the [saveAsJson](https://helpej2.syncfusion.com/react/documentation/api/spreadsheet/#saveasjson) method and sends it to AWS Lambda via fetch. It then decodes the base64 Excel response and creates a downloadable Excel file using a Blob. Receive the spreadsheet JSON in your Lambda function, convert it to an Excel file using Workbook.Save, and return it as a base64 string for secure client-side download. You can refer to this [documentation](https://help.syncfusion.com/document-processing/excel/spreadsheet/react/save-excel-files#save-excel-files-with-aws-lambda) to know about the saving the file with AWS Lambda service. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. The Open and Save configuration should not be updated under Publish steps. |
||
|
|
||
| **Step 2:** Deploy ASP.NET Core Spreadsheet Web API Service to AWS Lambda | ||
|
|
||
| * Open `WebAPI project → Extensions > Manage Extensions → install AWS Toolkit with Amazon Q`. Restart VS. | ||
| * From Extensions menu, select `Getting Started → enable AWS Toolkit with IAM credentials`. | ||
| * Install the NuGet package: `Amazon.Lambda.AspNetCoreServer.Hosting`. | ||
| * In WebAPI.csproj, add: | ||
| ```csharp | ||
| <AWSProjectType>Lambda</AWSProjectType> | ||
| ``` | ||
| * In program.cs, add: | ||
| ```csharp | ||
| builder.Services.AddAWSLambdaHosting(LambdaEventSource.RestApi); | ||
| ``` | ||
| * In `Solution Explorer → right-click project → Publish to AWS Lambda`. | ||
| * Then enter your AWS credentials, choose your existing Lambda function or create a new function, enter the Handler name that matches your project name, and upload. | ||
| * Host your project by creating a REST API in AWS API Gateway. | ||
| * Integrate your API with Lambda by editing the integration, selecting your region and function, enabling Lambda Proxy Integration, and saving. | ||
| * Deploy your API by selecting the Deploy API option and creating a new stage name. The hosted URL can then be used for open and save fetch requests in your React Spreadsheet sample. | ||
|
Contributor
There was a problem hiding this comment. These are not shoulde be updated like this. If there are any codes to update means, we can update the screenshot for better understanding. Please revamp the publishing steps clearly. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check the control and update properly. Also, update the description properly.