Skip to content

Latest commit

 

History

History
114 lines (75 loc) · 10 KB

README.quickstart.cloud9.md

File metadata and controls

114 lines (75 loc) · 10 KB

AWS Toolkit

AWS Toolkit is an extension for AWS Cloud9 that enables you to interact with Amazon Web Services (AWS). See the AWS Toolkit user guide for complete documentation.

See Get help for support.

Features


AWS Explorer

The AWS Explorer provides access to the AWS services that you can work with when using the Toolkit. To see the AWS Explorer, choose the AWS icon in the Activity bar.

Overview, AWS Explorer

AWS Serverless Applications

The AWS Toolkit enables you to develop AWS serverless applications locally. It also provides Inline Actions in Cloud9 to do the following:

  • Use SAM (serverless application model) templates to build and debug your locally developed AWS serverless applications.
  • Run selected AWS Lambda functions.

To start debugging with a SAM template, click the Add Debug Configuration Inline Action in the template file.

Add Debug Configuration Template

The Inline Action indicator in the SAM template allows you to add a debug configuration for the serverless application.

Alternatively, you can run and debug just the AWS Lambda function and exclude other resources defined by the SAM template. Again, use an Inline Action indicator for an AWS Lambda-function handler. (A handler is a function that Lambda calls to start execution of a Lambda function.)

Add Debug Configuration Direct

The Inline Action indicator in the application file lets you add a debug configuration for a selected AWS Lambda function.

When you run a debug session, the status and results are shown in the AWS Toolkit output channel. If the toolkit does not have an open AWS Toolkit output channel, one can be created with the New Tab button.

Configure and Run

After a local run is complete, the output appears in the OUTPUT tab.

When you're satisfied with performance, you can deploy your serverless application. The SAM template is converted to a CloudFormation template, which is then used to deploy all the application's assets to the AWS Cloud.

Supported runtimes

The Toolkit local SAM debugging feature supports these runtimes:

  • JavaScript (Node.js 12.x, 14.x)
  • Python (3.7, 3.8, 3.9)

For more information see Working with AWS Serverless Applications in the user guide.

{ Return to Top }


AWS: Commands

The Toolkit provides commands (prefixed with AWS:) to the AWS Cloud9 Go to Anything panel, available by clicking the search bar and typing "." or via hotkey.

OS Hotkey
Windows CTRL-.
macOS CMD-.

Go to Anything panel

AWS Command Description
AWS: About Toolkit Displays information about the AWS Toolkit.
AWS: Add SAM Debug Configuration Creates an aws-sam Debug Configuration from a function in the given source file
AWS: Connect to AWS Connects the Toolkit to an AWS account.
AWS: Create a new Issue on Github Opens the AWS Toolkit's New Issue page on Github.
AWS: Create Credentials Profile Creates an AWS credentials profile.
AWS: Create Lambda SAM Application Generates code files for a new AWS serverless Lambda application. For more information, see Creating a Serverless Application in the user guide.
AWS: Create new CloudFormation Template Creates a new starter Cloudformation Template
AWS: Create new SAM Template Creates a new starter SAM Template
AWS: Deploy SAM Application Deploys a local serverless application to an AWS account. For more information, see Deploying a Serverless Application in the user guide.
AWS: Detect SAM CLI Checks whether the Toolkit can communicate correctly with the AWS SAM CLI that is installed.
AWS: Hide region from the Explorer Hides an AWS Region from the AWS Explorer.
AWS: Show region in the Explorer Displays an AWS Region in the AWS Explorer.
AWS: Sign out Disconnects the Toolkit from the currently-connected AWS account.
AWS: Submit Quick Feedback... Submit a private, one-way message and sentiment to the AWS Toolkit dev team. For larger issues that warrant conversations or bugfixes, please submit an issue in Github with the AWS: Create a New Issue on Github command.
AWS: Toggle SAM hints in source files Toggles AWS SAM-related Inline Actions in source files
AWS: View Toolkit Logs Displays log files that contain general Toolkit diagnostic information.
AWS: View Quick Start Open this quick-start guide.
AWS: View Toolkit Documentation Opens the user guide for the Toolkit.
AWS: View Source on GitHub Opens the GitHub repository for the Toolkit.

{ Return to Top }


Get help

For additional details on how to use the AWS Toolkit, see the user guide.

To report issues with the Toolkit or to propose Toolkit code changes, see the aws/aws-toolkit-vscode repository on GitHub.

You can also contact AWS directly.

{ Return to Top }