Working with AWS Application Builder
The following sections describe how to access AWS Application Builder in the AWS Toolkit for Visual Studio Code so you can build projects visually, iterate on them locally, and deploy them to AWS.
Working with the AWS Application Builder explorer
To access AWS Application Builder in the AWS Toolkit, open the AWS Toolkit in VS Code, then expand the AWS Application Builder explorer. The AWS Application Builder explorer contains a link to open the Walkthrough of Application Builder in a VS Code editor tab, and displays folders within your current VS Code workspace that contain AWS Application Builder related resources.
From the Application Builder explorer in the AWS Toolkit, there are 4 project-folder-level actions that are accessible from the button icons located next to your project folder or by opening the context menu for (right-clicking) the project folder:
Open Template File: Opens your template file in the VS Code explorer.
Open with Infrastructure Composer: Opens your template file with AWS Infrastructure Composer in the VS Code editor. For detailed information about working with AWS Infrastructure Composer, see the What is AWS Infrastructure Composer topic in the AWS Infrastructure Composer Developer Guide.
Build SAM Template: Opens the Specify parameters for build dialog in the AWS Toolkit. You can choose to Specify build flags for the build or Use default values from samconfig. For detailed information about AWS SAM templates, see the Template anatomy topic in the AWS Serverless Application Model Developer Guide.
Deploy SAM Application: Opens the Select deployment command dialog in VS Code where your can choose to Deploy your application or Sync, to update an application you've already deployed. For detailed information on deploying AWS SAM applications see the Deploy your application and resources topic in the AWS Serverless Application Model Developer Guide.
There are 2 actions that are accessible from the button icons located next to the AWS Lambda function in your project folder or by right-clicking the AWS Lambda function:
Local Invoke and Debug Configuration: Opens the Local Invoke and Debug Configuration form in your VS Code editor. With this form you can create, edit, and run launch-configs of type:
aws-sam. For additional information about SAM Debug configurations, see the Configuration options for debugging serverless applications topic in this User Guide.Note
At present, debugging a .NET Core application on an ARM64 architecture is not supported by VS Code. If you attempt to debug a .NET Core application the following error is displayed:
The vsdbg debugger does not currently support the arm64 architecture. Function will run locally without debug.For additional details about this issue, see this VSCode-csharp
issue in the DotNet GitHub repository. Open Function Handler: Opens your project file that contains the function handler.
There are 2 additional actions available for deployed AWS Lambda functions.
Remote invoke: opens the Remote invoke configuration menu in the VS Code editor.
Search logs: Opens the Search logs dialog in VS Code.
Walkthrough of Application Builder
The Walkthrough of Application Builder is a step-by-step interactive guide that takes you through the process of building a new application with AWS Application Builder. You can access the Walkthrough of Application Builder from two places: the Application Builder explorer in the AWS Toolkit for Visual Studio Code and the VS Code Welcome tab. When you select Walkthrough of Application Builder from the Application Builder explorer in the AWS Toolkit, it opens the Walkthrough of Application Builder in the VS Code Welcome tab in the VS Code Editor window.
The Walkthrough of Application Builder is comprised of 5 main sections:
1. Installation
The Installation section checks to see if you have installed the AWS CLI tools required by Application Builder and other optional tools. If you don't have the required tools or your tools are out of date, you're guided through the process of installing the correct versions.
To see if you have the correct AWS CLI and optional tools installed, select the button for the AWS CLI or another tool that you want to test. After selecting a button, your AWS Toolkit Logs update and VS Code displays an alert message with the status of your tools. If you need to install or update your tools, the Walkthrough of Application Builder updates with the instructions and resources your need to proceed.
For detailed information on installing the AWS CLI, see the Install or update to the latest version of the AWS CLI topic in the AWS CLI Developer Guide. For detailed information on installing the AWS SAM CLI, see the Install AWS SAM CLI topic in the AWS SAM CLI Developer Guide.
2. Choose your application template
The Choose your application template section guides you through the process of building a new application from a template.
To choose a template and initialize your application, complete the following steps.
From the Walkthrough of Application Builder, select the Choose your application template section to display a list of template options on your screen.
Choose a template from the list, then choose the Initialize your project button to open a VS Code dialog.
Complete the steps in the VS Code dialog to initialize your new application.
The AWS Toolkit logs update with the status of your application during the initialization process.
To view your application in the Application Builder explorer, choose the Refresh Application Builder Explorer icon to update the explorer with your changes.
3. Iterate locally
The Iterate locally section contains example images that demonstrate how you can iterate with the Application Builder features available in the VS Code and AWS Toolkit explorers.
For additional information about all of the Application Builder features available in the VS Code and AWS Toolkit explorers, see the Working with the Application Builder explorer section, located in this User Guide topic.
4. Deploy to AWS
The Deploy to AWS section contains information on how to configure your credentials to connect with AWS for the purposes of deploying your application and examples of how to deploy your application with Application Builder.
To connect to AWS with your existing credentials from the Walkthrough of Application Builder, complete one of the following procedures.
Workforce: Sign in to AWS with single sign-on.
From the Deploy to AWS section in the Walkthrough of Application Builder, choose the Configure credentials button to open the AWS: LOGIN menu in the AWS Toolkit explorer.
From the AWS: LOGIN menu, choose Workforce, then choose the Continue button to proceed.
Enter your Start URL into the provided field, choose your AWS Region from the drop-down menu, then choose the Continue button to proceed.
From the VS Code pop-up window, confirm that you want to open the AWS Authentication site in your default browser.
From your default browser, complete the authentication steps, you're notified when authentication is complete and it's safe to close your browser window.
IAM Credentials: Store keys for use with AWS CLI tools.
From the Deploy to AWS section in the Walkthrough of Application Builder, choose the Configure credentials button to open the AWS: LOGIN menu in the AWS Toolkit explorer.
From the AWS: LOGIN menu, choose IAM Credentials, then choose the Continue button to proceed.
Enter a Profile Name into the provided field, then input your
Access KeyandSecret Key, then choose the Continue button to proceed.VS Code displays the status of your authentication, notifying you if authentication is complete or your credentials are invalid.
For detailed information on configuring your credentials for deployment with the AWS CLI, see the Configure the AWS CLI topic in the AWS CLI Developer Guide. For additional information about connecting to AWS from the AWS Toolkit using your existing credentials, see the Connecting to AWS topic in this User Guide.
